Top Description Methods
javax.jms

public Interface QueueSender

extends MessageProducer

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.

Since
JMS 1.0
Version
JMS 2.0
See Also
javax.jms.MessageProducer, javax.jms.Session#createProducer(Destination), javax.jms.QueueSession#createSender(Queue)

Method Summary

Modifier and TypeMethod and Description
public Queue

Returns:

this sender's queue
getQueue
()

Gets the queue associated with this QueueSender.

public void
send(Message
the message to send
message
)

Redeclares javax.jms.MessageProducer.send.

Sends a message to the queue.
public void
send(Message
the message to send
message
,
int
the delivery mode to use
deliveryMode
,
int
the priority for this message
priority
,
long
the message's lifetime (in milliseconds)
timeToLive
)

Redeclares javax.jms.MessageProducer.send.

Sends a message to the queue, specifying delivery mode, priority, and time to live.
public void
send(Queue
the queue to send this message to
queue
,
Message
the message to send
message
)

Sends a message to a queue for an unidentified message producer.

public void
send(Queue
the queue to send this message to
queue
,
Message
the message to send
message
,
int
the delivery mode to use
deliveryMode
,
int
the priority for this message
priority
,
long
the message's lifetime (in milliseconds)
timeToLive
)

Sends a message to a queue for an unidentified message producer, specifying delivery mode, priority and time to live.

Inherited from javax.jms.MessageProducer:
closegetDeliveryDelaygetDeliveryModegetDestinationgetDisableMessageIDgetDisableMessageTimestampgetPrioritygetTimeToLivesendsendsendsendsendsendsetDeliveryDelaysetDeliveryModesetDisableMessageIDsetDisableMessageTimestampsetPrioritysetTimeToLive

Method Detail

getQueueback to summary
public Queue getQueue() throws JMSException

Gets the queue associated with this QueueSender.

Returns:Queue

this sender's queue

Exceptions
JMSException:
if the JMS provider fails to get the queue for this QueueSender due to some internal error.
sendback to summary
public void send(Message message) throws JMSException

Redeclares javax.jms.MessageProducer.send.

Sends a message to the queue. Uses the QueueSender's default delivery mode, priority, and time to live.

Parameters
message:Message

the message to send

Exceptions
JMSException:
if the JMS 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 a QueueSender with an invalid queue.
UnsupportedOperationException:
if a client uses this method with a QueueSender that did not specify a queue at creation time.
See Also
javax.jms.MessageProducer#getDeliveryMode(), javax.jms.MessageProducer#getTimeToLive(), javax.jms.MessageProducer#getPriority()
sendback to summary
public void send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException

Redeclares javax.jms.MessageProducer.send.

Sends a message to the queue, specifying delivery mode, priority, and time to live.

Parameters
message:Message

the message to send

deliveryMode:int

the delivery mode to use

priority:int

the priority for this message

timeToLive:long

the message's lifetime (in milliseconds)

Exceptions
JMSException:
if the JMS 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 a QueueSender with an invalid queue.
UnsupportedOperationException:
if a client uses this method with a QueueSender that did not specify a queue at creation time.
sendback to summary
public void send(Queue queue, Message message) throws JMSException

Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default 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:Queue

the queue to send this message to

message:Message

the message to send

Exceptions
JMSException:
if the JMS 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
javax.jms.MessageProducer#getDeliveryMode(), javax.jms.MessageProducer#getTimeToLive(), javax.jms.MessageProducer#getPriority()
sendback to summary
public 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 JMS API also supports unidentified message producers, which require that the queue be supplied every time a message is sent.

Parameters
queue:Queue

the queue to send this message to

message:Message

the message to send

deliveryMode:int

the delivery mode to use

priority:int

the priority for this message

timeToLive:long

the message's lifetime (in milliseconds)

Exceptions
JMSException:
if the JMS 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.