alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

ActiveMQ example source code file (ActiveMQTopicPublisher.java)

This example ActiveMQ source code file (ActiveMQTopicPublisher.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - ActiveMQ tags/keywords

activemqdestination, activemqmessageproducer, activemqtopicpublisher, activemqtopicpublisher, jmsexception, jmsexception, message, message, topic, topic, topicpublisher

The ActiveMQ ActiveMQTopicPublisher.java source code

/**
 * 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 javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.Topic;
import javax.jms.TopicPublisher;

import org.apache.activemq.command.ActiveMQDestination;

/**
 * A client uses a <CODE>TopicPublisher object to publish messages on
 * a topic. A <CODE>TopicPublisher object is the publish-subscribe
 * form of a message producer.
 * <p/>
 * <P>
 * Normally, the <CODE>Topic is specified when a TopicPublisher
 * </CODE> is created. In this case, an attempt to use the publish
 * </CODE> methods for an unidentified TopicPublisher will throw
 * a <CODE>java.lang.UnsupportedOperationException.
 * <p/>
 * <P>
 * If the <CODE>TopicPublisher is created with an unidentified 
 * Topic</CODE>, an attempt to use the publish methods that
 * assume that the <CODE>Topic has been identified will throw a 
 * java.lang.UnsupportedOperationException</CODE>.
 * <p/>
 * <P>
 * During the execution of its <CODE>publish method, a message must
 * not be changed by other threads within the client. If the message is
 * modified, the result of the <CODE>publish is undefined.
 * <p/>
 * <P>
 * 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.
 * <p/>
 * <P>
 * The following message headers are set as part of publishing a message:
 * <code>JMSDestination,JMSDeliveryMode,JMSExpiration,
 * <code>JMSPriority,JMSMessageID and JMSTimeStamp.
 * When the message is published, the values of these headers are ignored.
 * After completion of the <CODE>publish, the headers hold the values
 * specified by the method publishing the message. It is possible for the
 * <CODE>publish method not to set JMSMessageID and
 * <code>JMSTimeStamp if the setting of these headers is explicitly
 * disabled by the <code>MessageProducer.setDisableMessageID or MessageProducer.setDisableMessageTimestamp
 * method.
 * <p/>
 * <P>
 * Creating a <CODE>MessageProducer provides the same features as
 * creating a <CODE>TopicPublisher. A MessageProducer
 * object is recommended when creating new code. The <CODE>TopicPublisher
 * </CODE> is provided to support existing code.
 * <p/>
 * <p/>
 * <P>
 * Because <CODE>TopicPublisher inherits from MessageProducer
 * </CODE>, it inherits the send methods that are a part of the
 * <CODE>MessageProducer interface. Using the send
 * methods will have the same effect as using the <CODE>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 <CODE>TopicPublisher.
     *
     * @return this publisher's topic
     * @throws JMSException if the JMS provider fails to get the topic for this
     *                      <CODE>TopicPublisher due to some internal error.
     */

    public Topic getTopic() throws JMSException {
        return (Topic) super.getDestination();
    }

    /**
     * Publishes a message to the topic. Uses the <CODE>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 <CODE>TopicPublisher
     *                                     </CODE> with an invalid topic.
     * @throws java.lang.UnsupportedOperationException
     *                                     if a client uses this method with a <CODE>TopicPublisher
     *                                     </CODE> that did not specify a topic at creation time.
     * @see javax.jms.MessageProducer#getDeliveryMode()
     * @see javax.jms.MessageProducer#getTimeToLive()
     * @see javax.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 <CODE>TopicPublisher
     *                                     </CODE> with an invalid topic.
     * @throws java.lang.UnsupportedOperationException
     *                                     if a client uses this method with a <CODE>TopicPublisher
     *                                     </CODE> 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 <CODE>TopicPublisher's default delivery mode,
     * priority, and time to live.
     * <p/>
     * <P>
     * 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 javax.jms.MessageProducer#getDeliveryMode()
     * @see javax.jms.MessageProducer#getTimeToLive()
     * @see javax.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.
     * <p/>
     * <P>
     * 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);
    }
}

Other ActiveMQ examples (source code examples)

Here is a short list of links related to this ActiveMQ ActiveMQTopicPublisher.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.