Class JacksonSupport
java.lang.Object
io.helidon.http.media.MediaSupportBase<JacksonSupportConfig>
io.helidon.http.media.jackson.JacksonSupport
- All Implemented Interfaces:
RuntimeType.Api<JacksonSupportConfig>, NamedService, MediaSupport
public class JacksonSupport
extends MediaSupportBase<JacksonSupportConfig>
implements RuntimeType.Api<JacksonSupportConfig>
ServiceLoader provider implementation for Jackson media support.-
Nested Class Summary
Nested classes/interfaces inherited from interface MediaSupport
MediaSupport.ReaderResponse<T>, MediaSupport.SupportLevel, MediaSupport.WriterResponse<T>Modifier and TypeInterfaceDescriptionstatic final recordReader response.static enumHow does this provider support the entity type.static final recordWriter response. -
Method Summary
Modifier and TypeMethodDescriptionstatic JacksonSupportConfig.Builderbuilder()Creates a new builder.protected booleancanDeserialize(GenericType<?> type) Check whether the type is supported by this media support for deserialization.protected booleancanSerialize(GenericType<?> type) Check whether the type is supported by this media support for serialization.static MediaSupportcreate()Creates a newJacksonSupport.static MediaSupportcreate(ObjectMapper objectMapper) Creates a newJacksonSupport.static MediaSupportcreate(ObjectMapper objectMapper, String name) Creates a newJacksonSupport.static MediaSupportCreates a newJacksonSupport.static MediaSupportCreates a newJacksonSupport.static JacksonSupportcreate(JacksonSupportConfig jsonbSupportConfig) Creates a newJacksonSupportbased on theJacksonSupportConfig.static JacksonSupportcreate(Consumer<JacksonSupportConfig.Builder> consumer) Creates a new customizedJacksonSupport.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.type()Type of this implementation, to distinguish instances of same type, with differentNamedService.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 MediaSupportBase
config, isMediaTypeSupported, matchesClientRequest, matchesClientResponse, matchesServerRequest, matchesServerResponse, nameModifier and TypeMethodDescriptionprotected JacksonSupportConfigconfig()The configuration object used to create this instance.protected booleanisMediaTypeSupported(HttpMediaType mediaType) Check whether the provided media type is one of the supported media types.protected booleanmatchesClientRequest(GenericType<?> type, Headers requestHeaders) Client request writer check.protected booleanmatchesClientResponse(GenericType<?> type, Headers responseHeaders) Client response reader check.protected booleanmatchesServerRequest(GenericType<?> type, Headers requestHeaders) Server request reader check.protected booleanmatchesServerResponse(GenericType<?> type, Headers requestHeaders, Headers responseHeaders) Server response writer check.name()Name of this implementation, as provided inConfiguredProvider.create(Config, String).Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface MediaSupport
initModifier and TypeMethodDescriptiondefault voidinit(MediaContext context) Once all providers are discovered/configured and context is established, theMediaContextcalls this method on all providers to allow sub-resolution of readers and writers.
-
Method Details
-
create
-
create
Creates a newJacksonSupport.- Parameters:
config- must not benull- Returns:
- a new
JacksonSupport
-
create
Creates a newJacksonSupport.- Parameters:
config- must not benullname- of the Jackson support- Returns:
- a new
JacksonSupport
-
create
Creates a newJacksonSupport.- Parameters:
objectMapper- must not benull- Returns:
- a new
JacksonSupport
-
create
Creates a newJacksonSupport.- Parameters:
objectMapper- must not benullname- name of the jackson support to create- Returns:
- a new
JacksonSupport
-
create
Creates a newJacksonSupportbased on theJacksonSupportConfig.- Parameters:
jsonbSupportConfig- must not benull- Returns:
- a new
JacksonSupport
-
create
Creates a new customizedJacksonSupport.- Parameters:
consumer- config builder consumer- Returns:
- a new
JacksonSupport
-
builder
Creates a new builder.- Returns:
- a new builder instance
-
type
Description copied from interface:NamedServiceType of this implementation, to distinguish instances of same type, with differentNamedService.name(). Use for exampleConfiguredProvider.configKey()to define the type.- Specified by:
typein interfaceNamedService- Overrides:
typein classMediaSupportBase<JacksonSupportConfig>- Returns:
- type of this service
-
reader
Description copied from interface:MediaSupportReader for an entity.- Specified by:
readerin interfaceMediaSupport- Type Parameters:
T- type- Parameters:
type- type of entityrequestHeaders- 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:MediaSupportServer response writer.- Specified by:
writerin interfaceMediaSupport- Type Parameters:
T- type- Parameters:
type- type of entityrequestHeaders- request headersresponseHeaders- 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:MediaSupportClient response reader.- Specified by:
readerin interfaceMediaSupport- Type Parameters:
T- type- Parameters:
type- type of entityrequestHeaders- request headersresponseHeaders- 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:MediaSupportClient request writer.- Specified by:
writerin interfaceMediaSupport- Type Parameters:
T- type- Parameters:
type- type of entityrequestHeaders- request headers- Returns:
- writer response, whether this type is supported or not
-
prototype
Description copied from interface:RuntimeType.ApiThe prototype as it was received when creating this runtime object instance.- Specified by:
prototypein interfaceRuntimeType.Api<JacksonSupportConfig>- Returns:
- prototype object used to create this instance
-
canSerialize
Description copied from class:MediaSupportBaseCheck whether the type is supported by this media support for serialization.- Specified by:
canSerializein classMediaSupportBase<JacksonSupportConfig>- Parameters:
type- type to check- Returns:
- whether this media support can handle this type
-
canDeserialize
Description copied from class:MediaSupportBaseCheck whether the type is supported by this media support for deserialization.- Specified by:
canDeserializein classMediaSupportBase<JacksonSupportConfig>- Parameters:
type- type to check- Returns:
- whether this media support can handle this type
-