javax.jms.Queue Maven / Gradle / Ivy
/*
* @(#)Queue.java 1.16 02/04/09
*
* Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
*
* SUN PROPRIETARY/CONFIDENTIAL.
* This software is the proprietary information of Sun Microsystems, Inc.
* Use is subject to license terms.
*
*/
package javax.jms;
/** A Queue object encapsulates a provider-specific queue name.
* It is the way a client specifies the identity of a queue to JMS API methods.
* For those methods that use a Destination as a parameter, a
* Queue object used as an argument. For example, a queue can
* be used to create a MessageConsumer and a
* MessageProducer by calling:
*
*-
Session.CreateConsumer(Destination destination)
* -
Session.CreateProducer(Destination destination)
*
*
*
* The actual length of time messages are held by a queue and the
* consequences of resource overflow are not defined by the JMS API.
*
*
*
* @version 1.1 February 2 - 2000
* @author Mark Hapner
* @author Rich Burridge
* @author Kate Stout
*
* @see Session#createConsumer(Destination)
* @see Session#createProducer(Destination)
* @see Session#createQueue(String)
* @see QueueSession#createQueue(String)
*/
public interface Queue extends Destination {
/** Gets the name of this queue.
*
*
Clients that depend upon the name are not portable.
*
* @return the queue name
*
* @exception JMSException if the JMS provider implementation of
* Queue fails to return the queue
* name due to some internal
* error.
*/
String
getQueueName() throws JMSException;
/** Returns a string representation of this object.
*
* @return the provider-specific identity values for this queue
*/
String
toString();
}