org.tinygroup.springmvc.support

Class MappingJacksonHttpMessageConverter

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<Object>

org.tinygroup.springmvc.support.MappingJacksonHttpMessageConverter

All Implemented Interfaces:

org.springframework.http.converter.HttpMessageConverter<Object>

public class MappingJacksonHttpMessageConverter
extends org.springframework.http.converter.AbstractHttpMessageConverter<Object>

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor and Description
MappingJacksonHttpMessageConverter() Construct a new BindingJacksonHttpMessageConverter.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Class<?> clazz, org.springframework.http.MediaType mediaType)
boolean	canWrite(Class<?> clazz, org.springframework.http.MediaType mediaType)
protected org.codehaus.jackson.type.JavaType	getJavaType(Class<?> clazz) Returns the Jackson JavaType for the specific class.
protected Object	readInternal(Class<?> clazz, org.springframework.http.HttpInputMessage inputMessage)
void	setObjectMapper(org.codehaus.jackson.map.ObjectMapper objectMapper) Sets the ObjectMapper for this view.
void	setPrefixJson(boolean prefixJson) Indicates whether the JSON output by this view should be prefixed with "{} &&".
protected boolean	supports(Class<?> clazz)
protected void	writeInternal(Object o, org.springframework.http.HttpOutputMessage outputMessage)

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Constructor Detail

MappingJacksonHttpMessageConverter

public MappingJacksonHttpMessageConverter()

Construct a new BindingJacksonHttpMessageConverter.

Method Detail

setObjectMapper

public void setObjectMapper(org.codehaus.jackson.map.ObjectMapper objectMapper)

Sets the 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 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.

setPrefixJson

public void setPrefixJson(boolean prefixJson)

Indicates whether the JSON output by this view should be prefixed with "{} &&". Default is false.

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.

canRead

public boolean canRead(Class<?> clazz,
                       org.springframework.http.MediaType mediaType)

Specified by:

canRead in interface org.springframework.http.converter.HttpMessageConverter<Object>

Overrides:

canRead in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

getJavaType

protected org.codehaus.jackson.type.JavaType getJavaType(Class<?> clazz)

Returns the Jackson JavaType for the specific class.

Default implementation returns TypeFactory.type(java.lang.reflect.Type), but this can be overridden in subclasses, to allow for custom generic collection handling. For instance:

 protected JavaType getJavaType(Class<?> clazz) {
 if (List.class.isAssignableFrom(clazz)) {
 return TypeFactory.collectionType(ArrayList.class, MyBean.class);
 } else {
 return super.getJavaType(clazz);
 }
 }
 

Parameters:

clazz - the class to return the java type for

Returns:

the java type

canWrite

public boolean canWrite(Class<?> clazz,
                        org.springframework.http.MediaType mediaType)

Specified by:

canWrite in interface org.springframework.http.converter.HttpMessageConverter<Object>

Overrides:

canWrite in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

supports

protected boolean supports(Class<?> clazz)

Specified by:

supports in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

readInternal

protected Object readInternal(Class<?> clazz,
                              org.springframework.http.HttpInputMessage inputMessage)
                       throws IOException,
                              org.springframework.http.converter.HttpMessageNotReadableException

Specified by:

readInternal in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

Throws:

IOException

org.springframework.http.converter.HttpMessageNotReadableException

writeInternal

protected void writeInternal(Object o,
                             org.springframework.http.HttpOutputMessage outputMessage)
                      throws IOException,
                             org.springframework.http.converter.HttpMessageNotWritableException

Specified by:

writeInternal in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

Throws:

IOException

org.springframework.http.converter.HttpMessageNotWritableException