Class ActiveMQTopicPublisher
- All Implemented Interfaces:
jakarta.jms.MessageProducer
,jakarta.jms.TopicPublisher
,AutoCloseable
,Closeable
,Disposable
,StatsCapable
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.
- See Also:
-
Session#createProducer(Destination)
TopicSession#createPublisher(Topic)
-
Field Summary
Fields inherited from class org.apache.activemq.ActiveMQMessageProducer
closed, info
Fields inherited from class org.apache.activemq.ActiveMQMessageProducerSupport
defaultDeliveryMode, defaultPriority, defaultTimeToLive, disableMessageID, disableMessageTimestamp, JMS_PROPERTY_NAMES_DISALLOWED, sendTimeout, session
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ActiveMQTopicPublisher
(ActiveMQSession session, ActiveMQDestination destination, int sendTimeout) -
Method Summary
Modifier and TypeMethodDescriptionjakarta.jms.Topic
getTopic()
Gets the topic associated with thisTopicPublisher
.void
publish
(jakarta.jms.Message message) Publishes a message to the topic.void
publish
(jakarta.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
(jakarta.jms.Topic topic, jakarta.jms.Message message) Publishes a message to a topic for an unidentified message producer.void
publish
(jakarta.jms.Topic topic, jakarta.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.apache.activemq.ActiveMQMessageProducer
checkClosed, close, dispose, getDestination, getMessageSequence, getProducerInfo, getProducerStats, getStartTime, getStats, getTransformer, onProducerAck, send, send, send, send, send, send, send, send, send, send, setMessageSequence, setProducerInfo, setTransformer, toString
Methods inherited from class org.apache.activemq.ActiveMQMessageProducerSupport
getDeliveryDelay, getDeliveryMode, getDisableMessageID, getDisableMessageTimestamp, getPriority, getSendTimeout, getTimeToLive, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setSendTimeout, setTimeToLive, validateValidPropertyName, validateValidPropertyValue
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface jakarta.jms.MessageProducer
close, getDeliveryDelay, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, send, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
-
Constructor Details
-
ActiveMQTopicPublisher
protected ActiveMQTopicPublisher(ActiveMQSession session, ActiveMQDestination destination, int sendTimeout) throws jakarta.jms.JMSException - Throws:
jakarta.jms.JMSException
-
-
Method Details
-
getTopic
public jakarta.jms.Topic getTopic() throws jakarta.jms.JMSExceptionGets the topic associated with thisTopicPublisher
.- Specified by:
getTopic
in interfacejakarta.jms.TopicPublisher
- Returns:
- this publisher's topic
- Throws:
jakarta.jms.JMSException
- if the JMS provider fails to get the topic for thisTopicPublisher
due to some internal error.
-
publish
public void publish(jakarta.jms.Message message) throws jakarta.jms.JMSException Publishes a message to the topic. Uses theTopicPublisher
's default delivery mode, priority, and time to live.- Specified by:
publish
in interfacejakarta.jms.TopicPublisher
- Parameters:
message
- the message to publish- Throws:
jakarta.jms.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.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 void publish(jakarta.jms.Message message, int deliveryMode, int priority, long timeToLive) throws jakarta.jms.JMSException Publishes a message to the topic, specifying delivery mode, priority, and time to live.- Specified by:
publish
in interfacejakarta.jms.TopicPublisher
- Parameters:
message
- the message to publishdeliveryMode
- the delivery mode to usepriority
- the priority for this messagetimeToLive
- the message's lifetime (in milliseconds)- Throws:
jakarta.jms.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.UnsupportedOperationException
- if a client uses this method with aTopicPublisher
that did not specify a topic at creation time.
-
publish
public void publish(jakarta.jms.Topic topic, jakarta.jms.Message message) throws jakarta.jms.JMSException 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.
- Specified by:
publish
in interfacejakarta.jms.TopicPublisher
- Parameters:
topic
- the topic to publish this message tomessage
- the message to publish- Throws:
jakarta.jms.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 void publish(jakarta.jms.Topic topic, jakarta.jms.Message message, int deliveryMode, int priority, long timeToLive) throws jakarta.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 interfacejakarta.jms.TopicPublisher
- Parameters:
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)- Throws:
jakarta.jms.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.
-