org.apache.activemq
Class ActiveMQMessageProducer

java.lang.Object
  extended by org.apache.activemq.ActiveMQMessageProducer
All Implemented Interfaces:
javax.jms.MessageProducer, Closeable, Disposable, StatsCapable
Direct Known Subclasses:
ActiveMQQueueSender, ActiveMQTopicPublisher

public class ActiveMQMessageProducer
extends java.lang.Object
implements javax.jms.MessageProducer, StatsCapable, Closeable, Disposable

A client uses a MessageProducer object to send messages to a destination. A MessageProducer object is created by passing a Destination object to a message-producer creation method supplied by a session.

MessageProducer is the parent interface for all message producers.

A client also has the option of creating a message producer without supplying a destination. In this case, a destination must be provided with every send operation. A typical use for this kind of message producer is to send replies to requests using the request's JMSReplyTo destination.

A client can specify a default delivery mode, priority, and time to live for messages sent by a message producer. It can also specify the delivery mode, priority, and time to live for an individual message.

A client can specify a time-to-live value in milliseconds for each message it sends. This value defines a message expiration time that is the sum of the message's time-to-live and the GMT when it is sent (for transacted sends, this is the time the client sends the message, not the time the transaction is committed).

A JMS provider should do its best to expire messages accurately; however, the JMS API does not define the accuracy provided.

Version:
$Revision: 1.14 $
See Also:
TopicPublisher, QueueSender, Session.createProducer(javax.jms.Destination)

Field Summary
protected  boolean closed
           
protected  ProducerInfo info
           
protected  ActiveMQSession session
           
 
Constructor Summary
protected ActiveMQMessageProducer(ActiveMQSession session, ProducerId producerId, ActiveMQDestination destination)
           
 
Method Summary
protected  void checkClosed()
          Check if the instance of this producer has been closed.
 void close()
          Closes the message producer.
 void dispose()
           
 int getDeliveryMode()
          Gets the producer's default delivery mode.
 javax.jms.Destination getDestination()
          Gets the destination associated with this MessageProducer.
 boolean getDisableMessageID()
          Gets an indication of whether message IDs are disabled.
 boolean getDisableMessageTimestamp()
          Gets an indication of whether message timestamps are disabled.
protected  long getMessageSequence()
           
 int getPriority()
          Gets the producer's default priority.
protected  ProducerInfo getProducerInfo()
           
 JMSProducerStatsImpl getProducerStats()
           
protected  long getStartTime()
           
 StatsImpl getStats()
           
 long getTimeToLive()
          Gets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.
 void send(javax.jms.Destination destination, javax.jms.Message message)
          Sends a message to a destination for an unidentified message producer.
 void send(javax.jms.Destination destination, javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Sends a message to a destination for an unidentified message producer, specifying delivery mode, priority and time to live.
 void send(javax.jms.Message message)
          Sends a message using the MessageProducer's default delivery mode, priority, and time to live.
 void send(javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Sends a message to the destination, specifying delivery mode, priority, and time to live.
 void setDeliveryMode(int newDeliveryMode)
          Sets the producer's default delivery mode.
 void setDisableMessageID(boolean value)
          Sets whether message IDs are disabled.
 void setDisableMessageTimestamp(boolean value)
          Sets whether message timestamps are disabled.
protected  void setMessageSequence(edu.emory.mathcs.backport.java.util.concurrent.atomic.AtomicLong messageSequence)
           
 void setPriority(int newDefaultPriority)
          Sets the producer's default priority.
protected  void setProducerInfo(ProducerInfo info)
           
 void setTimeToLive(long timeToLive)
          Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

session

protected ActiveMQSession session

info

protected ProducerInfo info

closed

protected boolean closed
Constructor Detail

ActiveMQMessageProducer

protected ActiveMQMessageProducer(ActiveMQSession session,
                                  ProducerId producerId,
                                  ActiveMQDestination destination)
                           throws javax.jms.JMSException
Throws:
javax.jms.JMSException
Method Detail

getStats

public StatsImpl getStats()
Specified by:
getStats in interface StatsCapable
Returns:
the Stats for this object

getProducerStats

public JMSProducerStatsImpl getProducerStats()

setDisableMessageID

public void setDisableMessageID(boolean value)
                         throws javax.jms.JMSException
Sets whether message IDs are disabled.

Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the setDisableMessageID method on this message producer, a JMS client enables this potential optimization for all messages sent by this message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

Message IDs are enabled by default.

Specified by:
setDisableMessageID in interface javax.jms.MessageProducer
Parameters:
value - indicates if message IDs are disabled
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.

getDisableMessageID

public boolean getDisableMessageID()
                            throws javax.jms.JMSException
Gets an indication of whether message IDs are disabled.

Specified by:
getDisableMessageID in interface javax.jms.MessageProducer
Returns:
an indication of whether message IDs are disabled
Throws:
javax.jms.JMSException - if the JMS provider fails to determine if message IDs are disabled due to some internal error.

setDisableMessageTimestamp

public void setDisableMessageTimestamp(boolean value)
                                throws javax.jms.JMSException
Sets whether message timestamps are disabled.

Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the setDisableMessageTimestamp method on this message producer, a JMS client enables this potential optimization for all messages sent by this message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

Message timestamps are enabled by default.

Specified by:
setDisableMessageTimestamp in interface javax.jms.MessageProducer
Parameters:
value - indicates if message timestamps are disabled
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.

getDisableMessageTimestamp

public boolean getDisableMessageTimestamp()
                                   throws javax.jms.JMSException
Gets an indication of whether message timestamps are disabled.

Specified by:
getDisableMessageTimestamp in interface javax.jms.MessageProducer
Returns:
an indication of whether message timestamps are disabled
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.

setDeliveryMode

public void setDeliveryMode(int newDeliveryMode)
                     throws javax.jms.JMSException
Sets the producer's default delivery mode.

Delivery mode is set to PERSISTENT by default.

Specified by:
setDeliveryMode in interface javax.jms.MessageProducer
Parameters:
newDeliveryMode - the message delivery mode for this message producer; legal values are DeliveryMode.NON_PERSISTENT and DeliveryMode.PERSISTENT
Throws:
javax.jms.JMSException - if the JMS provider fails to set the delivery mode due to some internal error.
See Also:
MessageProducer.getDeliveryMode(), DeliveryMode.NON_PERSISTENT, DeliveryMode.PERSISTENT, Message.DEFAULT_DELIVERY_MODE

getDeliveryMode

public int getDeliveryMode()
                    throws javax.jms.JMSException
Gets the producer's default delivery mode.

Specified by:
getDeliveryMode in interface javax.jms.MessageProducer
Returns:
the message delivery mode for this message producer
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.

setPriority

public void setPriority(int newDefaultPriority)
                 throws javax.jms.JMSException
Sets the producer's default priority.

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. Priority is set to 4 by default.

Specified by:
setPriority in interface javax.jms.MessageProducer
Parameters:
newDefaultPriority - the message priority for this message producer; must be a value between 0 and 9
Throws:
javax.jms.JMSException - if the JMS provider fails to set the delivery mode due to some internal error.
See Also:
MessageProducer.getPriority(), Message.DEFAULT_PRIORITY

getPriority

public int getPriority()
                throws javax.jms.JMSException
Gets the producer's default priority.

Specified by:
getPriority in interface javax.jms.MessageProducer
Returns:
the message priority for this message producer
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.
See Also:
MessageProducer.setPriority(int)

setTimeToLive

public void setTimeToLive(long timeToLive)
                   throws javax.jms.JMSException
Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Time to live is set to zero by default.

Specified by:
setTimeToLive in interface javax.jms.MessageProducer
Parameters:
timeToLive - the message time to live in milliseconds; zero is unlimited
Throws:
javax.jms.JMSException - if the JMS provider fails to set the time to live due to some internal error.
See Also:
MessageProducer.getTimeToLive(), Message.DEFAULT_TIME_TO_LIVE

getTimeToLive

public long getTimeToLive()
                   throws javax.jms.JMSException
Gets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Specified by:
getTimeToLive in interface javax.jms.MessageProducer
Returns:
the message time to live in milliseconds; zero is unlimited
Throws:
javax.jms.JMSException - if the JMS provider fails to get the time to live due to some internal error.
See Also:
MessageProducer.setTimeToLive(long)

getDestination

public javax.jms.Destination getDestination()
                                     throws javax.jms.JMSException
Gets the destination associated with this MessageProducer.

Specified by:
getDestination in interface javax.jms.MessageProducer
Returns:
this producer's Destination/
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.
Since:
1.1

close

public void close()
           throws javax.jms.JMSException
Closes the message producer.

Since a provider may allocate some resources on behalf of a MessageProducer outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

Specified by:
close in interface javax.jms.MessageProducer
Specified by:
close in interface Closeable
Throws:
javax.jms.JMSException - if the JMS provider fails to close the producer due to some internal error.

dispose

public void dispose()
Specified by:
dispose in interface Disposable

checkClosed

protected void checkClosed()
                    throws javax.jms.IllegalStateException
Check if the instance of this producer has been closed.

Throws:
javax.jms.IllegalStateException

send

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

Specified by:
send in interface javax.jms.MessageProducer
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 MessageProducer with an invalid destination.
java.lang.UnsupportedOperationException - if a client uses this method with a MessageProducer that did not specify a destination at creation time.
Since:
1.1
See Also:
Session.createProducer(javax.jms.Destination), MessageProducer

send

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

Specified by:
send in interface javax.jms.MessageProducer
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 MessageProducer with an invalid destination.
java.lang.UnsupportedOperationException - if a client uses this method with a MessageProducer that did not specify a destination at creation time.
Since:
1.1
See Also:
Session.createProducer(javax.jms.Destination)

send

public void send(javax.jms.Destination destination,
                 javax.jms.Message message)
          throws javax.jms.JMSException
Sends a message to a destination for an unidentified message producer. Uses the MessageProducer's default delivery mode, priority, and time to live.

Typically, a message producer is assigned a destination at creation time; however, the JMS API also supports unidentified message producers, which require that the destination be supplied every time a message is sent.

Specified by:
send in interface javax.jms.MessageProducer
Parameters:
destination - the destination 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 destination.
java.lang.UnsupportedOperationException - if a client uses this method with a MessageProducer that specified a destination at creation time.
See Also:
Session.createProducer(javax.jms.Destination), MessageProducer

send

public void send(javax.jms.Destination destination,
                 javax.jms.Message message,
                 int deliveryMode,
                 int priority,
                 long timeToLive)
          throws javax.jms.JMSException
Sends a message to a destination for an unidentified message producer, specifying delivery mode, priority and time to live.

Typically, a message producer is assigned a destination at creation time; however, the JMS API also supports unidentified message producers, which require that the destination be supplied every time a message is sent.

Specified by:
send in interface javax.jms.MessageProducer
Parameters:
destination - the destination 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:
javax.jms.JMSException - if the JMS provider fails to send the message due to some internal error.
java.lang.UnsupportedOperationException - if an invalid destination is specified.
javax.jms.InvalidDestinationException - if a client uses this method with an invalid destination.
Since:
1.1
See Also:
Session.createProducer(javax.jms.Destination)

getStartTime

protected long getStartTime()
Returns:
the time in milli second when this object was created.

getMessageSequence

protected long getMessageSequence()
Returns:
Returns the messageSequence.

setMessageSequence

protected void setMessageSequence(edu.emory.mathcs.backport.java.util.concurrent.atomic.AtomicLong messageSequence)
Parameters:
messageSequence - The messageSequence to set.

getProducerInfo

protected ProducerInfo getProducerInfo()
Returns:
Returns the info.

setProducerInfo

protected void setProducerInfo(ProducerInfo info)
Parameters:
info - The info to set

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2011 Apache Software Foundation. All Rights Reserved.