org.springframework.amqp.support.converter

Class SimpleMessageConverter

java.lang.Object

org.springframework.amqp.support.converter.AbstractMessageConverter

org.springframework.amqp.support.converter.WhiteListDeserializingMessageConverter

org.springframework.amqp.support.converter.SimpleMessageConverter

All Implemented Interfaces:

MessageConverter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware

public class SimpleMessageConverter
extends WhiteListDeserializingMessageConverter
implements org.springframework.beans.factory.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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
SimpleMessageConverter()

Method Summary

Modifier and Type	Method and Description
protected Message	createMessage(java.lang.Object object, MessageProperties messageProperties) Creates an AMQP Message from the provided Object.
protected java.io.ObjectInputStream	createObjectInputStream(java.io.InputStream is, java.lang.String codebaseUrl) Create an ObjectInputStream for the given InputStream and codebase.
java.lang.Object	fromMessage(Message message) Converts from a AMQP Message to an Object.
void	setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
void	setCodebaseUrl(java.lang.String codebaseUrl) Set the codebase URL to download classes from if not found locally.
void	setDefaultCharset(java.lang.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.WhiteListDeserializingMessageConverter

addWhiteListPatterns, checkWhiteList, setWhiteListPatterns

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 Detail

DEFAULT_CHARSET

public static final java.lang.String DEFAULT_CHARSET

See Also:

Constant Field Values

Constructor Detail

SimpleMessageConverter

public SimpleMessageConverter()

Method Detail

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

setCodebaseUrl

public void setCodebaseUrl(java.lang.String codebaseUrl)

Set the codebase URL to download classes from if not found locally. Can consists of multiple URLs, separated by spaces.

Follows RMI's codebase conventions for dynamic class download.

Parameters:

codebaseUrl - The codebase URL.

See Also:

CodebaseAwareObjectInputStream, RMIClassLoader

setDefaultCharset

public void setDefaultCharset(java.lang.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.

fromMessage

public java.lang.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(java.lang.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 java.io.ObjectInputStream createObjectInputStream(java.io.InputStream is,
                                                            java.lang.String codebaseUrl)
                                                     throws java.io.IOException

Create an ObjectInputStream for the given InputStream and codebase. The default implementation creates a CodebaseAwareObjectInputStream.

Parameters:

is - the InputStream to read from

codebaseUrl - the codebase URL to load classes from if not found locally (can be null)

Returns:

the new ObjectInputStream instance to use

Throws:

java.io.IOException - if creation of the ObjectInputStream failed

See Also:

CodebaseAwareObjectInputStream