Package org.springframework.amqp.support.converter

Class SimpleMessageConverter

java.lang.Object

org.springframework.amqp.support.converter.AbstractMessageConverter

org.springframework.amqp.support.converter.AllowedListDeserializingMessageConverter

org.springframework.amqp.support.converter.SimpleMessageConverter

All Implemented Interfaces:

MessageConverter, Aware, BeanClassLoaderAware

public class SimpleMessageConverter
extends AllowedListDeserializingMessageConverter
implements BeanClassLoaderAware

Implementation of MessageConverter that can work with Strings, Serializable instances, or byte arrays. The AbstractMessageConverter.toMessage(Object, MessageProperties) method simply checks the type of the provided instance while the fromMessage(Message) method relies upon the content-type of the provided Message.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor	Description
SimpleMessageConverter()

Method Summary

Modifier and Type	Method	Description
protected Message	createMessage(Object object, MessageProperties messageProperties)	Creates an AMQP Message from the provided Object.
protected ObjectInputStream	createObjectInputStream(InputStream is)	Create an ObjectInputStream for the given InputStream.
Object	fromMessage(Message message)	Converts from a AMQP Message to an Object.
void	setBeanClassLoader(ClassLoader classLoader)
void	setDefaultCharset(String defaultCharset)	Specify the default charset to use when converting to or from text-based Message body content.

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

addAllowedListPatterns, checkAllowedList, setAllowedListPatterns

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

createMessage, isCreateMessageIds, setCreateMessageIds, toMessage, toMessage

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

• Constant Field Values

Constructor Details

SimpleMessageConverter

public SimpleMessageConverter()

Method Details

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.

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

fromMessage

public Object fromMessage(Message message)
                   throws MessageConversionException

Converts from a AMQP Message to an 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

createMessage

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

Creates an AMQP Message from the provided Object.

Specified by:

createMessage in class AbstractMessageConverter

Parameters:

object - the payload.

messageProperties - the message properties (headers).

Returns:

a message.

Throws:

MessageConversionException

createObjectInputStream

protected ObjectInputStream createObjectInputStream(InputStream is)
                                             throws IOException

Create an ObjectInputStream for the given InputStream. The default implementation creates an ConfigurableObjectInputStream against configured ClassLoader. The class for object to deserialize is checked against allowedListPatterns.

Parameters:

is - the InputStream to read from

Returns:

the new ObjectInputStream instance to use

Throws:

IOException - if creation of the ObjectInputStream failed