Websphere MQ Everyplace

com.ibm.mqe.jms
Class MQeQueueSender

java.lang.Object
  |
  +--com.ibm.mqe.jms.MQeMessageProducer
        |
        +--com.ibm.mqe.jms.MQeQueueSender
All Implemented Interfaces:
javax.jms.MessageProducer, javax.jms.QueueSender

public class MQeQueueSender
extends MQeMessageProducer
implements javax.jms.QueueSender

A client uses a QueueSender to send messages to a queue.

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.

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.

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.

See Also:
MessageProducer, javax.jms.Session#createProducer(Destination), QueueSession.createSender(Queue)

Method Summary
 javax.jms.Queue getQueue()
          Get the queue associated with this queue sender.
 void send(javax.jms.Message message)
          Sends a message to the queue.
 void send(javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Sends a message to the queue, specifying delivery mode, priority, and time to live.
 void send(javax.jms.Queue queue, javax.jms.Message message)
          Sends a message to a queue for an unidentified message producer, specifying delivery mode, priority and time to live.
 void send(javax.jms.Queue queue, javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Sends a message to a queue for an unidentified message producer.
 
Methods inherited from class com.ibm.mqe.jms.MQeMessageProducer
getDeliveryMode, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.jms.MessageProducer
close, getDeliveryMode, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
 

Method Detail

getQueue

public javax.jms.Queue getQueue()
                         throws javax.jms.JMSException
Get the queue associated with this queue sender.

Specified by:
getQueue in interface javax.jms.QueueSender
Returns:
the queue
Throws:
javax.jms.JMSException - if JMS fails to get queue for this queue sender due to some internal error.

send

public void send(javax.jms.Message message)
          throws javax.jms.JMSException
Sends a message to the queue. Uses the QueueSender's default delivery mode, priority, and time to live.

Specified by:
send in interface javax.jms.QueueSender
Parameters:
message - the message to send
Throws:
javax.jms.JMSException - if the JMS provider fails to send the message due to some internal error.
javax.jms.MessageFormatException - if an invalid message is specified.
javax.jms.InvalidDestinationException - if a client uses this method with a QueueSender with an invalid queue.
java.lang.UnsupportedOperationException - if a client uses this method with a QueueSender that did not specify a queue at creation time.
See Also:
MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

send

public void send(javax.jms.Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws javax.jms.JMSException
Sends a message to the queue, specifying delivery mode, priority, and time to live.

Specified by:
send in interface javax.jms.QueueSender
Parameters:
message - the message to send
deliveryMode - the delivery mode to use
priority - the priority for this message
timeToLive - the message's lifetime (in milliseconds)
Throws:
javax.jms.JMSException - if the JMS provider fails to send the message due to some internal error.
javax.jms.MessageFormatException - if an invalid message is specified.
javax.jms.InvalidDestinationException - if a client uses this method with a QueueSender with an invalid queue.
java.lang.UnsupportedOperationException - if a client uses this method with a QueueSender that did not specify a queue at creation time.

send

public void send(javax.jms.Queue queue,
                 javax.jms.Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws javax.jms.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.

Specified by:
send in interface javax.jms.QueueSender
Parameters:
queue - the queue to send this message to
message - the message to send
Throws:
javax.jms.JMSException - if the JMS provider fails to send the message due to some internal error.
javax.jms.MessageFormatException - if an invalid message is specified.
javax.jms.InvalidDestinationException - if a client uses this method with an invalid queue.
See Also:
MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

send

public void send(javax.jms.Queue queue,
                 javax.jms.Message message)
          throws javax.jms.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.

Specified by:
send in interface javax.jms.QueueSender
Parameters:
queue - the queue to send this message to
message - the message to send
Throws:
javax.jms.JMSException - if the JMS provider fails to send the message due to some internal error.
javax.jms.MessageFormatException - if an invalid message is specified.
javax.jms.InvalidDestinationException - if a client uses this method with an invalid queue.

Websphere MQ Everyplace