org.springframework.jms.support.converter

Interface MessageConverter

All Known Implementing Classes:

AbstractAdaptableMessageListener.MessagingMessageConverterAdapter, MappingJackson2MessageConverter, MarshallingMessageConverter, MessagingMessageConverter, SimpleMessageConverter

public interface MessageConverter

Strategy interface that specifies a converter between Java objects and JMS messages.

Check out SimpleMessageConverter for a default implementation, converting between the 'standard' message payloads and JMS Message types.

Since:

1.1

Author:

Mark Pollack, Juergen Hoeller

See Also:

JmsTemplate.setMessageConverter(org.springframework.jms.support.converter.MessageConverter), AbstractAdaptableMessageListener.setMessageConverter(org.springframework.jms.support.converter.MessageConverter), JmsInvokerClientInterceptor.setMessageConverter(org.springframework.jms.support.converter.MessageConverter), JmsInvokerServiceExporter.setMessageConverter(org.springframework.jms.support.converter.MessageConverter)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	fromMessage(Message message) Convert from a JMS Message to a Java object.
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.

Method Detail

toMessage

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

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

Parameters:

object - the object to convert

session - the Session to use for creating a JMS Message

Returns:

the JMS Message

Throws:

javax.jms.JMSException - if thrown by JMS API methods

MessageConversionException - in case of conversion failure

JMSException

fromMessage

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

Convert from a JMS Message to a Java object.

Parameters:

message - the message to convert

Returns:

the converted Java object

Throws:

javax.jms.JMSException - if thrown by JMS API methods

MessageConversionException - in case of conversion failure

JMSException