javax.jms

Interface Queue

All Superinterfaces:

Destination

All Known Subinterfaces:

SolQueue, TemporaryQueue

public interface Queue
extends Destination

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.

Solace Queue Names

Generally, a Queue name represents a hierarchy of levels, separated by slashes. Queues are used by producers for publishing to, or by consumers to receive from.
The following rules define valid Queue names (using the EBNF syntax from http://www.w3.org/TR/REC-xml/#sec-notation):

 
 slash       ::= "/"
 level-char  ::= any UTF-8 character except ['<>*&]
 level       ::= level-char (level-char)* 
 queue       ::= level (slash level)*
 1 <= length (queue) <= 250
 
 

Example: enterprise-1/branch-15/frontdesk

Version:

1.1 February 2 - 2000

See Also:

Session.createConsumer(Destination), Session.createProducer(Destination), Session.createQueue(String), QueueSession.createQueue(String)

Method Summary

Modifier and Type	Method and Description
String	getQueueName() Gets the name of this queue.
String	toString() Returns a string representation of this object.

Method Detail

getQueueName

String getQueueName()
             throws JMSException

Gets the name of this queue.

Clients that depend upon the name are not portable.

Returns:

the queue name

Throws:

JMSException - if the JMS provider implementation of Queue fails to return the queue name due to some internal error.

toString

String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

the provider-specific identity values for this queue