Spring Framework 6.1.4 · org.springframework.jms.support.converter.MessagingMessageConverter

Modifier and Type	Field and Description
private JmsHeaderMapper	headerMapper
private MessageConverter	payloadConverter

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

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected Message	createMessageForPayload(Object payload, Session session, Object conversionHint) Create a JMS message for the specified payload and conversionHint.
protected final MessageHeaders	extractHeaders(Message message)
protected Object	extractPayload(Message message) Extract the payload of the specified `jakarta.jms.Message`.
public Object	fromMessage(Message the message to convert message) Implements org.springframework.jms.support.converter.MessageConverter.fromMessage. Convert from a JMS Message to a Java object.
public void	setHeaderMapper(JmsHeaderMapper headerMapper) Set the `JmsHeaderMapper` to use to map JMS headers to and from standard message headers.
public void	setPayloadConverter(MessageConverter payloadConverter) Set the `MessageConverter` to use to convert the payload.
public Message	toMessage(Object the object to convert object, Session the Session to use for creating a JMS Message session) Implements org.springframework.jms.support.converter.MessageConverter.toMessage. Convert a Java object to a JMS Message using the supplied session to create the message object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

headerMapper	back to summary
private JmsHeaderMapper headerMapper

payloadConverter	back to summary
private MessageConverter payloadConverter

Constructor Detail

MessagingMessageConverter back to summary

MessagingMessageConverter	back to summary
public MessagingMessageConverter() Create an instance with a default payload converter. See Also `org.springframework.jms.support.converter.SimpleMessageConverter`, `org.springframework.jms.support.SimpleJmsHeaderMapper`

public MessagingMessageConverter()

Create an instance with a default payload converter.

See Also: org.springframework.jms.support.converter.SimpleMessageConverter, org.springframework.jms.support.SimpleJmsHeaderMapper

MessagingMessageConverter	back to summary
public MessagingMessageConverter(MessageConverter payloadConverter) Create an instance with the specific payload converter. Parameters payloadConverter:MessageConverter the payload converter to use Since 4.3.12

MessagingMessageConverter

back to summary

public MessagingMessageConverter(MessageConverter payloadConverter)

Create an instance with the specific payload converter.

Parameters

payloadConverter:MessageConverter: the payload converter to use

Since

4.3.12

MessagingMessageConverter	back to summary
public MessagingMessageConverter(MessageConverter payloadConverter, JmsHeaderMapper headerMapper) Create an instance with the specified payload converter and header mapper.

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

createMessageForPayload back to summary

createMessageForPayload	back to summary
protected Message createMessageForPayload(Object payload, Session session, 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`}. Since 4.3 See Also `MessageConverter#toMessage(Object, Session)`

protected Message createMessageForPayload(Object payload, Session session, 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}.

Since: 4.3
See Also: MessageConverter#toMessage(Object, Session)

extractHeaders	back to summary
protected final MessageHeaders extractHeaders(Message message)

extractPayload	back to summary
protected Object extractPayload(Message message) throws JMSException Extract the payload of the specified `jakarta.jms.Message`.

fromMessage	back to summary
public Object fromMessage(Message message) throws JMSException, MessageConversionException Implements org.springframework.jms.support.converter.MessageConverter.fromMessage. Doc from org.springframework.jms.support.converter.MessageConverter.fromMessage. Convert from a JMS Message to a Java object. Parameters message:Message the message to convert Returns:Object the converted Java object Annotations @Override @SuppressWarnings:rawtypes, unchecked Exceptions JMSException: if thrown by JMS API methods MessageConversionException: in case of conversion failure

fromMessage

back to summary

public Object fromMessage(Message message) throws JMSException, MessageConversionException

Implements org.springframework.jms.support.converter.MessageConverter.fromMessage.

Doc from org.springframework.jms.support.converter.MessageConverter.fromMessage.

Convert from a JMS Message to a Java object.

Parameters

message:Message: the message to convert

Returns:Object

the converted Java object

Annotations

@Override
@SuppressWarnings:rawtypes, unchecked

Exceptions

JMSException:: if thrown by JMS API methods
MessageConversionException:: in case of conversion failure

setHeaderMapper	back to summary
public void setHeaderMapper(JmsHeaderMapper headerMapper) Set the `JmsHeaderMapper` to use to map JMS headers to and from standard message headers.

setPayloadConverter	back to summary
public void setPayloadConverter(MessageConverter payloadConverter) Set the `MessageConverter` to use to convert the payload.

toMessage	back to summary
public Message toMessage(Object object, Session session) throws JMSException, MessageConversionException Implements org.springframework.jms.support.converter.MessageConverter.toMessage. Doc from org.springframework.jms.support.converter.MessageConverter.toMessage. Convert a Java object to a JMS Message using the supplied session to create the message object. Parameters object:Object the object to convert session:Session the Session to use for creating a JMS Message Returns:Message the JMS Message Annotations @Override Exceptions JMSException: if thrown by JMS API methods MessageConversionException: in case of conversion failure

toMessage

back to summary