org.springframework.amqp.support.converter

Class AbstractJackson2MessageConverter

java.lang.Object

org.springframework.amqp.support.converter.AbstractMessageConverter

org.springframework.amqp.support.converter.AbstractJackson2MessageConverter

All Implemented Interfaces:

MessageConverter, SmartMessageConverter, Aware, BeanClassLoaderAware

Direct Known Subclasses:

Jackson2JsonMessageConverter, Jackson2XmlMessageConverter

public abstract class AbstractJackson2MessageConverter
extends AbstractMessageConverter
implements BeanClassLoaderAware, SmartMessageConverter

Abstract Jackson2 message converter.

Since:

2.1

Author:

Mark Pollack, James Carr, Dave Syer, Sam Nelson, Andreas Asplund, Artem Bilan, Mohammad Hewedy, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET The charset used when converting String to/from byte[].
protected Log	log
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJackson2MessageConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper, MimeType contentType, String... trustedPackages) Construct with the provided ObjectMapper instance.

Method Summary

Modifier and Type	Method and Description
protected Message	createMessage(Object objectToConvert, MessageProperties messageProperties) Crate a message from the payload object and message properties provided.
protected Message	createMessage(Object objectToConvert, MessageProperties messageProperties, Type genericType) Crate a message from the payload object and message properties provided.
Object	fromMessage(Message message) Convert from a Message to a Java object.
Object	fromMessage(Message message, Object conversionHint) A variant of MessageConverter.fromMessage(Message) which takes an extra conversion context as an argument.
protected ClassLoader	getClassLoader()
ClassMapper	getClassMapper()
String	getDefaultCharset()
Jackson2JavaTypeMapper	getJavaTypeMapper()
Jackson2JavaTypeMapper.TypePrecedence	getTypePrecedence() Return the type precedence.
boolean	isTypeMapperSet() Whether or not an explicit java type mapper has been provided.
protected boolean	isUseProjectionForInterfaces()
void	setAlwaysConvertToInferredType(boolean alwaysAttemptConversion) When false (default), fall back to type id headers if the type (or contents of a container type) is abstract.
void	setAssumeSupportedContentType(boolean assumeSupportedContentType) By default the supported content type is assumed when there is no contentType property or it is set to the default ('application/octet-stream').
void	setBeanClassLoader(ClassLoader classLoader)
void	setClassMapper(ClassMapper classMapper)
void	setDefaultCharset(String defaultCharset) Specify the default charset to use when converting to or from text-based Message body content.
void	setJavaTypeMapper(Jackson2JavaTypeMapper javaTypeMapper)
void	setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence) Set the precedence for evaluating type information in message properties.
void	setUseProjectionForInterfaces(boolean useProjectionForInterfaces) Set to true to use Spring Data projection to create the object if the inferred parameter type is an interface.

Methods inherited from class org.springframework.amqp.support.converter.AbstractMessageConverter

isCreateMessageIds, setCreateMessageIds, toMessage, toMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.amqp.support.converter.MessageConverter

toMessage, toMessage

Field Detail

log

protected final Log log

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The charset used when converting String to/from byte[].

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Detail

AbstractJackson2MessageConverter

protected AbstractJackson2MessageConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                           MimeType contentType,
                                           String... trustedPackages)

Construct with the provided ObjectMapper instance.

Parameters:

objectMapper - the ObjectMapper to use.

contentType - supported content type when decoding messages, only the subtype is checked, e.g. */json, */xml.

trustedPackages - the trusted Java packages for deserialization

See Also:

DefaultJackson2JavaTypeMapper.setTrustedPackages(String...)

Method Detail

getClassMapper

@Nullable
public ClassMapper getClassMapper()

setClassMapper

public void setClassMapper(ClassMapper classMapper)

setDefaultCharset

public void setDefaultCharset(@Nullable
                              String defaultCharset)

Specify the default charset to use when converting to or from text-based Message body content. If not specified, the charset will be "UTF-8".

Parameters:

defaultCharset - The default charset.

getDefaultCharset

public String getDefaultCharset()

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getClassLoader

protected ClassLoader getClassLoader()

getJavaTypeMapper

public Jackson2JavaTypeMapper getJavaTypeMapper()

isTypeMapperSet

public boolean isTypeMapperSet()

Whether or not an explicit java type mapper has been provided.

Returns:

false if the default type mapper is being used.

Since:

2.2

See Also:

setJavaTypeMapper(Jackson2JavaTypeMapper)

setJavaTypeMapper

public void setJavaTypeMapper(Jackson2JavaTypeMapper javaTypeMapper)

getTypePrecedence

public Jackson2JavaTypeMapper.TypePrecedence getTypePrecedence()

Return the type precedence.

Returns:

the precedence.

See Also:

setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence)

setTypePrecedence

public void setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence)

Set the precedence for evaluating type information in message properties. When using @RabbitListener at the method level, the framework attempts to determine the target type for payload conversion from the method signature. If so, this type is provided in the inferredArgumentType message property.

By default, if the type is concrete (not abstract, not an interface), this will be used ahead of type information provided in the __TypeId__ and associated headers provided by the sender.

If you wish to force the use of the __TypeId__ and associated headers (such as when the actual type is a subclass of the method argument type), set the precedence to Jackson2JavaTypeMapper.TypePrecedence.TYPE_ID.

Parameters:

typePrecedence - the precedence.

See Also:

DefaultJackson2JavaTypeMapper.setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence)

setAlwaysConvertToInferredType

public void setAlwaysConvertToInferredType(boolean alwaysAttemptConversion)

When false (default), fall back to type id headers if the type (or contents of a container type) is abstract. Set to true if conversion should always be attempted - perhaps because a custom deserializer has been configured on the ObjectMapper. If the attempt fails, fall back to headers.

Parameters:

alwaysAttemptConversion - true to attempt.

Since:

2.2.8

isUseProjectionForInterfaces

protected boolean isUseProjectionForInterfaces()

setUseProjectionForInterfaces

public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces)

Set to true to use Spring Data projection to create the object if the inferred parameter type is an interface.

Parameters:

useProjectionForInterfaces - true to use projection.

Since:

2.2

setAssumeSupportedContentType

public void setAssumeSupportedContentType(boolean assumeSupportedContentType)

By default the supported content type is assumed when there is no contentType property or it is set to the default ('application/octet-stream'). Set to 'false' to revert to the previous behavior of returning an unconverted 'byte[]' when this condition exists.

Parameters:

assumeSupportedContentType - set false to not assume the content type is supported.

Since:

2.2

fromMessage

public Object fromMessage(Message message)
                   throws MessageConversionException

Description copied from interface: MessageConverter

Convert from a Message to a Java object.

Specified by:

fromMessage in interface MessageConverter

Parameters:

message - the message to convert

Returns:

the converted Java object

Throws:

MessageConversionException - in case of conversion failure

fromMessage

public Object fromMessage(Message message,
                          @Nullable
                          Object conversionHint)
                   throws MessageConversionException

A variant of MessageConverter.fromMessage(Message) which takes an extra conversion context as an argument.

Specified by:

fromMessage in interface SmartMessageConverter

Parameters:

conversionHint - The conversionHint must be a ParameterizedTypeReference.

message - the input message.

Returns:

the result of the conversion, or null if the converter cannot perform the conversion.

Throws:

MessageConversionException - if the conversion fails.

See Also:

MessageConverter.fromMessage(Message)

createMessage

protected Message createMessage(Object objectToConvert,
                                MessageProperties messageProperties)
                         throws MessageConversionException

Description copied from class: AbstractMessageConverter

Crate a message from the payload object and message properties provided. The message id will be added to the properties if necessary later.

Specified by:

createMessage in class AbstractMessageConverter

Parameters:

objectToConvert - the payload.

messageProperties - the message properties (headers).

Returns:

a message.

Throws:

MessageConversionException

createMessage

protected Message createMessage(Object objectToConvert,
                                MessageProperties messageProperties,
                                @Nullable
                                Type genericType)
                         throws MessageConversionException

Description copied from class: AbstractMessageConverter

Crate a message from the payload object and message properties provided. The message id will be added to the properties if necessary later.

Overrides:

createMessage in class AbstractMessageConverter

Parameters:

objectToConvert - the payload

messageProperties - the message properties (headers)

genericType - the type to convert from - used to populate type headers.

Returns:

a message

Throws:

MessageConversionException