|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.jms.support.JmsAccessor org.springframework.jms.support.destination.JmsDestinationAccessor org.springframework.jms.core.JmsTemplate
public class JmsTemplate
Helper class that simplifies synchronous JMS access code.
This class requires a JMS 1.1+ provider, because it builds on the
domain-independent API. Use the JmsTemplate102
subclass for JMS 1.0.2 providers.
If you want to use dynamic destination creation, you must specify the type of JMS destination to create, using the "pubSubDomain" property. For other operations, this is not necessary, in contrast to when working with JmsTemplate102. Point-to-Point (Queues) is the default domain.
Default settings for JMS Sessions are "not transacted" and "auto-acknowledge". As defined by the J2EE specification, the transaction and acknowledgement parameters are ignored when a JMS Session is created inside an active transaction, no matter if a JTA transaction or a Spring-managed transaction. To configure them for native JMS usage, specify appropriate values for the "sessionTransacted" and "sessionAcknowledgeMode" bean properties.
This template uses a
DynamicDestinationResolver
and a SimpleMessageConverter
as default strategies for resolving a destination name or converting a message,
respectively. These defaults can be overridden through the "destinationResolver"
and "messageConverter" bean properties.
JmsAccessor.setConnectionFactory(javax.jms.ConnectionFactory)
,
JmsDestinationAccessor.setPubSubDomain(boolean)
,
JmsDestinationAccessor.setDestinationResolver(org.springframework.jms.support.destination.DestinationResolver)
,
setMessageConverter(org.springframework.jms.support.converter.MessageConverter)
,
JmsTemplate102
,
MessageProducer
,
MessageConsumer
Field Summary | |
---|---|
static long |
DEFAULT_RECEIVE_TIMEOUT
Default timeout for receive operations: -1 indicates a blocking receive without timeout. |
Fields inherited from class org.springframework.jms.support.JmsAccessor |
---|
logger |
Constructor Summary | |
---|---|
JmsTemplate()
Create a new JmsTemplate for bean-style usage. |
|
JmsTemplate(ConnectionFactory connectionFactory)
Create a new JmsTemplate, given a ConnectionFactory. |
Method Summary | |
---|---|
void |
convertAndSend(Destination destination,
Object message)
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. |
void |
convertAndSend(Destination destination,
Object message,
MessagePostProcessor postProcessor)
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. |
void |
convertAndSend(Object message)
Send the given object to the default destination, converting the object to a JMS message with a configured MessageConverter. |
void |
convertAndSend(Object message,
MessagePostProcessor postProcessor)
Send the given object to the default destination, converting the object to a JMS message with a configured MessageConverter. |
void |
convertAndSend(String destinationName,
Object message)
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. |
void |
convertAndSend(String destinationName,
Object message,
MessagePostProcessor postProcessor)
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. |
protected MessageConsumer |
createConsumer(Session session,
Destination destination,
String messageSelector)
Create a JMS MessageConsumer for the given Session and Destination. |
protected MessageProducer |
createProducer(Session session,
Destination destination)
Create a JMS MessageProducer for the given Session and Destination, configuring it to disable message ids and/or timestamps (if necessary). |
protected Object |
doConvertFromMessage(Message message)
Extract the content from the given JMS message. |
protected MessageProducer |
doCreateProducer(Session session,
Destination destination)
Create a raw JMS MessageProducer for the given Session and Destination. |
protected Message |
doReceive(Session session,
Destination destination,
String messageSelector)
Receive a JMS message. |
protected Message |
doReceive(Session session,
MessageConsumer consumer)
Actually receive a JMS message. |
protected void |
doSend(MessageProducer producer,
Message message)
Actually send the given JMS message. |
protected void |
doSend(Session session,
Destination destination,
MessageCreator messageCreator)
Send the given JMS message. |
Object |
execute(ProducerCallback action)
Send a message to a JMS destination. |
Object |
execute(SessionCallback action)
Execute the action specified by the given action object within a JMS Session. |
Object |
execute(SessionCallback action,
boolean startConnection)
Execute the action specified by the given action object within a JMS Session. |
protected Connection |
getConnection(JmsResourceHolder holder)
Fetch an appropriate Connection from the given JmsResourceHolder. |
Destination |
getDefaultDestination()
Return the destination to be used on send/receive operations that do not have a destination parameter. |
String |
getDefaultDestinationName()
Return the destination name to be used on send/receive operations that do not have a destination parameter. |
int |
getDeliveryMode()
Return the delivery mode to use when sending a message. |
MessageConverter |
getMessageConverter()
Return the message converter for this template. |
int |
getPriority()
Return the priority of a message when sending. |
long |
getReceiveTimeout()
Return the timeout to use for receive calls. |
protected Session |
getSession(JmsResourceHolder holder)
Fetch an appropriate Session from the given JmsResourceHolder. |
long |
getTimeToLive()
Return the time-to-live of the message when sending. |
protected void |
initDefaultStrategies()
Initialize the default implementations for the template's strategies: DynamicDestinationResolver and SimpleMessageConverter. |
boolean |
isExplicitQosEnabled()
If "true", then the values of deliveryMode, priority, and timeToLive will be used when sending a message. |
boolean |
isMessageIdEnabled()
Return whether message IDs are enabled. |
boolean |
isMessageTimestampEnabled()
Return whether message timestamps are enabled. |
boolean |
isPubSubNoLocal()
Return whether to inhibit the delivery of messages published by its own connection. |
protected boolean |
isSessionLocallyTransacted(Session session)
Check whether the given Session is locally transacted, that is, whether its transaction is managed by this listener container's Session handling and not by an external transaction coordinator. |
Message |
receive()
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. |
Message |
receive(Destination destination)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Message |
receive(String destinationName)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Object |
receiveAndConvert()
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. |
Object |
receiveAndConvert(Destination destination)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Object |
receiveAndConvert(String destinationName)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Message |
receiveSelected(Destination destination,
String messageSelector)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Message |
receiveSelected(String messageSelector)
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. |
Message |
receiveSelected(String destinationName,
String messageSelector)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Object |
receiveSelectedAndConvert(Destination destination,
String messageSelector)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
Object |
receiveSelectedAndConvert(String messageSelector)
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. |
Object |
receiveSelectedAndConvert(String destinationName,
String messageSelector)
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. |
void |
send(Destination destination,
MessageCreator messageCreator)
Send a message to the specified destination. |
void |
send(MessageCreator messageCreator)
Send a message to the default destination. |
void |
send(String destinationName,
MessageCreator messageCreator)
Send a message to the specified destination. |
void |
setDefaultDestination(Destination destination)
Set the destination to be used on send/receive operations that do not have a destination parameter. |
void |
setDefaultDestinationName(String destinationName)
Set the destination name to be used on send/receive operations that do not have a destination parameter. |
void |
setDeliveryMode(int deliveryMode)
Set the delivery mode to use when sending a message. |
void |
setDeliveryPersistent(boolean deliveryPersistent)
Set whether message delivery should be persistent or non-persistent, specified as boolean value ("true" or "false"). |
void |
setExplicitQosEnabled(boolean explicitQosEnabled)
Set if the QOS values (deliveryMode, priority, timeToLive) should be used for sending a message. |
void |
setMessageConverter(MessageConverter messageConverter)
Set the message converter for this template. |
void |
setMessageIdEnabled(boolean messageIdEnabled)
Set whether message IDs are enabled. |
void |
setMessageTimestampEnabled(boolean messageTimestampEnabled)
Set whether message timestamps are enabled. |
void |
setPriority(int priority)
Set the priority of a message when sending. |
void |
setPubSubNoLocal(boolean pubSubNoLocal)
Set whether to inhibit the delivery of messages published by its own connection. |
void |
setReceiveTimeout(long receiveTimeout)
Set the timeout to use for receive calls. |
void |
setTimeToLive(long timeToLive)
Set the time-to-live of the message when sending. |
Methods inherited from class org.springframework.jms.support.destination.JmsDestinationAccessor |
---|
getDestinationResolver, isPubSubDomain, resolveDestinationName, setDestinationResolver, setPubSubDomain |
Methods inherited from class org.springframework.jms.support.JmsAccessor |
---|
afterPropertiesSet, convertJmsAccessException, createConnection, createSession, getConnectionFactory, getSessionAcknowledgeMode, isClientAcknowledge, isSessionTransacted, setConnectionFactory, setSessionAcknowledgeMode, setSessionAcknowledgeModeName, setSessionTransacted |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long DEFAULT_RECEIVE_TIMEOUT
Constructor Detail |
---|
public JmsTemplate()
Note: The ConnectionFactory has to be set before using the instance. This constructor can be used to prepare a JmsTemplate via a BeanFactory, typically setting the ConnectionFactory via setConnectionFactory.
public JmsTemplate(ConnectionFactory connectionFactory)
connectionFactory
- the ConnectionFactory to obtain Connections fromMethod Detail |
---|
protected void initDefaultStrategies()
public void setDefaultDestination(Destination destination)
Alternatively, specify a "defaultDestinationName", to be dynamically resolved via the DestinationResolver.
public Destination getDefaultDestination()
public void setDefaultDestinationName(String destinationName)
Alternatively, specify a JMS Destination object as "defaultDestination".
public String getDefaultDestinationName()
public void setMessageConverter(MessageConverter messageConverter)
The default converter is a SimpleMessageConverter, which is able to handle BytesMessages, TextMessages and ObjectMessages.
public MessageConverter getMessageConverter()
public void setMessageIdEnabled(boolean messageIdEnabled)
This is only a hint to the JMS producer. See the JMS javadocs for details.
public boolean isMessageIdEnabled()
public void setMessageTimestampEnabled(boolean messageTimestampEnabled)
This is only a hint to the JMS producer. See the JMS javadocs for details.
public boolean isMessageTimestampEnabled()
public void setPubSubNoLocal(boolean pubSubNoLocal)
public boolean isPubSubNoLocal()
public void setReceiveTimeout(long receiveTimeout)
public long getReceiveTimeout()
public void setExplicitQosEnabled(boolean explicitQosEnabled)
public boolean isExplicitQosEnabled()
setDeliveryMode(int)
,
setPriority(int)
,
setTimeToLive(long)
public void setDeliveryPersistent(boolean deliveryPersistent)
Default it "true" aka delivery mode "PERSISTENT".
public void setDeliveryMode(int deliveryMode)
Since a default value may be defined administratively, this is only used when "isExplicitQosEnabled" equals "true".
deliveryMode
- the delivery mode to useisExplicitQosEnabled()
,
DeliveryMode.PERSISTENT
,
DeliveryMode.NON_PERSISTENT
,
Message.DEFAULT_DELIVERY_MODE
,
MessageProducer.send(javax.jms.Message, int, int, long)
public int getDeliveryMode()
public void setPriority(int priority)
Since a default value may be defined administratively, this is only used when "isExplicitQosEnabled" equals "true".
public int getPriority()
public void setTimeToLive(long timeToLive)
Since a default value may be defined administratively, this is only used when "isExplicitQosEnabled" equals "true".
timeToLive
- the message's lifetime (in milliseconds)isExplicitQosEnabled()
,
Message.DEFAULT_TIME_TO_LIVE
,
MessageProducer.send(javax.jms.Message, int, int, long)
public long getTimeToLive()
public Object execute(SessionCallback action, boolean startConnection) throws JmsException
execute(SessionCallback)
,
allowing the JMS Connection to be started on the fly.
Use execute(SessionCallback)
for the general case.
Starting the JMS Connection is just necessary for receiving messages,
which is preferably achieved through the receive
methods.
action
- callback object that exposes the session
JmsException
- if there is any problemexecute(SessionCallback)
,
receive()
public Object execute(SessionCallback action) throws JmsException
JmsOperations
When used with a 1.0.2 provider, you may need to downcast to the appropriate domain implementation, either QueueSession or TopicSession in the action objects doInJms callback method.
Note: The value of isPubSubDomain affects the behavior of this method. If isPubSubDomain equals true, then a TopicSession is passed to the callback. If false, then a QueueSession is passed to the callback.
execute
in interface JmsOperations
action
- callback object that exposes the session
JmsException
- if there is any problempublic Object execute(ProducerCallback action) throws JmsException
JmsOperations
execute
in interface JmsOperations
action
- callback object that exposes the session/producer pair
JmsException
- checked JMSException converted to uncheckedpublic void send(MessageCreator messageCreator) throws JmsException
JmsOperations
This will only work with a default destination specified!
send
in interface JmsOperations
messageCreator
- callback to create a message
JmsException
- checked JMSException converted to uncheckedpublic void send(Destination destination, MessageCreator messageCreator) throws JmsException
JmsOperations
send
in interface JmsOperations
destination
- the destination to send this message tomessageCreator
- callback to create a message
JmsException
- checked JMSException converted to uncheckedpublic void send(String destinationName, MessageCreator messageCreator) throws JmsException
JmsOperations
send
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)messageCreator
- callback to create a message
JmsException
- checked JMSException converted to uncheckedprotected void doSend(Session session, Destination destination, MessageCreator messageCreator) throws JMSException
session
- the JMS Session to operate ondestination
- the JMS Destination to send tomessageCreator
- callback to create a JMS Message
JMSException
- if thrown by JMS API methodsprotected void doSend(MessageProducer producer, Message message) throws JMSException
producer
- the JMS MessageProducer to send withmessage
- the JMS Message to send
JMSException
- if thrown by JMS API methodspublic void convertAndSend(Object message) throws JmsException
JmsOperations
This will only work with a default destination specified!
convertAndSend
in interface JmsOperations
message
- the object to convert to a message
JmsException
- converted checked JMSException to uncheckedpublic void convertAndSend(Destination destination, Object message) throws JmsException
JmsOperations
convertAndSend
in interface JmsOperations
destination
- the destination to send this message tomessage
- the object to convert to a message
JmsException
- converted checked JMSException to uncheckedpublic void convertAndSend(String destinationName, Object message) throws JmsException
JmsOperations
convertAndSend
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)message
- the object to convert to a message
JmsException
- checked JMSException converted to uncheckedpublic void convertAndSend(Object message, MessagePostProcessor postProcessor) throws JmsException
JmsOperations
This will only work with a default destination specified!
convertAndSend
in interface JmsOperations
message
- the object to convert to a messagepostProcessor
- the callback to modify the message
JmsException
- checked JMSException converted to uncheckedpublic void convertAndSend(Destination destination, Object message, MessagePostProcessor postProcessor) throws JmsException
JmsOperations
convertAndSend
in interface JmsOperations
destination
- the destination to send this message tomessage
- the object to convert to a messagepostProcessor
- the callback to modify the message
JmsException
- checked JMSException converted to uncheckedpublic void convertAndSend(String destinationName, Object message, MessagePostProcessor postProcessor) throws JmsException
JmsOperations
convertAndSend
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)message
- the object to convert to a message.postProcessor
- the callback to modify the message
JmsException
- checked JMSException converted to uncheckedpublic Message receive() throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
This will only work with a default destination specified!
receive
in interface JmsOperations
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedpublic Message receive(Destination destination) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receive
in interface JmsOperations
destination
- the destination to receive a message from
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedpublic Message receive(String destinationName) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receive
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedpublic Message receiveSelected(String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
This will only work with a default destination specified!
receiveSelected
in interface JmsOperations
messageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedpublic Message receiveSelected(Destination destination, String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveSelected
in interface JmsOperations
destination
- the destination to receive a message frommessageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedpublic Message receiveSelected(String destinationName, String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveSelected
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)messageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires
JmsException
- checked JMSException converted to uncheckedprotected Message doReceive(Session session, Destination destination, String messageSelector) throws JMSException
session
- the JMS Session to operate ondestination
- the JMS Destination to receive frommessageSelector
- the message selector for this consumer (can be null
)
JMSException
- if thrown by JMS API methodsprotected Message doReceive(Session session, MessageConsumer consumer) throws JMSException
session
- the JMS Session to operate onconsumer
- the JMS MessageConsumer to send with
null
if none
JMSException
- if thrown by JMS API methodspublic Object receiveAndConvert() throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
This will only work with a default destination specified!
receiveAndConvert
in interface JmsOperations
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedpublic Object receiveAndConvert(Destination destination) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveAndConvert
in interface JmsOperations
destination
- the destination to receive a message from
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedpublic Object receiveAndConvert(String destinationName) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveAndConvert
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedpublic Object receiveSelectedAndConvert(String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
This will only work with a default destination specified!
receiveSelectedAndConvert
in interface JmsOperations
messageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedpublic Object receiveSelectedAndConvert(Destination destination, String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveSelectedAndConvert
in interface JmsOperations
destination
- the destination to receive a message frommessageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedpublic Object receiveSelectedAndConvert(String destinationName, String messageSelector) throws JmsException
JmsOperations
This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.
receiveSelectedAndConvert
in interface JmsOperations
destinationName
- the name of the destination to send this message to
(to be resolved to an actual destination by a DestinationResolver)messageSelector
- the JMS message selector expression (or null
if none).
See the JMS specification for a detailed definition of selector expressions.
null
if the timeout expires.
JmsException
- checked JMSException converted to uncheckedprotected Object doConvertFromMessage(Message message)
message
- the JMS Message to convert (can be null
)
null
if noneprotected Connection getConnection(JmsResourceHolder holder)
This implementation accepts any JMS 1.1 Connection.
holder
- the JmsResourceHolder
null
if none foundprotected Session getSession(JmsResourceHolder holder)
This implementation accepts any JMS 1.1 Session.
holder
- the JmsResourceHolder
null
if none foundprotected boolean isSessionLocallyTransacted(Session session)
Note: The Session's own transacted flag will already have been checked before. This method is about finding out whether the Session's transaction is local or externally coordinated.
session
- the Session to check
JmsAccessor.isSessionTransacted()
,
ConnectionFactoryUtils.isSessionTransactional(javax.jms.Session, javax.jms.ConnectionFactory)
protected MessageProducer createProducer(Session session, Destination destination) throws JMSException
Delegates to doCreateProducer
for creation of the raw
JMS MessageProducer, which needs to be specific to JMS 1.1 or 1.0.2.
session
- the JMS Session to create a MessageProducer fordestination
- the JMS Destination to create a MessageProducer for
JMSException
- if thrown by JMS API methodsdoCreateProducer(javax.jms.Session, javax.jms.Destination)
,
setMessageIdEnabled(boolean)
,
setMessageTimestampEnabled(boolean)
protected MessageProducer doCreateProducer(Session session, Destination destination) throws JMSException
This implementation uses JMS 1.1 API.
session
- the JMS Session to create a MessageProducer fordestination
- the JMS Destination to create a MessageProducer for
JMSException
- if thrown by JMS API methodsprotected MessageConsumer createConsumer(Session session, Destination destination, String messageSelector) throws JMSException
This implementation uses JMS 1.1 API.
session
- the JMS Session to create a MessageConsumer fordestination
- the JMS Destination to create a MessageConsumer formessageSelector
- the message selector for this consumer (can be null
)
JMSException
- if thrown by JMS API methods
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |