/*
* 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 QueueSession
object provides methods for creating
* QueueReceiver
, QueueSender
,
* QueueBrowser
, and TemporaryQueue
objects.
*
*
If there are messages that have been received but not acknowledged
* when a QueueSession
terminates, these messages will be retained
* and redelivered when a consumer next accesses the queue.
*
*
A QueueSession
is used for creating Point-to-Point specific
* objects. In general, use the Session
object.
* The QueueSession
is used to support
* existing code. Using the Session
object simplifies the
* programming model, and allows transactions to be used across the two
* messaging domains.
*
*
A QueueSession
cannot be used to create objects specific to the
* publish/subscribe domain. The following methods inherit from
* Session
, but must throw an
* IllegalStateException
* if they are used from QueueSession
:
*
createDurableSubscriber
* createTemporaryTopic
* createTopic
* unsubscribe
* Queue
name.
*
* This facility is provided for the rare cases where clients need to * dynamically manipulate queue identity. It allows the creation of a * queue identity with a provider-specific name. Clients that depend * on this ability are not portable. * *
Note that this method is not for creating the physical queue.
* The physical creation of queues is an administrative task and is not
* to be initiated by the JMS API. The one exception is the
* creation of temporary queues, which is accomplished with the
* createTemporaryQueue
method.
*
* @param queueName the name of this Queue
*
* @return a Queue
with the given name
*
* @exception JMSException if the session fails to create a queue
* due to some internal error.
*/
Queue createQueue(String queueName) throws JMSException;
/** Creates a QueueReceiver
object to receive messages from the
* specified queue.
*
* @param queue the Queue
to access
*
* @exception JMSException if the session fails to create a receiver
* due to some internal error.
* @exception InvalidDestinationException if an invalid queue is specified.
*/
QueueReceiver createReceiver(Queue queue) throws JMSException;
/** Creates a QueueReceiver
object to receive messages from the
* specified queue using a message selector.
*
* @param queue the Queue
to access
* @param messageSelector only messages with properties matching the
* message selector expression are delivered. A value of null or
* an empty string indicates that there is no message selector
* for the message consumer.
*
* @exception JMSException if the session fails to create a receiver
* due to some internal error.
* @exception InvalidDestinationException if an invalid queue is specified.
* @exception InvalidSelectorException if the message selector is invalid.
*
*/
QueueReceiver createReceiver(Queue queue, String messageSelector) throws JMSException;
/** Creates a QueueSender
object to send messages to the
* specified queue.
*
* @param queue the Queue
to access, or null if this is an
* unidentified producer
*
* @exception JMSException if the session fails to create a sender
* due to some internal error.
* @exception InvalidDestinationException if an invalid queue is specified.
*/
QueueSender createSender(Queue queue) throws JMSException;
/** Creates a QueueBrowser
object to peek at the messages on
* the specified queue.
*
* @param queue the Queue
to access
*
* @exception JMSException if the session fails to create a browser
* due to some internal error.
* @exception InvalidDestinationException if an invalid queue is specified.
*/
QueueBrowser createBrowser(Queue queue) throws JMSException;
/** Creates a QueueBrowser
object to peek at the messages on
* the specified queue using a message selector.
*
* @param queue the Queue
to access
* @param messageSelector only messages with properties matching the
* message selector expression are delivered. A value of null or
* an empty string indicates that there is no message selector
* for the message consumer.
*
* @exception JMSException if the session fails to create a browser
* due to some internal error.
* @exception InvalidDestinationException if an invalid queue is specified.
* @exception InvalidSelectorException if the message selector is invalid.
*/
QueueBrowser createBrowser(Queue queue, String messageSelector) throws JMSException;
/** Creates a TemporaryQueue
object. Its lifetime will be that
* of the QueueConnection
unless it is deleted earlier.
*
* @return a temporary queue identity
*
* @exception JMSException if the session fails to create a temporary queue
* due to some internal error.
*/
TemporaryQueue createTemporaryQueue() throws JMSException;
}