QueueSender.java

/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License).  You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the license at
 * https://glassfish.dev.java.net/public/CDDLv1.0.html or
 * glassfish/bootstrap/legal/CDDLv1.0.txt.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at glassfish/bootstrap/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 */

package javax.jms;

/** A client uses a <CODE>QueueSender</CODE> object to send messages to a queue.
 *
 * <P>Normally, the <CODE>Queue</CODE> is specified when a
 * <CODE>QueueSender</CODE> is created.  In this case, an attempt to use
 * the <CODE>send</CODE> methods for an unidentified
 * <CODE>QueueSender</CODE> will throw a
 * <CODE>java.lang.UnsupportedOperationException</CODE>.
 *
 * <P>If the <CODE>QueueSender</CODE> is created with an unidentified
 * <CODE>Queue</CODE>, an attempt to use the <CODE>send</CODE> methods that
 * assume that the <CODE>Queue</CODE> has been identified will throw a
 * <CODE>java.lang.UnsupportedOperationException</CODE>.
 *
 * <P>During the execution of its <CODE>send</CODE> method, a message
 * must not be changed by other threads within the client.
 * If the message is modified, the result of the <CODE>send</CODE> is
 * undefined.
 *
 * <P>After sending a message, a client may retain and modify it
 * without affecting the message that has been sent. The same message
 * object may be sent multiple times.
 *
 * <P>The following message headers are set as part of sending 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 sent, the values of these headers are ignored.
 * After the completion of the <CODE>send</CODE>, the headers hold the values
 * specified by the method sending the message. It is possible for the
 * <code>send</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>QueueSender</CODE>. A <CODE>MessageProducer</CODE> object is
 * recommended when creating new code. The  <CODE>QueueSender</CODE> is
 * provided to support existing code.
 *
 *
 * @version     1.1 - February 2, 2002
 * @author      Mark Hapner
 * @author      Rich Burridge
 * @author      Kate Stout
 *
 * @see         javax.jms.MessageProducer
 * @see         javax.jms.Session#createProducer(Destination)
 * @see         javax.jms.QueueSession#createSender(Queue)
 */

public interface QueueSender extends MessageProducer
{

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

  Queue getQueue() throws JMSException;

  /** Sends a message to the queue. Uses the <CODE>QueueSender</CODE>'s
    * default delivery mode, priority, and time to live.
    *
    * @param message the message to send
    *
    * @exception JMSException if the JMS provider fails to send 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>QueueSender</CODE> with
    *                         an invalid queue.
    * @exception java.lang.UnsupportedOperationException if a client uses this
    *                         method with a <CODE>QueueSender</CODE> that did
    *                         not specify a queue at creation time.
    *
    * @see javax.jms.MessageProducer#getDeliveryMode()
    * @see javax.jms.MessageProducer#getTimeToLive()
    * @see javax.jms.MessageProducer#getPriority()
    */

  void send(Message message) throws JMSException;

  /** Sends a message to the queue, specifying delivery mode, priority, and
    * time to live.
    *
    * @param message the message to send
    * @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 send 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>QueueSender</CODE> with
    *                         an invalid queue.
    * @exception java.lang.UnsupportedOperationException if a client uses this
    *                         method with a <CODE>QueueSender</CODE> that did
    *                         not specify a queue at creation time.
    */

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

  /** Sends a message to a queue for an unidentified message producer.
    * Uses the <CODE>QueueSender</CODE>'s default delivery mode, priority,
    * and time to live.
    *
    * <P>Typically, a message producer is assigned a queue at creation
    * time; however, the JMS API also supports unidentified message producers,
    * which require that the queue be supplied every time a message is
    * sent.
    *
    * @param queue the queue to send this message to
    * @param message the message to send
    *
    * @exception JMSException if the JMS provider fails to send 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 queue.
    *
    * @see javax.jms.MessageProducer#getDeliveryMode()
    * @see javax.jms.MessageProducer#getTimeToLive()
    * @see javax.jms.MessageProducer#getPriority()
    */

  void send(Queue queue, Message message) throws JMSException;

  /** Sends a message to a queue for an unidentified message producer,
    * specifying delivery mode, priority and time to live.
    *
    * <P>Typically, a message producer is assigned a queue at creation
    * time; however, the JMS API also supports unidentified message producers,
    * which require that the queue be supplied every time a message is
    * sent.
    *
    * @param queue the queue to send this message to
    * @param message the message to send
    * @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 send 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 queue.
    */

  void send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException;
}