/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2006, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package javax.jms;

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

 *
 *<P>Because <CODE>TopicPublisher</CODE> inherits from 
 * <CODE>MessageProducer</CODE>, it inherits the
 * <CODE>send</CODE> methods that are a part of the <CODE>MessageProducer</CODE> 
 * interface. Using the <CODE>send</CODE> methods will have the same
 * effect as using the
 * <CODE>publish</CODE> methods: they are functionally the same.
 * 
 * @see Session#createProducer(Destination) 
 * @see TopicSession#createPublisher(Topic)
 */

public interface TopicPublisher extends MessageProducer
{

   /** Gets the topic associated with this <CODE>TopicPublisher</CODE>.
    *
    * @return this publisher's topic
    *  
    * @exception JMSException if the JMS provider fails to get the topic for
    *                         this <CODE>TopicPublisher</CODE>
    *                         due to some internal error.
    */

   Topic getTopic() throws JMSException;

   /** Publishes a message to the topic.
    * Uses the <CODE>TopicPublisher</CODE>'s default delivery mode, priority,
    * and time to live.
    *
    * @param message the message to publish
    *
    * @exception JMSException if the JMS provider fails to publish the message
    *                         due to some internal error.
    * @exception MessageFormatException if an invalid message is specified.
    * @exception InvalidDestinationException if a client uses this method
    *                         with a <CODE>TopicPublisher</CODE> with
    *                         an invalid topic.
    * @exception 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()
    */

   void publish(Message message) throws JMSException;

   /** 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)
    *
    * @exception JMSException if the JMS provider fails to publish the message
    *                         due to some internal error.
    * @exception MessageFormatException if an invalid message is specified.
    * @exception InvalidDestinationException if a client uses this method
    *                         with a <CODE>TopicPublisher</CODE> with
    *                         an invalid topic.
    * @exception java.lang.UnsupportedOperationException if a client uses this
    *                         method with a <CODE>TopicPublisher</CODE> that
    *                         did not specify a topic at creation time.
    */

   void publish(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException;

   /** Publishes a message to a topic for an unidentified message producer. 
    * Uses the <CODE>TopicPublisher</CODE>'s default delivery mode, 
    * priority, and time to live.
    *  
    * <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
    *  
    * @exception JMSException if the JMS provider fails to publish the message
    *                         due to some internal error.
    * @exception MessageFormatException if an invalid message is specified.
    * @exception 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()
    */

   void publish(Topic topic, Message message) throws JMSException;

   /** Publishes a message to a topic for an unidentified message 
    * producer, specifying delivery mode, priority and time to live.
    *  
    * <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)
    *  
    * @exception JMSException if the JMS provider fails to publish the message
    *                         due to some internal error.
    * @exception MessageFormatException if an invalid message is specified.
    * @exception InvalidDestinationException if a client uses
    *                         this method with an invalid topic.
    */

   void publish(Topic topic, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException;
}
