Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.activemq
Class ActiveMQTopicPublisher  view ActiveMQTopicPublisher download ActiveMQTopicPublisher.java

java.lang.Object
  extended byorg.activemq.ActiveMQMessageProducer
      extended byorg.activemq.ActiveMQTopicPublisher
All Implemented Interfaces:
Closeable, javax.jms.MessageProducer, org.activemq.management.StatsCapable, javax.jms.TopicPublisher

public class ActiveMQTopicPublisher
extends ActiveMQMessageProducer
implements javax.jms.TopicPublisher

A client uses a TopicPublisher object to publish messages on a topic. A TopicPublisher object is the publish-subscribe form of a message producer.

Normally, the Topic is specified when a TopicPublisher is created. In this case, an attempt to use the publish methods for an unidentified TopicPublisher will throw a java.lang.UnsupportedOperationException.

If the TopicPublisher is created with an unidentified Topic, an attempt to use the publish methods that assume that the Topic has been identified will throw a java.lang.UnsupportedOperationException.

During the execution of its publish method, a message must not be changed by other threads within the client. If the message is modified, the result of the publish is undefined.

After publishing a message, a client may retain and modify it without affecting the message that has been published. The same message object may be published multiple times.

The following message headers are set as part of publishing a message: JMSDestination,JMSDeliveryMode,JMSExpiration, JMSPriority,JMSMessageID and JMSTimeStamp. When the message is published, the values of these headers are ignored. After completion of the publish, the headers hold the values specified by the method publishing the message. It is possible for the publish 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 TopicPublisher. A MessageProducer object is recommended when creating new code. The TopicPublisher is provided to support existing code.

Because TopicPublisher inherits from MessageProducer , it inherits the send methods that are a part of the MessageProducer interface. Using the send methods will have the same effect as using the publish methods: they are functionally the same.


Field Summary
 
Fields inherited from class org.activemq.ActiveMQMessageProducer
closed, defaultDestination, session
 
Constructor Summary
protected ActiveMQTopicPublisher(ActiveMQSession session, org.activemq.message.ActiveMQDestination destination)
           
 
Method Summary
 javax.jms.Topic getTopic()
          Gets the topic associated with this TopicPublisher.
 void publish(javax.jms.Message message)
          Publishes a message to the topic.
 void publish(javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Publishes a message to the topic, specifying delivery mode, priority, and time to live.
 void publish(javax.jms.Topic topic, javax.jms.Message message)
          Publishes a message to a topic for an unidentified message producer.
 void publish(javax.jms.Topic topic, javax.jms.Message message, int deliveryMode, int priority, long timeToLive)
          Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.
 
Methods inherited from class org.activemq.ActiveMQMessageProducer
checkClosed, close, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getIdGenerator, getNextSequenceNumber, getPriority, getProducerId, getProducerMessageKey, getProducerStats, getStartTime, getStats, getTimeToLive, isResuseMessageId, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setProducerId, setReuseMessageId, 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, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
 

Constructor Detail

ActiveMQTopicPublisher

protected ActiveMQTopicPublisher(ActiveMQSession session,
                                 org.activemq.message.ActiveMQDestination destination)
                          throws javax.jms.JMSException
Method Detail

getTopic

public javax.jms.Topic getTopic()
                         throws javax.jms.JMSException
Gets the topic associated with this TopicPublisher.

Specified by:
getTopic in interface javax.jms.TopicPublisher

publish

public void publish(javax.jms.Message message)
             throws javax.jms.JMSException
Publishes a message to the topic. Uses the TopicPublisher's default delivery mode, priority, and time to live.

Specified by:
publish in interface javax.jms.TopicPublisher

publish

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

Specified by:
publish in interface javax.jms.TopicPublisher

publish

public void publish(javax.jms.Topic topic,
                    javax.jms.Message message)
             throws javax.jms.JMSException
Publishes a message to a topic for an unidentified message producer. Uses the TopicPublisher's default delivery mode, priority, and time to live.

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

Specified by:
publish in interface javax.jms.TopicPublisher

publish

public void publish(javax.jms.Topic topic,
                    javax.jms.Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws javax.jms.JMSException
Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.

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

Specified by:
publish in interface javax.jms.TopicPublisher