Module jakarta.messaging

Package jakarta.jms

Interface Queue

All Superinterfaces:

Destination

All Known Subinterfaces:

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 Jakarta Messaging 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 Jakarta Messaging API.

Since:

JMS 1.0

Version:

Jakarta Messaging 2.0

See Also:

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

Method Summary

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

Method Details

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 Jakarta Messaging 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