jBroker® MQ 2.1

javax.jms
Interface TopicPublisher

All Superinterfaces:
MessageProducer

public interface TopicPublisher
extends MessageProducer

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.

See Also:
TopicSession.createPublisher(Topic)

Method Summary
 Topic getTopic()
          Gets the topic associated with this TopicPublisher.
 void publish(Message message)
          Publishes a message to the topic.
 void publish(Message message, int deliveryMode, int priority, long timeToLive)
          Publishes a message to the topic, specifying delivery mode, priority, and time to live.
 void publish(Topic topic, Message message)
          Publishes a message to a topic for an unidentified message producer.
 void publish(Topic topic, 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 interface javax.jms.MessageProducer
close, getDeliveryMode, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority,