org.springframework.messaging.converter

Class MappingJackson2MessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.messaging.converter.MappingJackson2MessageConverter

All Implemented Interfaces:

MessageConverter

public class MappingJackson2MessageConverter
extends AbstractMessageConverter

A Jackson 2 based MessageConverter implementation.

It customizes Jackson's default properties with the following ones:

• MapperFeature#DEFAULT_VIEW_INCLUSION is disabled
• DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES is disabled

Compatible with Jackson 2.1 and higher.

Since:

4.0

Author:

Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	jackson23Available
private ObjectMapper	objectMapper
private java.lang.Boolean	prettyPrint

Fields inherited from class org.springframework.messaging.converter.AbstractMessageConverter

logger, METHOD_PARAMETER_HINT_HEADER

Constructor Summary

Constructors

Constructor and Description
MappingJackson2MessageConverter() Construct a MappingJackson2MessageConverter supporting the application/json MIME type.
MappingJackson2MessageConverter(MimeType... supportedMimeTypes) Construct a MappingJackson2MessageConverter supporting one or more custom MIME types.

Method Summary

Modifier and Type	Method and Description
protected boolean	canConvertFrom(Message<?> message, java.lang.Class<?> targetClass)
protected boolean	canConvertTo(java.lang.Object payload, MessageHeaders headers)
private void	configurePrettyPrint()
java.lang.Object	convertFromInternal(Message<?> message, java.lang.Class<?> targetClass) Convert the message payload from serialized form to an Object.
java.lang.Object	convertToInternal(java.lang.Object payload, MessageHeaders headers) Convert the payload object to serialized form.
protected JsonEncoding	getJsonEncoding(MimeType contentType) Determine the JSON encoding to use for the given content type.
ObjectMapper	getObjectMapper() Return the underlying ObjectMapper for this converter.
private java.lang.Class<?>	getSerializationView(MessageHeaders headers)
private void	initObjectMapper()
void	setObjectMapper(ObjectMapper objectMapper) Set the ObjectMapper for this converter.
void	setPrettyPrint(boolean prettyPrint) Whether to use the DefaultPrettyPrinter when writing JSON.
protected boolean	supports(java.lang.Class<?> clazz) Whether the given class is supported by this converter.

Methods inherited from class org.springframework.messaging.converter.AbstractMessageConverter

fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage

Methods inherited from class java.lang.Object

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

Field Detail

jackson23Available

private static final boolean jackson23Available

objectMapper

private ObjectMapper objectMapper

prettyPrint

private java.lang.Boolean prettyPrint

Constructor Detail

MappingJackson2MessageConverter

public MappingJackson2MessageConverter()

Construct a MappingJackson2MessageConverter supporting the application/json MIME type.

MappingJackson2MessageConverter

public MappingJackson2MessageConverter(MimeType... supportedMimeTypes)

Construct a MappingJackson2MessageConverter supporting one or more custom MIME types.

Parameters:

supportedMimeTypes - the supported MIME types

Since:

4.1.5

Method Detail

initObjectMapper

private void initObjectMapper()

setObjectMapper

public void setObjectMapper(ObjectMapper objectMapper)

Set the ObjectMapper for this converter. 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 com.fasterxml.jackson.databind.ser.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.

getObjectMapper

public ObjectMapper getObjectMapper()

Return the underlying ObjectMapper for this converter.

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Whether to use the DefaultPrettyPrinter when writing JSON. This is a shortcut for setting up an ObjectMapper as follows:

 ObjectMapper mapper = new ObjectMapper();
 mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
 converter.setObjectMapper(mapper);
 

configurePrettyPrint

private void configurePrettyPrint()

canConvertFrom

protected boolean canConvertFrom(Message<?> message,
                                 java.lang.Class<?> targetClass)

Overrides:

canConvertFrom in class AbstractMessageConverter

canConvertTo

protected boolean canConvertTo(java.lang.Object payload,
                               MessageHeaders headers)

Overrides:

canConvertTo in class AbstractMessageConverter

supports

protected boolean supports(java.lang.Class<?> clazz)

Description copied from class: AbstractMessageConverter

Whether the given class is supported by this converter.

Specified by:

supports in class AbstractMessageConverter

Parameters:

clazz - the class to test for support

Returns:

true if supported; false otherwise

convertFromInternal

public java.lang.Object convertFromInternal(Message<?> message,
                                            java.lang.Class<?> targetClass)

Description copied from class: AbstractMessageConverter

Convert the message payload from serialized form to an Object.

Specified by:

convertFromInternal in class AbstractMessageConverter

convertToInternal

public java.lang.Object convertToInternal(java.lang.Object payload,
                                          MessageHeaders headers)

Description copied from class: AbstractMessageConverter

Convert the payload object to serialized form.

Specified by:

convertToInternal in class AbstractMessageConverter

getSerializationView

private java.lang.Class<?> getSerializationView(MessageHeaders headers)

getJsonEncoding

protected JsonEncoding getJsonEncoding(MimeType contentType)

Determine the JSON encoding to use for the given content type.

Parameters:

contentType - the MIME type from the MessageHeaders, if any

Returns:

the JSON encoding to use (never null)