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

@Deprecated(forRemoval=true,
            since="4.0")
public abstract class AbstractJackson2MessageConverter
extends AbstractMessageConverter
implements BeanClassLoaderAware, SmartMessageConverter

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0 in favor of AbstractJacksonMessageConverter for Jackson 3.

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	Description
static final Charset	DEFAULT_CHARSET	Deprecated, for removal: This API element is subject to removal in a future version. The charset used when converting String to/from byte[].
protected final Log	log	Deprecated, for removal: This API element is subject to removal in a future version.
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJackson2MessageConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper, MimeType contentType, String... trustedPackages)	Deprecated, for removal: This API element is subject to removal in a future version. Construct with the provided ObjectMapper instance.

Method Summary

Modifier and Type	Method	Description
protected Message	createMessage(Object objectToConvert, MessageProperties messageProperties)	Deprecated, for removal: This API element is subject to removal in a future version. Crate a message from the payload object and message properties provided.
protected Message	createMessage(Object objectToConvert, MessageProperties messageProperties, @Nullable Type genericType)	Deprecated, for removal: This API element is subject to removal in a future version. Crate a message from the payload object and message properties provided.
Object	fromMessage(Message message)	Deprecated, for removal: This API element is subject to removal in a future version. Convert from a Message to a Java object.
Object	fromMessage(Message message, @Nullable Object conversionHint)	Deprecated, for removal: This API element is subject to removal in a future version. A variant of MessageConverter.fromMessage(Message) which takes an extra conversion context as an argument.
protected @Nullable ClassLoader	getClassLoader()	Deprecated, for removal: This API element is subject to removal in a future version.
@Nullable ClassMapper	getClassMapper()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getDefaultCharset()	Deprecated, for removal: This API element is subject to removal in a future version.
Jackson2JavaTypeMapper	getJavaTypeMapper()	Deprecated, for removal: This API element is subject to removal in a future version.
protected MimeType	getSupportedContentType()	Deprecated, for removal: This API element is subject to removal in a future version. Get the supported content type; only the subtype is checked when decoding, e.g.
Jackson2JavaTypeMapper.TypePrecedence	getTypePrecedence()	Deprecated, for removal: This API element is subject to removal in a future version. Return the type precedence.
boolean	isTypeMapperSet()	Deprecated, for removal: This API element is subject to removal in a future version. Whether an explicit java type mapper has been provided.
protected boolean	isUseProjectionForInterfaces()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setAlwaysConvertToInferredType(boolean alwaysAttemptConversion)	Deprecated, for removal: This API element is subject to removal in a future version. When false (default), fall back to type id headers if the type (or contents of a container type) is abstract.
void	setAssumeSupportedContentType(boolean assumeSupportedContentType)	Deprecated, for removal: This API element is subject to removal in a future version. 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)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setClassMapper(ClassMapper classMapper)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setDefaultCharset(@Nullable String defaultCharset)	Deprecated, for removal: This API element is subject to removal in a future version. Specify the default charset to use when converting to or from text-based Message body content.
void	setJavaTypeMapper(Jackson2JavaTypeMapper javaTypeMapper)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setNullAsOptionalEmpty(boolean nullAsOptionalEmpty)	Deprecated, for removal: This API element is subject to removal in a future version. When true, if jackson decodes the body as null convert to Optional.empty() instead of returning the original body.
void	setSupportedContentType(MimeType supportedContentType)	Deprecated, for removal: This API element is subject to removal in a future version. Set the supported content type; only the subtype is checked when decoding, e.g.
void	setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence)	Deprecated, for removal: This API element is subject to removal in a future version. Set the precedence for evaluating type information in message properties.
void	setUseProjectionForInterfaces(boolean useProjectionForInterfaces)	Deprecated, for removal: This API element is subject to removal in a future version. 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 Details

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Deprecated, for removal: This API element is subject to removal in a future version.

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

log

protected final Log log

Deprecated, for removal: This API element is subject to removal in a future version.

objectMapper

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

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

AbstractJackson2MessageConverter

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

Deprecated, for removal: This API element is subject to removal in a future version.

Construct with the provided ObjectMapper instance.

Parameters:

objectMapper - the ObjectMapper to use.

contentType - the supported content type; only the subtype is checked when decoding, e.g. */json, */xml. If this contains a charset parameter, when encoding, the contentType header will not be set, when decoding, the raw bytes are passed to Jackson which can dynamically determine the encoding; otherwise the contentEncoding or default charset is used.

trustedPackages - the trusted Java packages for deserialization

See Also:

• DefaultJackson2JavaTypeMapper.setTrustedPackages(String...)

Method Details

getSupportedContentType

protected MimeType getSupportedContentType()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the supported content type; only the subtype is checked when decoding, e.g. */json, */xml. If this contains a charset parameter, when encoding, the contentType header will not be set, when decoding, the raw bytes are passed to Jackson which can dynamically determine the encoding; otherwise the contentEncoding or default charset is used.

Returns:

the supportedContentType

Since:

2.4.3

setSupportedContentType

public void setSupportedContentType(MimeType supportedContentType)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the supported content type; only the subtype is checked when decoding, e.g. */json, */xml. If this contains a charset parameter, when encoding, the contentType header will not be set, when decoding, the raw bytes are passed to Jackson which can dynamically determine the encoding; otherwise the contentEncoding or default charset is used.

Parameters:

supportedContentType - the supportedContentType to set.

Since:

2.4.3

setNullAsOptionalEmpty

public void setNullAsOptionalEmpty(boolean nullAsOptionalEmpty)

Deprecated, for removal: This API element is subject to removal in a future version.

When true, if jackson decodes the body as null convert to Optional.empty() instead of returning the original body. Default false.

Parameters:

nullAsOptionalEmpty - true to return empty.

Since:

2.4.7

getClassMapper

public @Nullable ClassMapper getClassMapper()

Deprecated, for removal: This API element is subject to removal in a future version.

setClassMapper

public void setClassMapper(ClassMapper classMapper)

Deprecated, for removal: This API element is subject to removal in a future version.

setDefaultCharset

public void setDefaultCharset(@Nullable String defaultCharset)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getClassLoader

protected @Nullable ClassLoader getClassLoader()

Deprecated, for removal: This API element is subject to removal in a future version.

getJavaTypeMapper

public Jackson2JavaTypeMapper getJavaTypeMapper()

Deprecated, for removal: This API element is subject to removal in a future version.

isTypeMapperSet

public boolean isTypeMapperSet()

Deprecated, for removal: This API element is subject to removal in a future version.

Whether 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)

Deprecated, for removal: This API element is subject to removal in a future version.

getTypePrecedence

public Jackson2JavaTypeMapper.TypePrecedence getTypePrecedence()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the type precedence.

Returns:

the precedence.

See Also:

• setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence)

setTypePrecedence

public void setTypePrecedence(Jackson2JavaTypeMapper.TypePrecedence typePrecedence)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

setUseProjectionForInterfaces

public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Specified by:

fromMessage in interface SmartMessageConverter

Parameters:

message - the input message.

conversionHint - The conversionHint must be a ParameterizedTypeReference.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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