QueueSession

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface QueueSession

All Superinterfaces:: java.lang.Runnable, Session (src)

All Known Implementing Classes:: JBossSession (src) , JmsSession (src) , SpyQueueSession (src)

public interface QueueSession
extends Session (src)

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

See Also:: Session (src) , QueueConnection.createQueueSession(boolean, int), XAQueueSession.getQueueSession()

Field Summary

Fields inherited from interface javax.jms.Session (src)

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Method Summary
`QueueBrowser (src)`	`createBrowser(Queue (src) queue)` Creates a `QueueBrowser` object to peek at the messages on the specified queue.
`QueueBrowser (src)`	`createBrowser(Queue (src) queue, java.lang.String messageSelector)` Creates a `QueueBrowser` object to peek at the messages on the specified queue using a message selector.
`Queue (src)`	`createQueue(java.lang.String queueName)` Creates a queue identity given a `Queue` name.
`QueueReceiver (src)`	`createReceiver(Queue (src) queue)` Creates a `QueueReceiver` object to receive messages from the specified queue.
`QueueReceiver (src)`	`createReceiver(Queue (src) queue, java.lang.String messageSelector)` Creates a `QueueReceiver` object to receive messages from the specified queue using a message selector.
`QueueSender (src)`	`createSender(Queue (src) queue)` Creates a `QueueSender` object to send messages to the specified queue.
`TemporaryQueue (src)`	`createTemporaryQueue()` Creates a `TemporaryQueue` object.

Methods inherited from interface javax.jms.Session (src)

close, commit, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createStreamMessage, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, getTransacted, recover, rollback, run, setMessageListener, unsubscribe

Method Detail

createQueue

public Queue (src)  createQueue(java.lang.String queueName)
                  throws JMSException (src)

Creates a queue identity given a 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.

Specified by:: createQueue in interface Session (src)

Parameters:: queueName - the name of this Queue
Returns:: a Queue with the given name
Throws:: JMSException (src) - if the session fails to create a queue due to some internal error.

createReceiver

public QueueReceiver (src)  createReceiver(Queue (src)  queue)
                             throws JMSException (src)

Creates a QueueReceiver object to receive messages from the specified queue.

Parameters:: queue - the Queue to access
Throws:: JMSException (src) - if the session fails to create a receiver due to some internal error.; InvalidDestinationException (src) - if an invalid queue is specified.

createReceiver

public QueueReceiver (src)  createReceiver(Queue (src)  queue,
                                    java.lang.String messageSelector)
                             throws JMSException (src)

Creates a QueueReceiver object to receive messages from the specified queue using a message selector.

Parameters:: queue - the Queue to access; 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.
Throws:: JMSException (src) - if the session fails to create a receiver due to some internal error.; InvalidDestinationException (src) - if an invalid queue is specified.; InvalidSelectorException (src) - if the message selector is invalid.

createSender

public QueueSender (src)  createSender(Queue (src)  queue)
                         throws JMSException (src)

Creates a QueueSender object to send messages to the specified queue.

Parameters:: queue - the Queue to access, or null if this is an unidentified producer
Throws:: JMSException (src) - if the session fails to create a sender due to some internal error.; InvalidDestinationException (src) - if an invalid queue is specified.

createBrowser

public QueueBrowser (src)  createBrowser(Queue (src)  queue)
                           throws JMSException (src)

Creates a QueueBrowser object to peek at the messages on the specified queue.

Specified by:: createBrowser in interface Session (src)

Parameters:: queue - the Queue to access
Throws:: JMSException (src) - if the session fails to create a browser due to some internal error.; InvalidDestinationException (src) - if an invalid queue is specified.

createBrowser

public QueueBrowser (src)  createBrowser(Queue (src)  queue,
                                  java.lang.String messageSelector)
                           throws JMSException (src)

Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.

Specified by:: createBrowser in interface Session (src)

Parameters:: queue - the Queue to access; 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.
Throws:: JMSException (src) - if the session fails to create a browser due to some internal error.; InvalidDestinationException (src) - if an invalid queue is specified.; InvalidSelectorException (src) - if the message selector is invalid.

createTemporaryQueue

public TemporaryQueue (src)  createTemporaryQueue()
                                    throws JMSException (src)

Creates a TemporaryQueue object. Its lifetime will be that of the QueueConnection unless it is deleted earlier.

Specified by:: createTemporaryQueue in interface Session (src)

Returns:: a temporary queue identity
Throws:: JMSException (src) - if the session fails to create a temporary queue due to some internal error.