-
- All Superinterfaces:
AutoCloseable
,MessageProducer
public interface QueueSender extends MessageProducer
A client uses aQueueSender
object to send messages to a queue.Normally, the
Queue
is specified when aQueueSender
is created. In this case, an attempt to use thesend
methods for an unidentifiedQueueSender
will throw ajava.lang.UnsupportedOperationException
.If the
QueueSender
is created with an unidentifiedQueue
, an attempt to use thesend
methods that assume that theQueue
has been identified will throw ajava.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 thesend
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
andJMSTimeStamp
. When the message is sent, the values of these headers are ignored. After the completion of thesend
, the headers hold the values specified by the method sending the message. It is possible for thesend
method not to setJMSMessageID
andJMSTimeStamp
if the setting of these headers is explicitly disabled by theMessageProducer.setDisableMessageID
orMessageProducer.setDisableMessageTimestamp
method.Creating a
MessageProducer
provides the same features as creating aQueueSender
. AMessageProducer
object is recommended when creating new code. TheQueueSender
is provided to support existing code.- Since:
- JMS 1.0
- Version:
- Jakarta Messaging 2.0
- See Also:
MessageProducer
,Session.createProducer(Destination)
,QueueSession.createSender(Queue)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Queue
getQueue()
Gets the queue associated with thisQueueSender
.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.-
Methods inherited from interface jakarta.jms.MessageProducer
close, getDeliveryDelay, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
-
-
-
-
Method Detail
-
getQueue
Queue getQueue() throws JMSException
Gets the queue associated with thisQueueSender
.- Returns:
- this sender's queue
- Throws:
JMSException
- if the Jakarta Messaging provider fails to get the queue for thisQueueSender
due to some internal error.
-
send
void send(Message message) throws JMSException
Sends a message to the queue. Uses theQueueSender
's default delivery mode, priority, and time to live.- Specified by:
send
in interfaceMessageProducer
- Parameters:
message
- the message to send- Throws:
JMSException
- if the Jakarta Messaging provider fails to send the message due to some internal error.MessageFormatException
- if an invalid message is specified.InvalidDestinationException
- if a client uses this method with aQueueSender
with an invalid queue.UnsupportedOperationException
- if a client uses this method with aQueueSender
that did not specify a queue at creation time.- See Also:
MessageProducer.getDeliveryMode()
,MessageProducer.getTimeToLive()
,MessageProducer.getPriority()
-
send
void send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
Sends a message to the queue, specifying delivery mode, priority, and time to live.- Specified by:
send
in interfaceMessageProducer
- Parameters:
message
- the message to senddeliveryMode
- the delivery mode to usepriority
- the priority for this messagetimeToLive
- the message's lifetime (in milliseconds)- Throws:
JMSException
- if the Jakarta Messaging provider fails to send the message due to some internal error.MessageFormatException
- if an invalid message is specified.InvalidDestinationException
- if a client uses this method with aQueueSender
with an invalid queue.UnsupportedOperationException
- if a client uses this method with aQueueSender
that did not specify a queue at creation time.- See Also:
Session.createProducer(jakarta.jms.Destination)
-
send
void send(Queue queue, Message message) throws JMSException
Sends a message to a queue for an unidentified message producer. Uses theQueueSender
's default delivery mode, priority, and time to live.Typically, a message producer is assigned a queue at creation time; however, the Jakarta Messaging 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 tomessage
- the message to send- Throws:
JMSException
- if the Jakarta Messaging provider fails to send the message due to some internal error.MessageFormatException
- if an invalid message is specified.InvalidDestinationException
- if a client uses this method with an invalid queue.- See Also:
MessageProducer.getDeliveryMode()
,MessageProducer.getTimeToLive()
,MessageProducer.getPriority()
-
send
void send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
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 Jakarta Messaging 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 tomessage
- the message to senddeliveryMode
- the delivery mode to usepriority
- the priority for this messagetimeToLive
- the message's lifetime (in milliseconds)- Throws:
JMSException
- if the Jakarta Messaging provider fails to send the message due to some internal error.MessageFormatException
- if an invalid message is specified.InvalidDestinationException
- if a client uses this method with an invalid queue.
-
-