Package org.apache.activemq

Class ActiveMQQueueSender

java.lang.Object

org.apache.activemq.ActiveMQMessageProducerSupport

org.apache.activemq.ActiveMQMessageProducer

org.apache.activemq.ActiveMQQueueSender

All Implemented Interfaces:

MessageProducer, QueueSender, Closeable, Disposable, StatsCapable

public class ActiveMQQueueSender
extends ActiveMQMessageProducer
implements QueueSender

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.

See Also:

MessageProducer, QueueSession.createSender(Queue)

Field Summary

Fields inherited from class org.apache.activemq.ActiveMQMessageProducer

closed, info

Fields inherited from class org.apache.activemq.ActiveMQMessageProducerSupport

defaultDeliveryMode, defaultPriority, defaultTimeToLive, disableMessageID, disableMessageTimestamp, sendTimeout, session

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActiveMQQueueSender(ActiveMQSession session, ActiveMQDestination destination, int sendTimeout)

Method Summary

Modifier and Type	Method	Description
Queue	getQueue()	Gets the queue associated with this QueueSender.
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 class org.apache.activemq.ActiveMQMessageProducer

checkClosed, close, dispose, getDestination, getMessageSequence, getProducerInfo, getProducerStats, getStartTime, getStats, getTransformer, onProducerAck, send, send, send, send, send, setMessageSequence, setProducerInfo, setTransformer, toString

Methods inherited from class org.apache.activemq.ActiveMQMessageProducerSupport

getDeliveryMode, getDisableMessageID, getDisableMessageTimestamp, getPriority, getSendTimeout, getTimeToLive, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setSendTimeout, setTimeToLive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.MessageProducer

close, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive

Methods inherited from interface javax.jms.QueueSender

send, send

Constructor Detail

ActiveMQQueueSender

protected ActiveMQQueueSender(ActiveMQSession session,
                              ActiveMQDestination destination,
                              int sendTimeout)
                       throws JMSException

Throws:

JMSException

Method Detail

getQueue

public Queue getQueue()
               throws JMSException

Gets the queue associated with this QueueSender.

Specified by:

getQueue in interface QueueSender

Returns:

this sender's queue

Throws:

JMSException - if the JMS provider fails to get the queue for this QueueSender due to some internal error.

send

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.

Specified by:

send in interface QueueSender

Parameters:

queue - the queue to send this message to

message - the message to send

Throws:

JMSException - if the JMS provider fails to send the message due to some internal error.

See Also:

MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

send

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.

Specified by:

send in interface QueueSender

Parameters:

queue - the queue to send this message to

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:

JMSException - if the JMS provider fails to send the message due to some internal error.