Package org.springframework.jms.core

Class JmsMessagingTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<D>

org.springframework.messaging.core.AbstractMessageReceivingTemplate<D>

org.springframework.messaging.core.AbstractMessagingTemplate<Destination>

org.springframework.jms.core.JmsMessagingTemplate

All Implemented Interfaces:

InitializingBean, JmsMessageOperations, MessageReceivingOperations<Destination>, MessageRequestReplyOperations<Destination>, MessageSendingOperations<Destination>

public class JmsMessagingTemplate
extends AbstractMessagingTemplate<Destination>
implements JmsMessageOperations, InitializingBean

An implementation of JmsMessageOperations.

Since:

4.1

Author:

Stephane Nicoll, Juergen Hoeller

Field Summary

Fields inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

Constructor Summary

Constructors

Constructor	Description
JmsMessagingTemplate()	Constructor for use with bean properties.
JmsMessagingTemplate(ConnectionFactory connectionFactory)	Create a JmsMessagingTemplate instance with the JMS ConnectionFactory to use, implicitly building a JmsTemplate based on it.
JmsMessagingTemplate(JmsTemplate jmsTemplate)	Create a JmsMessagingTemplate instance with the JmsTemplate to use.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
void	convertAndSend(Object payload, MessagePostProcessor postProcessor)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message, apply the given post processor, and send the resulting message to a default destination.
void	convertAndSend(String destinationName, Object payload)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message and send it to the given destination.
void	convertAndSend(String destinationName, Object payload, Map<String,Object> headers)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers and send it to the given destination.
void	convertAndSend(String destinationName, Object payload, Map<String,Object> headers, MessagePostProcessor postProcessor)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.
void	convertAndSend(String destinationName, Object payload, MessagePostProcessor postProcessor)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message, apply the given post processor, and send the resulting message to the given destination.
protected MessagingException	convertJmsException(JmsException ex)
protected Message<?>	convertJmsMessage(Message message)
<T> T	convertSendAndReceive(Object request, Class<T> targetClass)	Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message to a default destination, receive the reply and convert its body of the specified target class.
<T> T	convertSendAndReceive(Object request, Class<T> targetClass, MessagePostProcessor postProcessor)	Convert the given request Object to serialized form, possibly using a MessageConverter, apply the given post processor and send the resulting Message to a default destination, receive the reply and convert its body of the given target class.
<T> T	convertSendAndReceive(String destinationName, Object request, Class<T> targetClass)	Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message to the given destination, receive the reply and convert its body of the specified target class.
<T> T	convertSendAndReceive(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor)	Convert the given request Object to serialized form, possibly using a MessageConverter, apply the given post processor and send the resulting Message to the given destination, receive the reply and convert its body of the given target class.
<T> T	convertSendAndReceive(String destinationName, Object request, Map<String,Object> headers, Class<T> targetClass)	Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.
<T> T	convertSendAndReceive(String destinationName, Object request, Map<String,Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor)	Convert the given request Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor and send the resulting Message to the specified destination, receive the reply and convert its body of the given target class.
protected Message<?>	doReceive(Destination destination)	Actually receive a message from the given destination.
protected Message<?>	doReceive(String destinationName)
protected void	doSend(Destination destination, Message<?> message)
protected void	doSend(String destinationName, Message<?> message)
protected Message<?>	doSendAndReceive(Destination destination, Message<?> requestMessage)
protected Message<?>	doSendAndReceive(String destinationName, Message<?> requestMessage)
ConnectionFactory	getConnectionFactory()	Return the ConnectionFactory that the underlying JmsTemplate uses.
String	getDefaultDestinationName()	Return the configured default destination name.
MessageConverter	getJmsMessageConverter()	Return the MessageConverter to use to convert a Message from the messaging to and from a Message.
JmsTemplate	getJmsTemplate()	Return the configured JmsTemplate.
protected String	getRequiredDefaultDestinationName()
Message<?>	receive()	Receive a message from a default destination.
Message<?>	receive(String destinationName)	Receive a message from the given destination.
<T> T	receiveAndConvert(Class<T> targetClass)	Receive a message from a default destination and convert its payload to the specified target class.
<T> T	receiveAndConvert(String destinationName, Class<T> targetClass)	Receive a message from the given destination and convert its payload to the specified target class.
void	send(String destinationName, Message<?> message)	Send a message to the given destination.
void	send(Message<?> message)	Send a message to a default destination.
Message<?>	sendAndReceive(String destinationName, Message<?> requestMessage)	Send a request message and receive the reply from the given destination.
Message<?>	sendAndReceive(Message<?> requestMessage)	Send a request message and receive the reply from a default destination.
void	setConnectionFactory(ConnectionFactory connectionFactory)	Set the ConnectionFactory to use for the underlying JmsTemplate.
void	setDefaultDestinationName(String defaultDestinationName)	Configure the default destination name to use in send methods that don't have a destination argument.
void	setJmsMessageConverter(MessageConverter jmsMessageConverter)	Set the MessageConverter to use to convert a Message from the messaging to and from a Message.
void	setJmsTemplate(JmsTemplate jmsTemplate)	Set the JmsTemplate to use.

Methods inherited from class org.springframework.messaging.core.AbstractMessagingTemplate

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive

Methods inherited from class org.springframework.messaging.core.AbstractMessageReceivingTemplate

doConvert, receive, receiveAndConvert

Methods inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, doConvert, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, setDefaultDestination, setMessageConverter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.core.MessageReceivingOperations

receive, receiveAndConvert

Methods inherited from interface org.springframework.messaging.core.MessageRequestReplyOperations

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive

Methods inherited from interface org.springframework.messaging.core.MessageSendingOperations

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, send

Constructor Details

JmsMessagingTemplate

public JmsMessagingTemplate()

Constructor for use with bean properties. Requires setConnectionFactory(jakarta.jms.ConnectionFactory) or setJmsTemplate(org.springframework.jms.core.JmsTemplate) to be called.

JmsMessagingTemplate

public JmsMessagingTemplate(ConnectionFactory connectionFactory)

Create a JmsMessagingTemplate instance with the JMS ConnectionFactory to use, implicitly building a JmsTemplate based on it.

Since:

4.1.2

JmsMessagingTemplate

public JmsMessagingTemplate(JmsTemplate jmsTemplate)

Create a JmsMessagingTemplate instance with the JmsTemplate to use.

Method Details

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

Set the ConnectionFactory to use for the underlying JmsTemplate.

Since:

4.1.2

getConnectionFactory

@Nullable
public ConnectionFactory getConnectionFactory()

Return the ConnectionFactory that the underlying JmsTemplate uses.

Since:

4.1.2

setJmsTemplate

public void setJmsTemplate(@Nullable
 JmsTemplate jmsTemplate)

Set the JmsTemplate to use.

getJmsTemplate

@Nullable
public JmsTemplate getJmsTemplate()

Return the configured JmsTemplate.

setJmsMessageConverter

public void setJmsMessageConverter(MessageConverter jmsMessageConverter)

Set the MessageConverter to use to convert a Message from the messaging to and from a Message. By default, a MessagingMessageConverter is defined using a SimpleMessageConverter to convert the payload of the message.

Consider configuring a MessagingMessageConverter with a different payload converter for more advanced scenarios.

See Also:

• MessagingMessageConverter

getJmsMessageConverter

public MessageConverter getJmsMessageConverter()

Return the MessageConverter to use to convert a Message from the messaging to and from a Message.

setDefaultDestinationName

public void setDefaultDestinationName(@Nullable
 String defaultDestinationName)

Configure the default destination name to use in send methods that don't have a destination argument. If a default destination is not configured, send methods without a destination argument will raise an exception if invoked.

See Also:

• AbstractMessageSendingTemplate.setDefaultDestination(Object)

getDefaultDestinationName

@Nullable
public String getDefaultDestinationName()

Return the configured default destination name.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

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.

Specified by:

afterPropertiesSet in interface InitializingBean

send

public void send(Message<?> message)

Description copied from interface: MessageSendingOperations

Send a message to a default destination.

Specified by:

send in interface MessageSendingOperations<Destination>

Overrides:

send in class AbstractMessageSendingTemplate<Destination>

Parameters:

message - the message to send

convertAndSend

public void convertAndSend(Object payload,
 @Nullable
 MessagePostProcessor postProcessor)
                    throws MessagingException

Description copied from interface: MessageSendingOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message, apply the given post processor, and send the resulting message to a default destination.

Specified by:

convertAndSend in interface MessageSendingOperations<Destination>

Overrides:

convertAndSend in class AbstractMessageSendingTemplate<Destination>

Parameters:

payload - the Object to use as payload

postProcessor - the post processor to apply to the message

Throws:

MessagingException

send

public void send(String destinationName,
 Message<?> message)
          throws MessagingException

Description copied from interface: JmsMessageOperations

Send a message to the given destination.

Specified by:

send in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

message - the message to send

Throws:

MessagingException

convertAndSend

public void convertAndSend(String destinationName,
 Object payload)
                    throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message and send it to the given destination.

Specified by:

convertAndSend in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

payload - the Object to use as payload

Throws:

MessagingException

convertAndSend

public void convertAndSend(String destinationName,
 Object payload,
 @Nullable
 Map<String,Object> headers)
                    throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers and send it to the given destination.

Specified by:

convertAndSend in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

payload - the Object to use as payload

headers - the headers for the message to send

Throws:

MessagingException

convertAndSend

public void convertAndSend(String destinationName,
 Object payload,
 @Nullable
 MessagePostProcessor postProcessor)
                    throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message, apply the given post processor, and send the resulting message to the given destination.

Specified by:

convertAndSend in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

payload - the Object to use as payload

postProcessor - the post processor to apply to the message

Throws:

MessagingException

convertAndSend

public void convertAndSend(String destinationName,
 Object payload,
 @Nullable
 Map<String,Object> headers,
 @Nullable
 MessagePostProcessor postProcessor)
                    throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.

Specified by:

convertAndSend in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

payload - the Object to use as payload

headers - the headers for the message to send

postProcessor - the post processor to apply to the message

Throws:

MessagingException

receive

@Nullable
public Message<?> receive()

Description copied from interface: MessageReceivingOperations

Receive a message from a default destination.

Specified by:

receive in interface MessageReceivingOperations<Destination>

Overrides:

receive in class AbstractMessageReceivingTemplate<Destination>

Returns:

the received message, possibly null if the message could not be received, for example due to a timeout

receiveAndConvert

@Nullable
public <T> T receiveAndConvert(Class<T> targetClass)

Description copied from interface: MessageReceivingOperations

Receive a message from a default destination and convert its payload to the specified target class.

Specified by:

receiveAndConvert in interface MessageReceivingOperations<Destination>

Overrides:

receiveAndConvert in class AbstractMessageReceivingTemplate<Destination>

Parameters:

targetClass - the target class to convert the payload to

Returns:

the converted payload of the reply message, possibly null if the message could not be received, for example due to a timeout

receive

@Nullable
public Message<?> receive(String destinationName)
                   throws MessagingException

Description copied from interface: JmsMessageOperations

Receive a message from the given destination.

Specified by:

receive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

Returns:

the received message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

receiveAndConvert

@Nullable
public <T> T receiveAndConvert(String destinationName,
 Class<T> targetClass)
                        throws MessagingException

Description copied from interface: JmsMessageOperations

Receive a message from the given destination and convert its payload to the specified target class.

Specified by:

receiveAndConvert in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

targetClass - the target class to convert the payload to

Returns:

the converted payload of the reply message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

sendAndReceive

@Nullable
public Message<?> sendAndReceive(Message<?> requestMessage)

Description copied from interface: MessageRequestReplyOperations

Send a request message and receive the reply from a default destination.

Specified by:

sendAndReceive in interface MessageRequestReplyOperations<Destination>

Overrides:

sendAndReceive in class AbstractMessagingTemplate<Destination>

Parameters:

requestMessage - the message to send

Returns:

the reply, possibly null if the message could not be received, for example due to a timeout

sendAndReceive

@Nullable
public Message<?> sendAndReceive(String destinationName,
 Message<?> requestMessage)
                          throws MessagingException

Description copied from interface: JmsMessageOperations

Send a request message and receive the reply from the given destination.

Specified by:

sendAndReceive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

requestMessage - the message to send

Returns:

the reply, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(String destinationName,
 Object request,
 Class<T> targetClass)
                            throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message to the given destination, receive the reply and convert its body of the specified target class.

Specified by:

convertSendAndReceive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

request - payload for the request message to send

targetClass - the target type to convert the payload of the reply to

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(Object request,
 Class<T> targetClass)

Description copied from interface: MessageRequestReplyOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message to a default destination, receive the reply and convert its body of the specified target class.

Specified by:

convertSendAndReceive in interface MessageRequestReplyOperations<Destination>

Overrides:

convertSendAndReceive in class AbstractMessagingTemplate<Destination>

Parameters:

request - payload for the request message to send

targetClass - the target type to convert the payload of the reply to

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(String destinationName,
 Object request,
 @Nullable
 Map<String,Object> headers,
 Class<T> targetClass)
                            throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, send it as a Message with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.

Specified by:

convertSendAndReceive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

request - payload for the request message to send

headers - the headers for the request message to send

targetClass - the target type to convert the payload of the reply to

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(Object request,
 Class<T> targetClass,
 @Nullable
 MessagePostProcessor postProcessor)

Description copied from interface: MessageRequestReplyOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, apply the given post processor and send the resulting Message to a default destination, receive the reply and convert its body of the given target class.

Specified by:

convertSendAndReceive in interface MessageRequestReplyOperations<Destination>

Overrides:

convertSendAndReceive in class AbstractMessagingTemplate<Destination>

Parameters:

request - payload for the request message to send

targetClass - the target type to convert the payload of the reply to

postProcessor - post process to apply to the request message

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(String destinationName,
 Object request,
 Class<T> targetClass,
 @Nullable
 MessagePostProcessor requestPostProcessor)
                            throws MessagingException

Description copied from interface: JmsMessageOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, apply the given post processor and send the resulting Message to the given destination, receive the reply and convert its body of the given target class.

Specified by:

convertSendAndReceive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

request - payload for the request message to send

targetClass - the target type to convert the payload of the reply to

requestPostProcessor - post process to apply to the request message

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException

convertSendAndReceive

@Nullable
public <T> T convertSendAndReceive(String destinationName,
 Object request,
 @Nullable
 Map<String,Object> headers,
 Class<T> targetClass,
 @Nullable
 MessagePostProcessor postProcessor)

Description copied from interface: JmsMessageOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor and send the resulting Message to the specified destination, receive the reply and convert its body of the given target class.

Specified by:

convertSendAndReceive in interface JmsMessageOperations

Parameters:

destinationName - the name of the target destination

request - payload for the request message to send

targetClass - the target type to convert the payload of the reply to

postProcessor - post process to apply to the request message

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

doSend

protected void doSend(Destination destination,
 Message<?> message)

Specified by:

doSend in class AbstractMessageSendingTemplate<Destination>

doSend

protected void doSend(String destinationName,
 Message<?> message)

doReceive

@Nullable
protected Message<?> doReceive(Destination destination)

Description copied from class: AbstractMessageReceivingTemplate

Actually receive a message from the given destination.

Specified by:

doReceive in class AbstractMessageReceivingTemplate<Destination>

Parameters:

destination - the target destination

Returns:

the received message, possibly null if the message could not be received, for example due to a timeout

doReceive

@Nullable
protected Message<?> doReceive(String destinationName)

doSendAndReceive

@Nullable
protected Message<?> doSendAndReceive(Destination destination,
 Message<?> requestMessage)

Specified by:

doSendAndReceive in class AbstractMessagingTemplate<Destination>

doSendAndReceive

@Nullable
protected Message<?> doSendAndReceive(String destinationName,
 Message<?> requestMessage)

getRequiredDefaultDestinationName

protected String getRequiredDefaultDestinationName()

convertJmsMessage

@Nullable
protected Message<?> convertJmsMessage(@Nullable
 Message message)

convertJmsException

protected MessagingException convertJmsException(JmsException ex)