MappingJackson2HttpMessageConverter
for Jackson 2.x.@Deprecated public class MappingJacksonHttpMessageConverter extends AbstractHttpMessageConverter<java.lang.Object> implements GenericHttpMessageConverter<java.lang.Object>
HttpMessageConverter
that
can read and write JSON using Jackson 1.x's ObjectMapper
.
This converter can be used to bind to typed beans, or untyped HashMap
instances.
By default, this converter supports application/json
. This can be overridden by setting the
supportedMediaTypes
property.
NOTE: Requires Jackson 1.8 or higher, as of Spring 4.0. At the same time, we strongly recommend a migration to Jackson 2.x!
Modifier and Type | Field and Description |
---|---|
static java.nio.charset.Charset |
DEFAULT_CHARSET
Deprecated.
|
private java.lang.String |
jsonPrefix
Deprecated.
|
private ObjectMapper |
objectMapper
Deprecated.
|
private java.lang.Boolean |
prettyPrint
Deprecated.
|
logger
Constructor and Description |
---|
MappingJacksonHttpMessageConverter()
Deprecated.
Construct a new
MappingJacksonHttpMessageConverter . |
Modifier and Type | Method and Description |
---|---|
boolean |
canRead(java.lang.Class<?> clazz,
MediaType mediaType)
Deprecated.
This implementation checks if the given class is supported,
and if the supported media types
include the given media type.
|
boolean |
canRead(java.lang.reflect.Type type,
java.lang.Class<?> contextClass,
MediaType mediaType)
Deprecated.
Indicates whether the given type can be read by this converter.
|
boolean |
canWrite(java.lang.Class<?> clazz,
MediaType mediaType)
Deprecated.
This implementation checks if the given class is supported,
and if the supported media types
include the given media type.
|
private void |
configurePrettyPrint()
Deprecated.
|
protected JavaType |
getJavaType(java.lang.reflect.Type type,
java.lang.Class<?> contextClass)
Deprecated.
Return the Jackson
JavaType for the specified type and context class. |
protected JsonEncoding |
getJsonEncoding(MediaType contentType)
Deprecated.
Determine the JSON encoding to use for the given content type.
|
ObjectMapper |
getObjectMapper()
Deprecated.
Return the underlying
ObjectMapper for this view. |
java.lang.Object |
read(java.lang.reflect.Type type,
java.lang.Class<?> contextClass,
HttpInputMessage inputMessage)
Deprecated.
Read an object of the given type form the given input message, and returns it.
|
protected java.lang.Object |
readInternal(java.lang.Class<?> clazz,
HttpInputMessage inputMessage)
Deprecated.
Abstract template method that reads the actual object.
|
private java.lang.Object |
readJavaType(JavaType javaType,
HttpInputMessage inputMessage)
Deprecated.
|
void |
setJsonPrefix(java.lang.String jsonPrefix)
Deprecated.
Specify a custom prefix to use for this view's JSON output.
|
void |
setObjectMapper(ObjectMapper objectMapper)
Deprecated.
Set the
ObjectMapper for this view. |
void |
setPrefixJson(boolean prefixJson)
Deprecated.
Indicate whether the JSON output by this view should be prefixed with "{} &&".
|
void |
setPrettyPrint(boolean prettyPrint)
Deprecated.
Whether to use the
org.codehaus.jackson.util.DefaultPrettyPrinter when writing JSON. |
protected boolean |
supports(java.lang.Class<?> clazz)
Deprecated.
Indicates whether the given class is supported by this converter.
|
protected void |
writeInternal(java.lang.Object object,
HttpOutputMessage outputMessage)
Deprecated.
Abstract template method that writes the actual body.
|
canRead, canWrite, getContentLength, getDefaultContentType, getSupportedMediaTypes, read, setSupportedMediaTypes, write
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSupportedMediaTypes, read, write
public static final java.nio.charset.Charset DEFAULT_CHARSET
private ObjectMapper objectMapper
private java.lang.String jsonPrefix
private java.lang.Boolean prettyPrint
public MappingJacksonHttpMessageConverter()
MappingJacksonHttpMessageConverter
.public void setObjectMapper(ObjectMapper objectMapper)
ObjectMapper
for this view.
If not set, a default ObjectMapper
is used.
Setting a custom-configured ObjectMapper
is one way to take further control of the JSON
serialization process. For example, an extended org.codehaus.jackson.map.SerializerFactory
can be configured that provides custom serializers for specific types. The other option for refining
the serialization process is to use Jackson's provided annotations on the types to be serialized,
in which case a custom-configured ObjectMapper is unnecessary.
public ObjectMapper getObjectMapper()
ObjectMapper
for this view.public void setJsonPrefix(java.lang.String jsonPrefix)
setPrefixJson(boolean)
public void setPrefixJson(boolean prefixJson)
Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix does not affect the evaluation of JSON, but if JSON validation is performed on the string, the prefix would need to be ignored.
setJsonPrefix(java.lang.String)
public void setPrettyPrint(boolean prettyPrint)
org.codehaus.jackson.util.DefaultPrettyPrinter
when writing JSON.
This is a shortcut for setting up an ObjectMapper
as follows:
ObjectMapper mapper = new ObjectMapper(); mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); converter.setObjectMapper(mapper);
The default value is false
.
private void configurePrettyPrint()
public boolean canRead(java.lang.Class<?> clazz, MediaType mediaType)
AbstractHttpMessageConverter
canRead
in interface HttpMessageConverter<java.lang.Object>
canRead
in class AbstractHttpMessageConverter<java.lang.Object>
clazz
- the class to test for readabilitymediaType
- the media type to read, can be null
if not specified.
Typically the value of a Content-Type
header.true
if readable; false
otherwisepublic boolean canRead(java.lang.reflect.Type type, java.lang.Class<?> contextClass, MediaType mediaType)
GenericHttpMessageConverter
canRead
in interface GenericHttpMessageConverter<java.lang.Object>
type
- the type to test for readabilitycontextClass
- a context class for the target type, for example a class
in which the target type appears in a method signature, can be null
mediaType
- the media type to read, can be null
if not specified.
Typically the value of a Content-Type
header.true
if readable; false
otherwisepublic boolean canWrite(java.lang.Class<?> clazz, MediaType mediaType)
AbstractHttpMessageConverter
canWrite
in interface HttpMessageConverter<java.lang.Object>
canWrite
in class AbstractHttpMessageConverter<java.lang.Object>
clazz
- the class to test for writabilitymediaType
- the media type to write, can be null
if not specified.
Typically the value of an Accept
header.true
if writable; false
otherwiseprotected boolean supports(java.lang.Class<?> clazz)
AbstractHttpMessageConverter
supports
in class AbstractHttpMessageConverter<java.lang.Object>
clazz
- the class to test for supporttrue
if supported; false
otherwiseprotected java.lang.Object readInternal(java.lang.Class<?> clazz, HttpInputMessage inputMessage) throws java.io.IOException, HttpMessageNotReadableException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
.readInternal
in class AbstractHttpMessageConverter<java.lang.Object>
clazz
- the type of object to returninputMessage
- the HTTP input message to read fromjava.io.IOException
- in case of I/O errorsHttpMessageNotReadableException
- in case of conversion errorspublic java.lang.Object read(java.lang.reflect.Type type, java.lang.Class<?> contextClass, HttpInputMessage inputMessage) throws java.io.IOException, HttpMessageNotReadableException
GenericHttpMessageConverter
read
in interface GenericHttpMessageConverter<java.lang.Object>
type
- the type of object to return. This type must have previously
been passed to the canRead
method of this interface,
which must have returned true
.contextClass
- a context class for the target type, for example a class
in which the target type appears in a method signature, can be null
inputMessage
- the HTTP input message to read fromjava.io.IOException
- in case of I/O errorsHttpMessageNotReadableException
- in case of conversion errorsprivate java.lang.Object readJavaType(JavaType javaType, HttpInputMessage inputMessage)
protected void writeInternal(java.lang.Object object, HttpOutputMessage outputMessage) throws java.io.IOException, HttpMessageNotWritableException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
.writeInternal
in class AbstractHttpMessageConverter<java.lang.Object>
object
- the object to write to the output messageoutputMessage
- the HTTP output message to write tojava.io.IOException
- in case of I/O errorsHttpMessageNotWritableException
- in case of conversion errorsprotected JavaType getJavaType(java.lang.reflect.Type type, java.lang.Class<?> contextClass)
JavaType
for the specified type and context class.
The default implementation returns typeFactory.constructType(type, contextClass)
,
but this can be overridden in subclasses, to allow for custom generic collection handling.
For instance:
protected JavaType getJavaType(Type type) { if (type instanceof Class && List.class.isAssignableFrom((Class)type)) { return TypeFactory.collectionType(ArrayList.class, MyBean.class); } else { return super.getJavaType(type); } }
type
- the type to return the java type forcontextClass
- a context class for the target type, for example a class
in which the target type appears in a method signature, can be null
protected JsonEncoding getJsonEncoding(MediaType contentType)
contentType
- the media type as requested by the callernull
)