Movatterモバイル変換

Interface TopicPublisher

All Superinterfaces:: MessageProducer

public interfaceTopicPublisher
extendsMessageProducer

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

Normally, theTopic is specified when aTopicPublisher is created. In this case, an attempt to use thepublish methods for an unidentifiedTopicPublisher will throw ajava.lang.UnsupportedOperationException.

If theTopicPublisher is created with an unidentifiedTopic, an attempt to use thepublish methods that assume that theTopic has been identified will throw ajava.lang.UnsupportedOperationException.

During the execution of itspublish method, a message must not be changed by other threads within the client. If the message is modified, the result of thepublish 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 andJMSTimeStamp. When the message is published, the values of these headers are ignored. After completion of thepublish, the headers hold the values specified by the method publishing the message. It is possible for thepublish method not to setJMSMessageID andJMSTimeStamp if the setting of these headers is explicitly disabled by theMessageProducer.setDisableMessageID orMessageProducer.setDisableMessageTimestamp method.

See Also:: TopicSession.createPublisher(Topic)


	`getTopic()` Gets the topic associated with this`TopicPublisher`.
	`publish(Message message)` Publishes a message to the topic.
	`publish(Message message, int deliveryMode, int priority, long timeToLive)` Publishes a message to the topic, specifying delivery mode, priority, and time to live.
	`publish(Topic topic,Message message)` Publishes a message to a topic for an unidentified message producer.
	`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,setTimeToLive

getTopic

publicTopicgetTopic()               throwsJMSException

Gets the topic associated with thisTopicPublisher.

Returns:: this publisher's topic
Throws:: JMSException - if the JMS provider fails to get the topic for thisTopicPublisher due to some internal error.

publish

public voidpublish(Message message)             throwsJMSException

Publishes a message to the topic. Uses theTopicPublisher's default delivery mode, priority, and time to live.

Parameters:: message - the message to publish
Throws:: JMSException - if the JMS 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 aTopicPublisher with an invalid topic.; java.lang.UnsupportedOperationException - if a client uses this method with aTopicPublisher that did not specify a topic at creation time.
See Also:: MessageProducer.getDeliveryMode(),MessageProducer.getTimeToLive(),MessageProducer.getPriority()

publish

public voidpublish(Message message,                    int deliveryMode,                    int priority,                    long timeToLive)             throwsJMSException

Publishes a message to the topic, specifying delivery mode, priority, and time to live.

Parameters:: message - the message to publish; deliveryMode - the delivery mode to use; priority - the priority for this message; timeToLive - the message's lifetime (in milliseconds)
Throws:: JMSException - if the JMS 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 aTopicPublisher with an invalid topic.; java.lang.UnsupportedOperationException - if a client uses this method with aTopicPublisher that did not specify a topic at creation time.

publish

public voidpublish(Topic topic,Message message)             throwsJMSException

Publishes a message to a topic for an unidentified message producer. Uses theTopicPublisher'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.

Parameters:: topic - the topic to publish this message to; message - the message to publish
Throws:: JMSException - if the JMS 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.
See Also:: MessageProducer.getDeliveryMode(),MessageProducer.getTimeToLive(),MessageProducer.getPriority()

publish

public voidpublish(Topic topic,Message message,                    int deliveryMode,                    int priority,                    long timeToLive)             throwsJMSException

Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.

Parameters:: topic - the topic to publish this message to; message - the message to publish; deliveryMode - the delivery mode to use; priority - the priority for this message; timeToLive - the message's lifetime (in milliseconds)
Throws:: JMSException - if the JMS 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.

[8]ページ先頭