javax.jms.QueueSender Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.jms;
/** A client uses a {@code QueueSender} object to send messages to a queue.
*
* Normally, the {@code Queue} is specified when a
* {@code QueueSender} is created. In this case, an attempt to use
* the {@code send} methods for an unidentified
* {@code QueueSender} will throw a
* {@code java.lang.UnsupportedOperationException}.
*
*
If the {@code QueueSender} is created with an unidentified
* {@code Queue}, an attempt to use the {@code send} methods that
* assume that the {@code Queue} has been identified will throw a
* {@code java.lang.UnsupportedOperationException}.
*
*
During the execution of its {@code send} method, a message
* must not be changed by other threads within the client.
* If the message is modified, the result of the {@code send} is
* undefined.
*
*
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.
*
*
The following message headers are set as part of sending a
* message: {@code JMSDestination}, {@code JMSDeliveryMode},
* {@code JMSExpiration}, {@code JMSPriority},
* {@code JMSMessageID} and {@code JMSTimeStamp}.
* When the message is sent, the values of these headers are ignored.
* After the completion of the {@code send}, the headers hold the values
* specified by the method sending the message. It is possible for the
* {@code send} method not to set {@code JMSMessageID} and
* {@code JMSTimeStamp} if the
* setting of these headers is explicitly disabled by the
* {@code MessageProducer.setDisableMessageID} or
* {@code MessageProducer.setDisableMessageTimestamp} method.
*
*
Creating a {@code MessageProducer} provides the same features as
* creating a {@code QueueSender}. A {@code MessageProducer} object is
* recommended when creating new code. The {@code QueueSender} is
* provided to support existing code.
*
* @see javax.jms.MessageProducer
* @see javax.jms.Session#createProducer(Destination)
* @see javax.jms.QueueSession#createSender(Queue)
*
* @version JMS 2.0
* @since JMS 1.0
*
*/
public interface QueueSender extends MessageProducer {
/** Gets the queue associated with this {@code QueueSender}.
*
* @return this sender's queue
*
* @exception JMSException if the JMS provider fails to get the queue for
* this {@code QueueSender}
* due to some internal error.
*/
Queue
getQueue() throws JMSException;
/** Sends a message to the queue. Uses the {@code QueueSender}'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} with
* an invalid queue.
* @exception java.lang.UnsupportedOperationException if a client uses this
* method with a {@code QueueSender} 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} with
* an invalid queue.
* @exception java.lang.UnsupportedOperationException if a client uses this
* method with a {@code QueueSender} 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}'s default delivery mode, priority,
* and time to live.
*
*
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.
*
*
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;
}