Module io.helidon.http.media.json.smile

Package io.helidon.http.media.json.smile

Class SmileSupport

java.lang.Object

io.helidon.http.media.MediaSupportBase<SmileSupportConfig>

io.helidon.http.media.json.smile.SmileSupport

All Implemented Interfaces:

RuntimeType.Api<SmileSupportConfig>, NamedService, NamedService, MediaSupport

public class SmileSupport
extends MediaSupportBase<SmileSupportConfig>
implements RuntimeType.Api<SmileSupportConfig>

Smile media support implementation.

This class provides Smile binary media support for Helidon HTTP.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.http.media.MediaSupport

MediaSupport.ReaderResponse<T>, MediaSupport.SupportLevel, MediaSupport.WriterResponse<T>

Method Summary

Modifier and Type	Method	Description
static SmileSupportConfig.Builder	builder()	Create a new builder for SmileSupport.
protected boolean	canDeserialize(GenericType<?> type)	Check whether the type is supported by this media support for deserialization.
protected boolean	canSerialize(GenericType<?> type)	Check whether the type is supported by this media support for serialization.
static SmileSupport	create()	Create a new Smile media support with default configuration.
static SmileSupport	create(Config config)	Create a new Smile media support from configuration.
static SmileSupport	create(Config config, String name)	Create a new Smile media support from configuration with a custom name.
static SmileSupport	create(SmileSupportConfig config)	Create a new Smile support from a configuration object.
static SmileSupport	create(Consumer<SmileSupportConfig.Builder> consumer)	Create a new Smile support using a configuration consumer.
SmileSupportConfig	prototype()	The prototype as it was received when creating this runtime object instance.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders)	Reader for an entity.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Client response reader.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response writer.
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, WritableHeaders<?> requestHeaders)	Client request writer.

Methods inherited from class io.helidon.http.media.MediaSupportBase

config, isMediaTypeSupported, matchesClientRequest, matchesClientResponse, matchesServerRequest, matchesServerResponse, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.http.media.MediaSupport

init

Method Details

create

public static SmileSupport create(Config config)

Create a new Smile media support from configuration.

Parameters:

config - the configuration to use

Returns:

a new SmileSupport instance

create

public static SmileSupport create()

Create a new Smile media support with default configuration.

Returns:

a new SmileSupport instance

create

public static SmileSupport create(Config config,
 String name)

Create a new Smile media support from configuration with a custom name.

Parameters:

config - the configuration to use

name - the name for this media support instance

Returns:

a new MediaSupport instance

create

public static SmileSupport create(SmileSupportConfig config)

Create a new Smile support from a configuration object.

Parameters:

config - the configuration object

Returns:

a new SmileSupport instance

create

public static SmileSupport create(Consumer<SmileSupportConfig.Builder> consumer)

Create a new Smile support using a configuration consumer.

Parameters:

consumer - the consumer to configure the builder

Returns:

a new SmileSupport instance

builder

public static SmileSupportConfig.Builder builder()

Create a new builder for SmileSupport.

Returns:

a new builder instance

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Specified by:

type in interface NamedService

Overrides:

type in class MediaSupportBase<SmileSupportConfig>

Returns:

type of this service

prototype

public SmileSupportConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<SmileSupportConfig>

Returns:

prototype object used to create this instance

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders)

Description copied from interface: MediaSupport

Reader for an entity.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - headers belonging to this entity (such as server request headers), expected to have content type

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 Headers requestHeaders,
 WritableHeaders<?> responseHeaders)

Description copied from interface: MediaSupport

Server response writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

writer response, whether this type is supported or not

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders,
 Headers responseHeaders)

Description copied from interface: MediaSupport

Client response reader.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 WritableHeaders<?> requestHeaders)

Description copied from interface: MediaSupport

Client request writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

Returns:

writer response, whether this type is supported or not

canSerialize

protected boolean canSerialize(GenericType<?> type)

Description copied from class: MediaSupportBase

Check whether the type is supported by this media support for serialization.

Specified by:

canSerialize in class MediaSupportBase<SmileSupportConfig>

Parameters:

type - type to check

Returns:

whether this media support can handle this type

canDeserialize

protected boolean canDeserialize(GenericType<?> type)

Description copied from class: MediaSupportBase

Check whether the type is supported by this media support for deserialization.

Specified by:

canDeserialize in class MediaSupportBase<SmileSupportConfig>

Parameters:

type - type to check

Returns:

whether this media support can handle this type