Browse Source

Fix JMSReplyTo references in javadoc (backported from main)

6.2.x
Juergen Hoeller 1 week ago
parent
commit
c6e73b5d1d
  1. 44
      spring-jms/src/main/java/org/springframework/jms/core/JmsOperations.java

44
spring-jms/src/main/java/org/springframework/jms/core/JmsOperations.java

@ -26,15 +26,15 @@ import org.springframework.lang.Nullable; @@ -26,15 +26,15 @@ import org.springframework.lang.Nullable;
/**
* Specifies a basic set of JMS operations.
*
* <p>Implemented by {@link JmsTemplate}. Not often used but a useful option
* to enhance testability, as it can easily be mocked or stubbed.
* <p>Implemented by {@link JmsTemplate}. Not often used directly, but a useful
* option to enhance testability, as it can easily be mocked or stubbed.
*
* <p>Provides {@code JmsTemplate's} {@code send(..)} and
* {@code receive(..)} methods that mirror various JMS API methods.
* See the JMS specification and javadocs for details on those methods.
*
* <p>Provides also basic request reply operation using a temporary
* queue to collect the reply.
* <p>Provides also basic request-reply operations using a temporary queue to
* receive the reply.
*
* @author Mark Pollack
* @author Juergen Hoeller
@ -59,7 +59,7 @@ public interface JmsOperations { @@ -59,7 +59,7 @@ public interface JmsOperations {
/**
* Send messages to the default JMS destination (or one specified
* for each send operation). The callback gives access to the JMS Session
* for each send operation). The callback provides access to the JMS Session
* and MessageProducer in order to perform complex send operations.
* @param action callback object that exposes the session/producer pair
* @return the result object from working with the session
@ -69,7 +69,7 @@ public interface JmsOperations { @@ -69,7 +69,7 @@ public interface JmsOperations {
<T> T execute(ProducerCallback<T> action) throws JmsException;
/**
* Send messages to a JMS destination. The callback gives access to the JMS Session
* Send messages to a JMS destination. The callback provides access to the JMS Session
* and MessageProducer in order to perform complex send operations.
* @param destination the destination to send messages to
* @param action callback object that exposes the session/producer pair
@ -80,7 +80,7 @@ public interface JmsOperations { @@ -80,7 +80,7 @@ public interface JmsOperations {
<T> T execute(Destination destination, ProducerCallback<T> action) throws JmsException;
/**
* Send messages to a JMS destination. The callback gives access to the JMS Session
* Send messages to a JMS destination. The callback provides access to the JMS Session
* and MessageProducer in order to perform complex send operations.
* @param destinationName the name of the destination to send messages to
* (to be resolved to an actual destination by a DestinationResolver)
@ -377,7 +377,7 @@ public interface JmsOperations { @@ -377,7 +377,7 @@ public interface JmsOperations {
/**
* Send a request message and receive the reply from a default destination. The
* {@link MessageCreator} callback creates the message given a Session. A temporary
* queue is created as part of this operation and is set in the {@code JMSReplyTO}
* queue is created as part of this operation and is set in the {@code JMSReplyTo}
* header of the message.
* <p>This will only work with a default destination specified!
* @param messageCreator callback to create a request message
@ -390,10 +390,10 @@ public interface JmsOperations { @@ -390,10 +390,10 @@ public interface JmsOperations {
Message sendAndReceive(MessageCreator messageCreator) throws JmsException;
/**
* Send a message and receive the reply from the specified destination. The
* {@link MessageCreator} callback creates the message given a Session. A temporary
* queue is created as part of this operation and is set in the {@code JMSReplyTO}
* header of the message.
* Send a message and receive the reply from the specified destination.
* <p>The {@link MessageCreator} callback creates the message given a Session.
* A temporary queue is created as part of this operation and is set in the
* {@code JMSReplyTo} header of the message.
* @param destination the destination to send this message to
* @param messageCreator callback to create a message
* @return the reply, possibly {@code null} if the message could not be received,
@ -405,10 +405,10 @@ public interface JmsOperations { @@ -405,10 +405,10 @@ public interface JmsOperations {
Message sendAndReceive(Destination destination, MessageCreator messageCreator) throws JmsException;
/**
* Send a message and receive the reply from the specified destination. The
* {@link MessageCreator} callback creates the message given a Session. A temporary
* queue is created as part of this operation and is set in the {@code JMSReplyTO}
* header of the message.
* Send a message and receive the reply from the specified destination.
* <p>The {@link MessageCreator} callback creates the message given a Session.
* A temporary queue is created as part of this operation and is set in the
* {@code JMSReplyTo} header of the message.
* @param destinationName the name of the destination to send this message to
* (to be resolved to an actual destination by a DestinationResolver)
* @param messageCreator callback to create a message
@ -426,7 +426,7 @@ public interface JmsOperations { @@ -426,7 +426,7 @@ public interface JmsOperations {
//---------------------------------------------------------------------------------------
/**
* Browse messages in the default JMS queue. The callback gives access to the JMS
* Browse messages in the default JMS queue. The callback provides access to the JMS
* Session and QueueBrowser in order to browse the queue and react to the contents.
* @param action callback object that exposes the session/browser pair
* @return the result object from working with the session
@ -436,7 +436,7 @@ public interface JmsOperations { @@ -436,7 +436,7 @@ public interface JmsOperations {
<T> T browse(BrowserCallback<T> action) throws JmsException;
/**
* Browse messages in a JMS queue. The callback gives access to the JMS Session
* Browse messages in a JMS queue. The callback provides access to the JMS Session
* and QueueBrowser in order to browse the queue and react to the contents.
* @param queue the queue to browse
* @param action callback object that exposes the session/browser pair
@ -447,7 +447,7 @@ public interface JmsOperations { @@ -447,7 +447,7 @@ public interface JmsOperations {
<T> T browse(Queue queue, BrowserCallback<T> action) throws JmsException;
/**
* Browse messages in a JMS queue. The callback gives access to the JMS Session
* Browse messages in a JMS queue. The callback provides access to the JMS Session
* and QueueBrowser in order to browse the queue and react to the contents.
* @param queueName the name of the queue to browse
* (to be resolved to an actual destination by a DestinationResolver)
@ -459,7 +459,7 @@ public interface JmsOperations { @@ -459,7 +459,7 @@ public interface JmsOperations {
<T> T browse(String queueName, BrowserCallback<T> action) throws JmsException;
/**
* Browse selected messages in a JMS queue. The callback gives access to the JMS
* Browse selected messages in a JMS queue. The callback provides access to the JMS
* Session and QueueBrowser in order to browse the queue and react to the contents.
* @param messageSelector the JMS message selector expression (or {@code null} if none).
* See the JMS specification for a detailed definition of selector expressions.
@ -471,7 +471,7 @@ public interface JmsOperations { @@ -471,7 +471,7 @@ public interface JmsOperations {
<T> T browseSelected(@Nullable String messageSelector, BrowserCallback<T> action) throws JmsException;
/**
* Browse selected messages in a JMS queue. The callback gives access to the JMS
* Browse selected messages in a JMS queue. The callback provides access to the JMS
* Session and QueueBrowser in order to browse the queue and react to the contents.
* @param queue the queue to browse
* @param messageSelector the JMS message selector expression (or {@code null} if none).
@ -484,7 +484,7 @@ public interface JmsOperations { @@ -484,7 +484,7 @@ public interface JmsOperations {
<T> T browseSelected(Queue queue, @Nullable String messageSelector, BrowserCallback<T> action) throws JmsException;
/**
* Browse selected messages in a JMS queue. The callback gives access to the JMS
* Browse selected messages in a JMS queue. The callback provides access to the JMS
* Session and QueueBrowser in order to browse the queue and react to the contents.
* @param queueName the name of the queue to browse
* (to be resolved to an actual destination by a DestinationResolver)

Loading…
Cancel
Save