Package org.codehaus.jackson.jaxrs
Class JacksonJsonProvider
java.lang.Object
org.codehaus.jackson.jaxrs.JacksonJsonProvider
- All Implemented Interfaces:
javax.ws.rs.ext.MessageBodyReader<Object>
,javax.ws.rs.ext.MessageBodyWriter<Object>
,Versioned
- Direct Known Subclasses:
JacksonJaxbJsonProvider
@Provider
@Consumes({"application/json","text/json"})
@Produces({"application/json","text/json"})
public class JacksonJsonProvider
extends Object
implements javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>, Versioned
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(org.codehaus.jackson.map.ObjectMapper)
- By defining JAX-RS
Provider
that returnsObjectMapper
s. - By doing none of above, in which case a default mapper instance is constructed (and configured if configuration methods are called)
Note that the default mapper instance will be automatically created if
one of explicit configuration methods (like configure(org.codehaus.jackson.map.DeserializationConfig.Feature, boolean)
)
is called: if so, Provider-based introspection is NOT used, but the
resulting Mapper is used as configured.
Note: version 1.3 added a sub-class (JacksonJaxbJsonProvider
) which
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)
- Author:
- Tatu Saloranta
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Whether we want to actually check that Jackson has a deserializer for given type.protected boolean
Whether we want to actually check that Jackson has a serializer for given type.Set of types (classes) that provider should ignore for data bindingprotected String
JSONP function name to use for automatic JSONP wrapping, if any; if null, no JSONP wrapping is done.protected final MapperConfigurator
Helper object used for encapsulating configuration aspects ofObjectMapper
protected javax.ws.rs.ext.Providers
Injectable context object used to locate configured instance ofObjectMapper
to use for actual serialization.static final Class<?>[]
These are classes that we never use for reading (never try to deserialize instances of these types).Looks like we need to worry about accidental data binding for types we shouldn't be handling.static final Class<?>[]
These are classes that we never use for writing (never try to serialize instances of these types).static final Annotations[]
Default annotation sets to use, if not explicitly defined during construction: only Jackson annotations are used for the base class. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor, usually used when provider is automatically configured to be used with JAX-RS implementation.JacksonJsonProvider
(Annotations... annotationsToUse) JacksonJsonProvider
(ObjectMapper mapper) JacksonJsonProvider
(ObjectMapper mapper, Annotations[] 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 TypeMethodDescriptionprotected static boolean
_containedIn
(Class<?> mainType, HashSet<ClassKey> set) protected Class
<?> _findView
(ObjectMapper mapper, Annotation[] annotations) void
addUntouchable
(Class<?> type) Method for marking specified type as "untouchable", meaning that provider will not try to read or write values of this type (or its subtypes).void
checkCanDeserialize
(boolean state) Method for defining whether actual detection for existence of a deserializer for type should be done whenisReadable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
is called.void
checkCanSerialize
(boolean state) Method for defining whether actual detection for existence of a serializer for type should be done whenisWriteable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
is called.configure
(JsonGenerator.Feature f, boolean state) configure
(JsonParser.Feature f, boolean state) configure
(DeserializationConfig.Feature f, boolean state) configure
(SerializationConfig.Feature f, boolean state) disable
(JsonGenerator.Feature f, boolean state) disable
(JsonParser.Feature f, boolean state) disable
(DeserializationConfig.Feature f, boolean state) disable
(SerializationConfig.Feature f, boolean state) enable
(JsonGenerator.Feature f, boolean state) enable
(JsonParser.Feature f, boolean state) enable
(DeserializationConfig.Feature f, boolean state) enable
(SerializationConfig.Feature f, boolean state) protected JsonEncoding
findEncoding
(javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, Object> httpHeaders) Helper method to use for determining desired output encoding.long
getSize
(Object value, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to figure out serialized length of given value.protected boolean
isJsonType
(javax.ws.rs.core.MediaType mediaType) Helper method used to check whether given media type is JSON type or sub type.boolean
isReadable
(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider.boolean
isWriteable
(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider.locateMapper
(Class<?> type, javax.ws.rs.core.MediaType mediaType) Method called to locateObjectMapper
to use for serialization and deserialization.readFrom
(Class<Object> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, String> httpHeaders, InputStream entityStream) Method that JAX-RS container calls to deserialize given value.void
setAnnotationsToUse
(Annotations[] annotationsToUse) Method for configuring which annotation sets to use (including none).void
setJSONPFunctionName
(String fname) void
Method that can be used to directly defineObjectMapper
to use for serialization and deserialization; if null, will use the standard provider discovery from context instead.version()
Method that will return version information stored in and read from jar that contains this class.void
writeTo
(Object value, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream) Method that JAX-RS container calls to serialize given value.
-
Field Details
-
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. -
_untouchables
Looks like we need to worry about accidental data binding for types we shouldn't be handling. This is probably not a very good way to do it, but let's start by blacklisting things we are not to handle.(why ClassKey? since plain old Class has no hashCode() defined, lookups are painfully slow)
-
_unreadableClasses
These are classes that we never use for reading (never try to deserialize instances of these types). -
_unwritableClasses
These are classes that we never use for writing (never try to serialize instances of these types). -
_mapperConfig
Helper object used for encapsulating configuration aspects ofObjectMapper
-
_cfgCustomUntouchables
Set of types (classes) that provider should ignore for data binding- Since:
- 1.5
-
_jsonpFunctionName
JSONP function name to use for automatic JSONP wrapping, if any; if null, no JSONP wrapping is done. -
_providers
@Context protected javax.ws.rs.ext.Providers _providersInjectable context object used to locate configured instance ofObjectMapper
to use for actual serialization. -
_cfgCheckCanSerialize
protected boolean _cfgCheckCanSerializeWhether we want to actually check that Jackson has a serializer for given type. Since this should generally be the case (due to auto-discovery) and since the call to check availability can be bit expensive, defaults to false. -
_cfgCheckCanDeserialize
protected boolean _cfgCheckCanDeserializeWhether we want to actually check that Jackson has a deserializer for given type. Since this should generally be the case (due to auto-discovery) and since the call to check availability can be bit expensive, defaults to false.
-
-
Constructor Details
-
JacksonJsonProvider
public JacksonJsonProvider()Default constructor, usually used when provider is automatically configured to be used with JAX-RS implementation. -
JacksonJsonProvider
- Parameters:
annotationsToUse
- Annotation set(s) to use for configuring data binding
-
JacksonJsonProvider
-
JacksonJsonProvider
Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.
-
-
Method Details
-
version
Method that will return version information stored in and read from jar that contains this class. -
checkCanDeserialize
public void checkCanDeserialize(boolean state) Method for defining whether actual detection for existence of a deserializer for type should be done whenisReadable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
is called. -
checkCanSerialize
public void checkCanSerialize(boolean state) Method for defining whether actual detection for existence of a serializer for type should be done whenisWriteable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
is called. -
setAnnotationsToUse
Method for configuring which annotation sets to use (including none). Annotation sets are defined in order decreasing precedence; that is, first one has the priority over following ones.- Parameters:
annotationsToUse
- Ordered list of annotation sets to use; if null, default
-
setMapper
Method that can be used to directly defineObjectMapper
to use for serialization and deserialization; if null, will use the standard provider discovery from context instead. Default setting is null. -
configure
-
configure
-
configure
-
configure
-
enable
-
enable
-
enable
-
enable
-
disable
-
disable
-
disable
-
disable
-
addUntouchable
Method for marking specified type as "untouchable", meaning that provider will not try to read or write values of this type (or its subtypes).- Parameters:
type
- Type to consider untouchable; can be any kind of class, including abstract class or interface. No instance of this type (including subtypes, i.e. types assignable to this type) will be read or written by provider- Since:
- 1.5
-
setJSONPFunctionName
-
isReadable
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider. Implementation will first check that expected media type is a JSON type (via call toisJsonType(javax.ws.rs.core.MediaType)
; then verify that type is not one of "untouchable" types (types we will never automatically handle), and finally that there is a deserializer for type (iffcheckCanDeserialize(boolean)
has been called with true argument -- otherwise assumption is there will be a handler)- Specified by:
isReadable
in interfacejavax.ws.rs.ext.MessageBodyReader<Object>
-
readFrom
public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOExceptionMethod that JAX-RS container calls to deserialize given value.- Specified by:
readFrom
in interfacejavax.ws.rs.ext.MessageBodyReader<Object>
- Throws:
IOException
-
getSize
public long getSize(Object value, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to figure out serialized length of given value. Since computation of this length is about as expensive as serialization itself, implementation will return -1 to denote "not known", so that container will determine length from actual serialized output (if needed).- Specified by:
getSize
in interfacejavax.ws.rs.ext.MessageBodyWriter<Object>
-
isWriteable
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider. Implementation will first check that expected media type is a JSON type (via call toisJsonType(javax.ws.rs.core.MediaType)
; then verify that type is not one of "untouchable" types (types we will never automatically handle), and finally that there is a serializer for type (iffcheckCanSerialize(boolean)
has been called with true argument -- otherwise assumption is there will be a handler)- Specified by:
isWriteable
in interfacejavax.ws.rs.ext.MessageBodyWriter<Object>
-
writeTo
public void writeTo(Object value, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream) throws IOExceptionMethod that JAX-RS container calls to serialize given value.- Specified by:
writeTo
in interfacejavax.ws.rs.ext.MessageBodyWriter<Object>
- Throws:
IOException
-
findEncoding
protected JsonEncoding findEncoding(javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String, Object> httpHeaders) Helper method to use for determining desired output encoding. For now, will always just use UTF-8...- Since:
- 1.7.0
-
isJsonType
protected boolean isJsonType(javax.ws.rs.core.MediaType mediaType) Helper method used to check whether given media type is JSON type or sub type. Current implementation essentially checks to see whetherMediaType.getSubtype()
returns "json" or something ending with "+json". -
locateMapper
Method called to locateObjectMapper
to use for serialization and deserialization. If an instance has been explicitly defined bysetMapper(org.codehaus.jackson.map.ObjectMapper)
(or non-null instance passed in constructor), that will be used. If not, will try to locate it using standard JAX-RSContextResolver
mechanism, if it has been properly configured to access it (by JAX-RS runtime). Finally, if no mapper is found, will return a default unconfiguredObjectMapper
instance (one constructed with default constructor and not modified in any way)- Parameters:
type
- 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 toContextResolver
as is.mediaType
- Declared media type for the instance to process: not used by this method, but will be passed toContextResolver
as is.
-
_containedIn
-
_findView
protected Class<?> _findView(ObjectMapper mapper, Annotation[] annotations) throws JsonMappingException - Throws:
JsonMappingException
-