Jackson 2.18.2 · com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider

Basic implementation of JAX-RS abstractions (MessageBodyReader, MessageBodyWriter) needed for binding JSON ("application/json") content to and from Java Objects ("POJO"s).

Actual data binding functionality is implemented by ObjectMapper: mapper to use can be configured in multiple ways:

By explicitly passing mapper to use in constructor
By explictly setting mapper to use by setMapper
By defining JAX-RS Provider that returns XmlMappers.
By doing none of above, in which case a default mapper instance is constructed (and configured if configuration methods are called)

The last method ("do nothing specific") is often good enough; explicit passing of Mapper is simple and explicit; and Provider-based method may make sense with Depedency Injection frameworks, or if Mapper has to be configured differently for different media types.

Note that the default mapper instance will be automatically created if one of explicit configuration methods (like configure) is called: if so, Provider-based introspection is NOT used, but the resulting Mapper is used as configured.

Note that there is also a sub-class -- (JacksonJaxbXMLProvider) -- that is configured by default to use both Jackson and JAXB annotations for configuration (base class when used as-is defaults to using just Jackson annotations)

Field Summary

Modifier and Type	Field and Description
protected Providers	_providers Injectable context object used to locate configured instance of `XmlMapper` to use for actual serialization.
public static final Annotations[]	BASIC_ANNOTATIONS Default annotation sets to use, if not explicitly defined during construction: only Jackson annotations are used for the base class.

Inherited from com.fasterxml.jackson.jaxrs.base.ProviderBase:: _cfgCheckCanDeserialize _cfgCheckCanSerialize _cfgCustomUntouchables _defaultReadView _defaultWriteView _jaxRSFeatures _mapperConfig _readers _unreadableClasses _untouchables _unwritableClasses _writers CLASS_NAME_NO_CONTENT_EXCEPTION DEFAULT_UNREADABLES DEFAULT_UNTOUCHABLES DEFAULT_UNWRITABLES HEADER_CONTENT_TYPE_OPTIONS JAXRS_FEATURE_DEFAULTS

Constructor Summary

Access	Constructor and Description
public	JacksonXMLProvider() Default constructor, usually used when provider is automatically configured to be used with JAX-RS implementation.
public	JacksonXMLProvider(Annotations... Annotation set(s) to use for configuring data binding annotationsToUse)
public	JacksonXMLProvider(XmlMapper mapper)
public	JacksonXMLProvider(XmlMapper mapper, Annotations[] Sets of annotations (Jackson, JAXB) that provider should support annotationsToUse) Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.

Method Summary

Modifier and Type	Method and Description
protected XMLEndpointConfig	_configForReading(ObjectReader reader, Annotation[] annotations) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForReading.
protected XMLEndpointConfig	_configForWriting(ObjectWriter writer, Annotation[] annotations) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForWriting.
protected JsonParser	_createParser(ObjectReader reader, InputStream rawStream) Overrides com.fasterxml.jackson.jaxrs.base.ProviderBase._createParser. Overridable helper method called to create a `JsonParser` for reading contents of given raw `InputStream`.
public XmlMapper	_locateMapperViaProvider(Class<?> Class of object being serialized or deserialized; not checked at this point, since it is assumed that unprocessable classes have been already weeded out, but will be passed to `ContextResolver` as is. type, MediaType Declared media type for the instance to process: not used by this method, but will be passed to `ContextResolver` as is. mediaType) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._locateMapperViaProvider. Method called to locate `XmlMapper` to use for serialization and deserialization.
protected boolean	hasMatchingMediaType(MediaType mediaType) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase.hasMatchingMediaType. Helper method used to check whether given media type is XML type or sub type.
public Version	version() Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.

Field Detail

_providers	back to summary
protected Providers _providers Injectable context object used to locate configured instance of `XmlMapper` to use for actual serialization. Annotations @Context

BASIC_ANNOTATIONS	back to summary
public static final Annotations[] BASIC_ANNOTATIONS Default annotation sets to use, if not explicitly defined during construction: only Jackson annotations are used for the base class. Sub-classes can use other settings.

Constructor Detail

JacksonXMLProvider	back to summary
public JacksonXMLProvider() Default constructor, usually used when provider is automatically configured to be used with JAX-RS implementation.

JacksonXMLProvider	back to summary
public JacksonXMLProvider(Annotations... annotationsToUse) Parameters annotationsToUse:Annotations[] Annotation set(s) to use for configuring data binding

JacksonXMLProvider	back to summary
public JacksonXMLProvider(XmlMapper mapper)

JacksonXMLProvider	back to summary
public JacksonXMLProvider(XmlMapper mapper, Annotations[] annotationsToUse) Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used. Parameters annotationsToUse:Annotations[] Sets of annotations (Jackson, JAXB) that provider should support

JacksonXMLProvider

back to summary

public JacksonXMLProvider(XmlMapper mapper, Annotations[] annotationsToUse)

Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.

Parameters

annotationsToUse:Annotations[]: Sets of annotations (Jackson, JAXB) that provider should support

Method Detail

_configForReading	back to summary
protected XMLEndpointConfig _configForReading(ObjectReader reader, Annotation[] annotations) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForReading. Annotations @Override

_configForReading

back to summary

protected XMLEndpointConfig _configForReading(ObjectReader reader, Annotation[] annotations)

Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForReading.

Annotations

@Override

_configForWriting	back to summary
protected XMLEndpointConfig _configForWriting(ObjectWriter writer, Annotation[] annotations) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForWriting. Annotations @Override

_configForWriting

back to summary

protected XMLEndpointConfig _configForWriting(ObjectWriter writer, Annotation[] annotations)

Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._configForWriting.

Annotations

@Override

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(ObjectReader reader, InputStream rawStream) throws IOException Overrides com.fasterxml.jackson.jaxrs.base.ProviderBase._createParser. Doc from com.fasterxml.jackson.jaxrs.base.ProviderBase._createParser. Overridable helper method called to create a `JsonParser` for reading contents of given raw `InputStream`. May return null to indicate that Stream is empty; that is, contains no content. Annotations @Override

protected JsonParser _createParser(ObjectReader reader, InputStream rawStream) throws IOException

Overrides com.fasterxml.jackson.jaxrs.base.ProviderBase._createParser.

Doc from com.fasterxml.jackson.jaxrs.base.ProviderBase._createParser.

Overridable helper method called to create a JsonParser for reading contents of given raw InputStream. May return null to indicate that Stream is empty; that is, contains no content.

Annotations

@Override

_locateMapperViaProvider back to summary

_locateMapperViaProvider	back to summary
public XmlMapper _locateMapperViaProvider(Class<?> type, MediaType mediaType) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._locateMapperViaProvider. Method called to locate `XmlMapper` to use for serialization and deserialization. If an instance has been explicitly defined by `setMapper` (or non-null instance passed in constructor), that will be used. If not, will try to locate it using standard JAX-RS `ContextResolver` mechanism, if it has been properly configured to access it (by JAX-RS runtime). Finally, if no mapper is found, will return a default unconfigured `ObjectMapper` instance (one constructed with default constructor and not modified in any way) Parameters type:Class<?> Class of object being serialized or deserialized; not checked at this point, since it is assumed that unprocessable classes have been already weeded out, but will be passed to `ContextResolver` as is. mediaType:MediaType Declared media type for the instance to process: not used by this method, but will be passed to `ContextResolver` as is. Annotations @Override

public XmlMapper _locateMapperViaProvider(Class<?> type, MediaType mediaType)

Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase._locateMapperViaProvider.

Method called to locate XmlMapper to use for serialization and deserialization. If an instance has been explicitly defined by setMapper (or non-null instance passed in constructor), that will be used. If not, will try to locate it using standard JAX-RS ContextResolver mechanism, if it has been properly configured to access it (by JAX-RS runtime). Finally, if no mapper is found, will return a default unconfigured ObjectMapper instance (one constructed with default constructor and not modified in any way)

Parameters

type:Class<?>: Class of object being serialized or deserialized; not checked at this point, since it is assumed that unprocessable classes have been already weeded out, but will be passed to ContextResolver as is.
mediaType:MediaType: Declared media type for the instance to process: not used by this method, but will be passed to ContextResolver as is.

Annotations

@Override

hasMatchingMediaType back to summary

hasMatchingMediaType	back to summary
protected boolean hasMatchingMediaType(MediaType mediaType) Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase.hasMatchingMediaType. Helper method used to check whether given media type is XML type or sub type. Current implementation essentially checks to see whether `MediaType#getSubtype` returns "xml" or something ending with "+xml". Annotations @Override

protected boolean hasMatchingMediaType(MediaType mediaType)

Implements abstract com.fasterxml.jackson.jaxrs.base.ProviderBase.hasMatchingMediaType.

Helper method used to check whether given media type is XML type or sub type. Current implementation essentially checks to see whether MediaType#getSubtype returns "xml" or something ending with "+xml".

Annotations

@Override

version	back to summary
public Version version() Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class. Returns:Version Doc from com.fasterxml.jackson.core.Versioned.version. Version of the component Annotations @Override

version

back to summary

public Version version()

Implements com.fasterxml.jackson.core.Versioned.version.

Method that will return version information stored in and read from jar that contains this class.

Returns:Version

Doc from com.fasterxml.jackson.core.Versioned.version.

Version of the component

Annotations

@Override

public Class JacksonXMLProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail