| javax.jms.QueueSender
| QueueSender | | public interface QueueSender extends MessageProducer(Code) | | A client uses a QueueSender object to send messages to a queue.
Normally, the Queue is specified when a
QueueSender is created. In this case, an attempt to use
the send methods for an unidentified
QueueSender will throw a
java.lang.UnsupportedOperationException.
If the QueueSender is created with an unidentified
Queue, an attempt to use the send methods that
assume that the Queue has been identified will throw a
java.lang.UnsupportedOperationException.
During the execution of its send method, a message
must not be changed by other threads within the client.
If the message is modified, the result of the send is
undefined.
After sending a message, a client may retain and modify it
without affecting the message that has been sent. The same message
object may be sent multiple times.
The following message headers are set as part of sending a
message: JMSDestination, JMSDeliveryMode,
JMSExpiration, JMSPriority,
JMSMessageID and JMSTimeStamp.
When the message is sent, the values of these headers are ignored.
After the completion of the send, the headers hold the values
specified by the method sending the message. It is possible for the
send method not to set JMSMessageID and
JMSTimeStamp if the
setting of these headers is explicitly disabled by the
MessageProducer.setDisableMessageID or
MessageProducer.setDisableMessageTimestamp method.
Creating a MessageProducer provides the same features as
creating a QueueSender. A MessageProducer object is
recommended when creating new code. The QueueSender is
provided to support existing code.
version:
1.1 - February 2, 2002
author:
Mark Hapner
author:
Rich Burridge
author:
Kate Stout
See Also: javax.jms.MessageProducer
See Also: javax.jms.Session.createProducer(Destination)
See Also: javax.jms.QueueSession.createSender(Queue) |
| Method Summary | |
| Queue | getQueue()
Gets the queue associated with this QueueSender. | | void | send(Message message)
Sends a message to the queue. | | void | send(Message message, int deliveryMode, int priority, long timeToLive)
Sends a message to the queue, specifying delivery mode, priority, and
time to live. | | void | send(Queue queue, Message message)
Sends a message to a queue for an unidentified message producer. | | void | send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive)
Sends a message to a queue for an unidentified message producer,
specifying delivery mode, priority and time to live. |
| getQueue | | Queue getQueue() throws JMSException(Code) | | Gets the queue associated with this QueueSender.
this sender's queue
exception:
JMSException - if the JMS provider fails to get the queue forthis QueueSenderdue to some internal error. |
| send | | void send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | Sends a message to the queue, specifying delivery mode, priority, and
time to live.
Parameters:
message - the message to send
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to send the message due to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with a QueueSender withan invalid queue.
exception:
java.lang.UnsupportedOperationException - if a client uses thismethod with a QueueSender that didnot specify a queue at creation time. |
| send | | void send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | Sends a message to a queue for an unidentified message producer,
specifying delivery mode, priority and time to live.
Typically, a message producer is assigned a queue at creation
time; however, the JMS API also supports unidentified message producers,
which require that the queue be supplied every time a message is
sent.
Parameters:
queue - the queue to send this message to
Parameters:
message - the message to send
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to send the message due to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with an invalid queue. |
|
|