Package org.springframework.amqp.support.converter

Class MarshallingMessageConverter

java.lang.Object

org.springframework.amqp.support.converter.AbstractMessageConverter

org.springframework.amqp.support.converter.MarshallingMessageConverter

All Implemented Interfaces:

MessageConverter, InitializingBean

public class MarshallingMessageConverter
extends AbstractMessageConverter
implements InitializingBean

Spring Rabbit MessageConverter that uses a Marshaller and Unmarshaller. Marshals an object to a Message and unmarshals a Message to an object.

Author:

Mark Fisher, Arjen Poutsma, Juergen Hoeller, James Carr, Ngoc Nhan

See Also:

• AmqpTemplate.convertAndSend(Object)
• AmqpTemplate.receiveAndConvert()

Constructor Summary

Constructors

Constructor	Description
MarshallingMessageConverter()	Construct a new MarshallingMessageConverter with no Marshaller or Unmarshaller set.
MarshallingMessageConverter(Marshaller marshaller)	Construct a new MarshallingMessageConverter with the given Marshaller set.
MarshallingMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller)	Construct a new MarshallingMessageConverter with the given Marshaller and Unmarshaller.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected Message	createMessage(Object object, MessageProperties messageProperties)	Marshals the given object to a Message.
Object	fromMessage(Message message)	Unmarshals the given Message into an object.
void	setContentType(String contentType)	Set the contentType to be used by this message converter.
void	setMarshaller(Marshaller marshaller)	Set the Marshaller to be used by this message converter.
void	setUnmarshaller(Unmarshaller unmarshaller)	Set the Unmarshaller to be used by this message converter.

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

Constructor Details

MarshallingMessageConverter

public MarshallingMessageConverter()

Construct a new MarshallingMessageConverter with no Marshaller or Unmarshaller set. The marshaller must be set after construction by invoking setMarshaller(Marshaller) and setUnmarshaller(Unmarshaller) .

MarshallingMessageConverter

public MarshallingMessageConverter(Marshaller marshaller)

Construct a new MarshallingMessageConverter with the given Marshaller set.

If the given Marshaller also implements the Unmarshaller interface, it is used for both marshalling and unmarshalling. Otherwise, an exception is thrown.

Note that all Marshaller implementations in Spring also implement the Unmarshaller interface, so that you can safely use this constructor.

Parameters:

marshaller - object used as marshaller and unmarshaller

Throws:

IllegalArgumentException - when marshaller does not implement the Unmarshaller interface as well

MarshallingMessageConverter

public MarshallingMessageConverter(Marshaller marshaller,
 Unmarshaller unmarshaller)

Construct a new MarshallingMessageConverter with the given Marshaller and Unmarshaller.

Parameters:

marshaller - the Marshaller to use

unmarshaller - the Unmarshaller to use

Method Details

setContentType

public void setContentType(@Nullable
 String contentType)

Set the contentType to be used by this message converter.

Parameters:

contentType - The content type.

setMarshaller

public void setMarshaller(Marshaller marshaller)

Set the Marshaller to be used by this message converter.

Parameters:

marshaller - The marshaller.

setUnmarshaller

public void setUnmarshaller(Unmarshaller unmarshaller)

Set the Unmarshaller to be used by this message converter.

Parameters:

unmarshaller - The unmarshaller.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

createMessage

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

Marshals the given object to a Message.

Specified by:

createMessage in class AbstractMessageConverter

Parameters:

object - the payload.

messageProperties - the message properties (headers).

Returns:

a message.

Throws:

MessageConversionException

fromMessage

public Object fromMessage(Message message)
                   throws MessageConversionException

Unmarshals the given Message into 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