org.apache.activemq.ActiveMQTopicPublisher Maven / Gradle / Ivy
Show all versions of activemq-client Show documentation
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.activemq;
import jakarta.jms.JMSException;
import jakarta.jms.Message;
import jakarta.jms.Topic;
import jakarta.jms.TopicPublisher;
import org.apache.activemq.command.ActiveMQDestination;
/**
* 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.
*
* @see Session#createProducer(Destination)
* @see TopicSession#createPublisher(Topic)
*/
public class ActiveMQTopicPublisher extends ActiveMQMessageProducer implements
TopicPublisher {
protected ActiveMQTopicPublisher(ActiveMQSession session,
ActiveMQDestination destination, int sendTimeout) throws JMSException {
super(session, session.getNextProducerId(), destination,sendTimeout);
}
/**
* Gets the topic associated with this TopicPublisher.
*
* @return this publisher's topic
* @throws JMSException if the JMS provider fails to get the topic for this
* TopicPublisher due to some internal error.
*/
public Topic getTopic() throws JMSException {
return (Topic) super.getDestination();
}
/**
* Publishes a message to the topic. Uses the TopicPublisher's
* default delivery mode, priority, and time to live.
*
* @param message the message to publish
* @throws JMSException if the JMS provider fails to publish the message due to
* some internal error.
* @throws MessageFormatException if an invalid message is specified.
* @throws InvalidDestinationException if a client uses this method with a TopicPublisher
* with an invalid topic.
* @throws java.lang.UnsupportedOperationException
* if a client uses this method with a TopicPublisher
* that did not specify a topic at creation time.
* @see jakarta.jms.MessageProducer#getDeliveryMode()
* @see jakarta.jms.MessageProducer#getTimeToLive()
* @see jakarta.jms.MessageProducer#getPriority()
*/
public void publish(Message message) throws JMSException {
super.send(message);
}
/**
* Publishes a message to the topic, specifying delivery mode, priority,
* and time to live.
*
* @param message the message to publish
* @param deliveryMode the delivery mode to use
* @param priority the priority for this message
* @param timeToLive the message's lifetime (in milliseconds)
* @throws JMSException if the JMS provider fails to publish the message due to
* some internal error.
* @throws MessageFormatException if an invalid message is specified.
* @throws InvalidDestinationException if a client uses this method with a TopicPublisher
* with an invalid topic.
* @throws java.lang.UnsupportedOperationException
* if a client uses this method with a TopicPublisher
* that did not specify a topic at creation time.
*/
public void publish(Message message, int deliveryMode, int priority,
long timeToLive) throws JMSException {
super.send(message, deliveryMode, priority, timeToLive);
}
/**
* Publishes a message to a topic for an unidentified message producer.
* Uses the TopicPublisher'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.
*
* @param topic the topic to publish this message to
* @param message the message to publish
* @throws JMSException if the JMS provider fails to publish the message due to
* some internal error.
* @throws MessageFormatException if an invalid message is specified.
* @throws InvalidDestinationException if a client uses this method with an invalid topic.
* @see jakarta.jms.MessageProducer#getDeliveryMode()
* @see jakarta.jms.MessageProducer#getTimeToLive()
* @see jakarta.jms.MessageProducer#getPriority()
*/
public void publish(Topic topic, Message message) throws JMSException {
super.send(topic, message);
}
/**
* 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.
*
* @param topic the topic to publish this message to
* @param message the message to publish
* @param deliveryMode the delivery mode to use
* @param priority the priority for this message
* @param timeToLive the message's lifetime (in milliseconds)
* @throws JMSException if the JMS provider fails to publish the message due to
* some internal error.
* @throws MessageFormatException if an invalid message is specified.
* @throws InvalidDestinationException if a client uses this method with an invalid topic.
*/
public void publish(Topic topic, Message message, int deliveryMode,
int priority, long timeToLive) throws JMSException {
super.send(topic, message, deliveryMode, priority, timeToLive);
}
}