org.springframework.jms.core
Interface JmsOperations

All Known Implementing Classes:
JmsTemplate, JmsTemplate102

public interface JmsOperations

Specifies a basic set of JMS operations.

Implemented by JmsTemplate. Not often used but a useful option to enhance testability, as it can easily be mocked or stubbed.

Provides JmsTemplate's send(..) and receive(..) methods that mirror various JMS API methods. See the JMS specification and javadocs for details on those methods.

Since:
1.1
Author:
Mark Pollack, Juergen Hoeller
See Also:
JmsTemplate, Destination, Session, MessageProducer, MessageConsumer

Method Summary
<T> T
browse(BrowserCallback<T> action)
          Browse messages in the default JMS queue.
<T> T
browse(javax.jms.Queue queue, BrowserCallback<T> action)
          Browse messages in a JMS queue.
<T> T
browse(java.lang.String queueName, BrowserCallback<T> action)
          Browse messages in a JMS queue.
<T> T
browseSelected(javax.jms.Queue queue, java.lang.String messageSelector, BrowserCallback<T> action)
          Browse selected messages in a JMS queue.
<T> T
browseSelected(java.lang.String messageSelector, BrowserCallback<T> action)
          Browse selected messages in a JMS queue.
<T> T
browseSelected(java.lang.String queueName, java.lang.String messageSelector, BrowserCallback<T> action)
          Browse selected messages in a JMS queue.
 void convertAndSend(javax.jms.Destination destination, java.lang.Object message)
          Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter.
 void convertAndSend(javax.jms.Destination destination, java.lang.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(java.lang.Object message)
          Send the given object to the default destination, converting the object to a JMS message with a configured MessageConverter.
 void convertAndSend(java.lang.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(java.lang.String destinationName, java.lang.Object message)
          Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter.
 void convertAndSend(java.lang.String destinationName, java.lang.Object message, MessagePostProcessor postProcessor)
          Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter.
<T> T
execute(javax.jms.Destination destination, ProducerCallback<T> action)
          Send messages to a JMS destination.
<T> T
execute(ProducerCallback<T> action)
          Send messages to the default JMS destination (or one specified for each send operation).
<T> T
execute(SessionCallback<T> action)
          Execute the action specified by the given action object within a JMS Session.
<T> T
execute(java.lang.String destinationName, ProducerCallback<T> action)
          Send messages to a JMS destination.
 javax.jms.Message receive()
          Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.
 javax.jms.Message receive(javax.jms.Destination destination)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 javax.jms.Message receive(java.lang.String destinationName)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveAndConvert()
          Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveAndConvert(javax.jms.Destination destination)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveAndConvert(java.lang.String destinationName)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 javax.jms.Message receiveSelected(javax.jms.Destination destination, java.lang.String messageSelector)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 javax.jms.Message receiveSelected(java.lang.String messageSelector)
          Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.
 javax.jms.Message receiveSelected(java.lang.String destinationName, java.lang.String messageSelector)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveSelectedAndConvert(javax.jms.Destination destination, java.lang.String messageSelector)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveSelectedAndConvert(java.lang.String messageSelector)
          Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.
 java.lang.Object receiveSelectedAndConvert(java.lang.String destinationName, java.lang.String messageSelector)
          Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.
 void send(javax.jms.Destination destination, MessageCreator messageCreator)
          Send a message to the specified destination.
 void send(MessageCreator messageCreator)
          Send a message to the default destination.
 void send(java.lang.String destinationName, MessageCreator messageCreator)
          Send a message to the specified destination.
 

Method Detail

execute

<T> T execute(SessionCallback<T> action)
          throws JmsException
Execute the action specified by the given action object within a JMS Session.

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.

Parameters:
action - callback object that exposes the session
Returns:
the result object from working with the session
Throws:
JmsException - if there is any problem

execute

<T> T execute(ProducerCallback<T> action)
          throws JmsException
Send messages to the default JMS destination (or one specified for each send operation). The callback gives access to the JMS Session and MessageProducer in order to perform complex send operations.

Parameters:
action - callback object that exposes the session/producer pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

execute

<T> T execute(javax.jms.Destination destination,
              ProducerCallback<T> action)
          throws JmsException
Send messages to a JMS destination. The callback gives access to the JMS Session and MessageProducer in order to perform complex send operations.

Parameters:
destination - the destination to send messages to
action - callback object that exposes the session/producer pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

execute

<T> T execute(java.lang.String destinationName,
              ProducerCallback<T> action)
          throws JmsException
Send messages to a JMS destination. The callback gives access to the JMS Session and MessageProducer in order to perform complex send operations.

Parameters:
destinationName - the name of the destination to send messages to (to be resolved to an actual destination by a DestinationResolver)
action - callback object that exposes the session/producer pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

send

void send(MessageCreator messageCreator)
          throws JmsException
Send a message to the default destination.

This will only work with a default destination specified!

Parameters:
messageCreator - callback to create a message
Throws:
JmsException - checked JMSException converted to unchecked

send

void send(javax.jms.Destination destination,
          MessageCreator messageCreator)
          throws JmsException
Send a message to the specified destination. The MessageCreator callback creates the message given a Session.

Parameters:
destination - the destination to send this message to
messageCreator - callback to create a message
Throws:
JmsException - checked JMSException converted to unchecked

send

void send(java.lang.String destinationName,
          MessageCreator messageCreator)
          throws JmsException
Send a message to the specified destination. The MessageCreator callback creates the message given a Session.

Parameters:
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
Throws:
JmsException - checked JMSException converted to unchecked

convertAndSend

void convertAndSend(java.lang.Object message)
                    throws JmsException
Send the given object to the default destination, converting the object to a JMS message with a configured MessageConverter.

This will only work with a default destination specified!

Parameters:
message - the object to convert to a message
Throws:
JmsException - converted checked JMSException to unchecked

convertAndSend

void convertAndSend(javax.jms.Destination destination,
                    java.lang.Object message)
                    throws JmsException
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter.

Parameters:
destination - the destination to send this message to
message - the object to convert to a message
Throws:
JmsException - converted checked JMSException to unchecked

convertAndSend

void convertAndSend(java.lang.String destinationName,
                    java.lang.Object message)
                    throws JmsException
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter.

Parameters:
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
Throws:
JmsException - checked JMSException converted to unchecked

convertAndSend

void convertAndSend(java.lang.Object message,
                    MessagePostProcessor postProcessor)
                    throws JmsException
Send the given object to the default destination, converting the object to a JMS message with a configured MessageConverter. The MessagePostProcessor callback allows for modification of the message after conversion.

This will only work with a default destination specified!

Parameters:
message - the object to convert to a message
postProcessor - the callback to modify the message
Throws:
JmsException - checked JMSException converted to unchecked

convertAndSend

void convertAndSend(javax.jms.Destination destination,
                    java.lang.Object message,
                    MessagePostProcessor postProcessor)
                    throws JmsException
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. The MessagePostProcessor callback allows for modification of the message after conversion.

Parameters:
destination - the destination to send this message to
message - the object to convert to a message
postProcessor - the callback to modify the message
Throws:
JmsException - checked JMSException converted to unchecked

convertAndSend

void convertAndSend(java.lang.String destinationName,
                    java.lang.Object message,
                    MessagePostProcessor postProcessor)
                    throws JmsException
Send the given object to the specified destination, converting the object to a JMS message with a configured MessageConverter. The MessagePostProcessor callback allows for modification of the message after conversion.

Parameters:
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
Throws:
JmsException - checked JMSException converted to unchecked

receive

javax.jms.Message receive()
                          throws JmsException
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.

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!

Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receive

javax.jms.Message receive(javax.jms.Destination destination)
                          throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destination - the destination to receive a message from
Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receive

javax.jms.Message receive(java.lang.String destinationName)
                          throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destinationName - the name of the destination to send this message to (to be resolved to an actual destination by a DestinationResolver)
Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelected

javax.jms.Message receiveSelected(java.lang.String messageSelector)
                                  throws JmsException
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.

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!

Parameters:
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelected

javax.jms.Message receiveSelected(javax.jms.Destination destination,
                                  java.lang.String messageSelector)
                                  throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destination - the destination to receive a message from
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelected

javax.jms.Message receiveSelected(java.lang.String destinationName,
                                  java.lang.String messageSelector)
                                  throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
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.
Returns:
the message received by the consumer, or null if the timeout expires
Throws:
JmsException - checked JMSException converted to unchecked

receiveAndConvert

java.lang.Object receiveAndConvert()
                                   throws JmsException
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

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!

Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

receiveAndConvert

java.lang.Object receiveAndConvert(javax.jms.Destination destination)
                                   throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destination - the destination to receive a message from
Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

receiveAndConvert

java.lang.Object receiveAndConvert(java.lang.String destinationName)
                                   throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destinationName - the name of the destination to send this message to (to be resolved to an actual destination by a DestinationResolver)
Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelectedAndConvert

java.lang.Object receiveSelectedAndConvert(java.lang.String messageSelector)
                                           throws JmsException
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

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!

Parameters:
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelectedAndConvert

java.lang.Object receiveSelectedAndConvert(javax.jms.Destination destination,
                                           java.lang.String messageSelector)
                                           throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
destination - the destination to receive a message from
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

receiveSelectedAndConvert

java.lang.Object receiveSelectedAndConvert(java.lang.String destinationName,
                                           java.lang.String messageSelector)
                                           throws JmsException
Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured MessageConverter.

This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.

Parameters:
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.
Returns:
the message produced for the consumer or null if the timeout expires.
Throws:
JmsException - checked JMSException converted to unchecked

browse

<T> T browse(BrowserCallback<T> action)
         throws JmsException
Browse messages in the default JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

browse

<T> T browse(javax.jms.Queue queue,
             BrowserCallback<T> action)
         throws JmsException
Browse messages in a JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
queue - the queue to browse
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

browse

<T> T browse(java.lang.String queueName,
             BrowserCallback<T> action)
         throws JmsException
Browse messages in a JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
queueName - the name of the queue to browse (to be resolved to an actual destination by a DestinationResolver)
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

browseSelected

<T> T browseSelected(java.lang.String messageSelector,
                     BrowserCallback<T> action)
                 throws JmsException
Browse selected messages in a JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

browseSelected

<T> T browseSelected(javax.jms.Queue queue,
                     java.lang.String messageSelector,
                     BrowserCallback<T> action)
                 throws JmsException
Browse selected messages in a JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
queue - the queue to browse
messageSelector - the JMS message selector expression (or null if none). See the JMS specification for a detailed definition of selector expressions.
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked

browseSelected

<T> T browseSelected(java.lang.String queueName,
                     java.lang.String messageSelector,
                     BrowserCallback<T> action)
                 throws JmsException
Browse selected messages in a JMS queue. The callback gives access to the JMS Session and QueueBrowser in order to browse the queue and react to the contents.

Parameters:
queueName - the name of the queue to browse (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.
action - callback object that exposes the session/browser pair
Returns:
the result object from working with the session
Throws:
JmsException - checked JMSException converted to unchecked