| javax.jms.TopicPublisher
| TopicPublisher | | public interface TopicPublisher extends MessageProducer(Code) | | 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.
version:
1.1 February 2, 2002
author:
Mark Hapner
author:
Rich Burridge
author:
Kate Stout
See Also: Session.createProducer(Destination)
See Also:
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. |
| getTopic | | Topic getTopic() throws JMSException(Code) | | Gets the topic associated with this TopicPublisher.
this publisher's topic
exception:
JMSException - if the JMS provider fails to get the topic forthis TopicPublisherdue to some internal error. |
| publish | | void publish(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | Publishes a message to the topic, specifying delivery mode,
priority, and time to live.
Parameters:
message - the message to publish
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to publish the messagedue to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client uses this methodwith a TopicPublisher withan invalid topic.
exception:
java.lang.UnsupportedOperationException - if a client uses thismethod with a TopicPublisher thatdid not specify a topic at creation time. |
| publish | | void publish(Topic topic, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | 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.
Parameters:
topic - the topic to publish this message to
Parameters:
message - the message to publish
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to publish the messagedue to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with an invalid topic. |
|
|