public interface TopicPublisher extends MessageProducer
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.
Session.createProducer(Destination),
TopicSession.createPublisher(Topic)| Modifier and Type | Method and Description |
|---|---|
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.
|
close, getDeliveryDelay, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, send, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLiveTopic getTopic() throws JMSException
TopicPublisher.JMSException - if the Jakarta Messaging provider fails to get the topic for this TopicPublisher due to some
internal error.void publish(Message message) throws JMSException
TopicPublisher's default delivery mode, priority, and time to
live.message - the message to publishJMSException - if the Jakarta Messaging provider fails to publish the message due to some internal error.MessageFormatException - if an invalid message is specified.InvalidDestinationException - if a client uses this method with a TopicPublisher with an invalid
topic.java.lang.UnsupportedOperationException - if a client uses this method with a TopicPublisher that
did not specify a topic at creation time.MessageProducer.getDeliveryMode(),
MessageProducer.getTimeToLive(),
MessageProducer.getPriority()void publish(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
message - the message to publishdeliveryMode - the delivery mode to usepriority - the priority for this messagetimeToLive - the message's lifetime (in milliseconds)JMSException - if the Jakarta Messaging provider fails to publish the message due to some internal error.MessageFormatException - if an invalid message is specified.InvalidDestinationException - if a client uses this method with a TopicPublisher with an invalid
topic.java.lang.UnsupportedOperationException - if a client uses this method with a TopicPublisher that
did not specify a topic at creation time.void publish(Topic topic, Message message) throws JMSException
TopicPublisher's default
delivery mode, priority, and time to live.
Typically, a message producer is assigned a topic at creation time; however, the Jakarta Messaging API also supports unidentified message producers, which require that the topic be supplied every time a message is published.
topic - the topic to publish this message tomessage - the message to publishJMSException - if the Jakarta Messaging provider fails to publish the message due to some internal error.MessageFormatException - if an invalid message is specified.InvalidDestinationException - if a client uses this method with an invalid topic.MessageProducer.getDeliveryMode(),
MessageProducer.getTimeToLive(),
MessageProducer.getPriority()void publish(Topic topic, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
Typically, a message producer is assigned a topic at creation time; however, the Jakarta Messaging API also supports unidentified message producers, which require that the topic be supplied every time a message is published.
topic - the topic to publish this message tomessage - the message to publishdeliveryMode - the delivery mode to usepriority - the priority for this messagetimeToLive - the message's lifetime (in milliseconds)JMSException - if the Jakarta Messaging provider fails to publish the message due to some internal error.MessageFormatException - if an invalid message is specified.InvalidDestinationException - if a client uses this method with an invalid topic.