org.springframework.jms.support.converter

Class MessagingMessageConverter

java.lang.Object

org.springframework.jms.support.converter.MessagingMessageConverter

All Implemented Interfaces:

InitializingBean, MessageConverter

public class MessagingMessageConverter
extends java.lang.Object
implements MessageConverter, InitializingBean

Convert a Message from the messaging abstraction to and from a Message using an underlying MessageConverter for the payload and a JmsHeaderMapper to map the JMS headers to and from standard message headers.

Since:

4.1

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
MessagingMessageConverter() Create an instance with a default payload converter.
MessagingMessageConverter(MessageConverter payloadConverter) Create an instance with the specific payload converter.
MessagingMessageConverter(MessageConverter payloadConverter, JmsHeaderMapper headerMapper) Create an instance with the specified payload converter and header mapper.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected Message	createMessageForPayload(java.lang.Object payload, Session session) Deprecated. as of 4.3, use createMessageForPayload(Object, Session, Object)
protected Message	createMessageForPayload(java.lang.Object payload, Session session, java.lang.Object conversionHint) Create a JMS message for the specified payload and conversionHint.
protected MessageHeaders	extractHeaders(Message message)
protected java.lang.Object	extractPayload(Message message) Extract the payload of the specified Message.
java.lang.Object	fromMessage(Message message) Convert from a JMS Message to a Java object.
void	setHeaderMapper(JmsHeaderMapper headerMapper) Set the JmsHeaderMapper to use to map JMS headers to and from standard message headers.
void	setPayloadConverter(MessageConverter payloadConverter) Set the MessageConverter to use to convert the payload.
Message	toMessage(java.lang.Object object, Session session) Convert a Java object to a JMS Message using the supplied session to create the message object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagingMessageConverter

public MessagingMessageConverter()

Create an instance with a default payload converter.

See Also:

SimpleMessageConverter, SimpleJmsHeaderMapper

MessagingMessageConverter

public MessagingMessageConverter(MessageConverter payloadConverter)

Create an instance with the specific payload converter.

Parameters:

payloadConverter - the payload converter to use

Since:

4.3.12

MessagingMessageConverter

public MessagingMessageConverter(MessageConverter payloadConverter,
                                 JmsHeaderMapper headerMapper)

Create an instance with the specified payload converter and header mapper.

Method Detail

setPayloadConverter

public void setPayloadConverter(MessageConverter payloadConverter)

Set the MessageConverter to use to convert the payload.

setHeaderMapper

public void setHeaderMapper(JmsHeaderMapper headerMapper)

Set the JmsHeaderMapper to use to map JMS headers to and from standard message headers.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

toMessage

public Message toMessage(java.lang.Object object,
                         Session session)
                  throws JMSException,
                         MessageConversionException

Description copied from interface: MessageConverter

Convert a Java object to a JMS Message using the supplied session to create the message object.

Specified by:

toMessage in interface MessageConverter

Parameters:

object - the object to convert

session - the Session to use for creating a JMS Message

Returns:

the JMS Message

Throws:

JMSException - if thrown by JMS API methods

MessageConversionException - in case of conversion failure

fromMessage

public java.lang.Object fromMessage(Message message)
                             throws JMSException,
                                    MessageConversionException

Description copied from interface: MessageConverter

Convert from a JMS Message to a Java object.

Specified by:

fromMessage in interface MessageConverter

Parameters:

message - the message to convert

Returns:

the converted Java object

Throws:

JMSException - if thrown by JMS API methods

MessageConversionException - in case of conversion failure

extractPayload

protected java.lang.Object extractPayload(Message message)
                                   throws JMSException

Extract the payload of the specified Message.

Throws:

JMSException

createMessageForPayload

@Deprecated
protected Message createMessageForPayload(java.lang.Object payload,
                                                      Session session)
                                               throws JMSException

Deprecated. as of 4.3, use createMessageForPayload(Object, Session, Object)

Create a JMS message for the specified payload.

Throws:

JMSException

See Also:

MessageConverter.toMessage(Object, Session)

createMessageForPayload

protected Message createMessageForPayload(java.lang.Object payload,
                                          Session session,
                                          java.lang.Object conversionHint)
                                   throws JMSException

Create a JMS message for the specified payload and conversionHint. The conversion hint is an extra object passed to the MessageConverter, e.g. the associated MethodParameter (may be null}.

Throws:

JMSException

Since:

4.3

See Also:

MessageConverter.toMessage(Object, Session)

extractHeaders

protected final MessageHeaders extractHeaders(Message message)