javax::jms::QueueSession Class Reference

A QueueSession object provides methods for creating QueueReceiver, QueueSender, QueueBrowser, and TemporaryQueue objects. More...

#include <javax_jms_QueueSession.h>

Inheritance diagram for javax::jms::QueueSession:

[legend]Collaboration diagram for javax::jms::QueueSession:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::QueueSession >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::QueueSession > >	array2D
Public Member Functions
virtual ::javax::jms::QueueBrowser	createBrowser (const ::javax::jms::Queue &queue, const ::java::lang::String &messageSelector,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.
virtual ::javax::jms::QueueBrowser	createBrowser (const ::javax::jms::Queue &queue,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a QueueBrowser object to peek at the messages on the specified queue.
virtual ::javax::jms::Queue	createQueue (const ::java::lang::String &queueName,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a queue identity given a Queue name.
virtual ::javax::jms::QueueReceiver	createReceiver (const ::javax::jms::Queue &queue, const ::java::lang::String &messageSelector,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a QueueReceiver object to receive messages from the specified queue using a message selector.
virtual ::javax::jms::QueueReceiver	createReceiver (const ::javax::jms::Queue &queue,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a QueueReceiver object to receive messages from the specified queue.
virtual ::javax::jms::QueueSender	createSender (const ::javax::jms::Queue &queue,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a QueueSender object to send messages to the specified queue.
virtual ::javax::jms::TemporaryQueue	createTemporaryQueue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a TemporaryQueue object.

---

Detailed Description

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

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

virtual ::javax::jms::QueueBrowser javax::jms::QueueSession::createBrowser (  const ::javax::jms::Queue &  queue, const ::java::lang::String &  messageSelector, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a QueueBrowser object to peek at the messages on 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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from javax::jms::Session.

virtual ::javax::jms::QueueBrowser javax::jms::QueueSession::createBrowser (  const ::javax::jms::Queue &  queue, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a QueueBrowser object to peek at the messages on the specified queue. Parameters: queue  the Queue to access p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from javax::jms::Session.

virtual ::javax::jms::Queue javax::jms::QueueSession::createQueue (  const ::java::lang::String &  queueName, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: queueName  the name of this Queue p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Queue with the given name Reimplemented from javax::jms::Session.

virtual ::javax::jms::QueueReceiver javax::jms::QueueSession::createReceiver (  const ::javax::jms::Queue &  queue, const ::java::lang::String &  messageSelector, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::javax::jms::QueueReceiver javax::jms::QueueSession::createReceiver (  const ::javax::jms::Queue &  queue, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a QueueReceiver object to receive messages from the specified queue. Parameters: queue  the Queue to access p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::javax::jms::QueueSender javax::jms::QueueSession::createSender (  const ::javax::jms::Queue &  queue, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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 p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::javax::jms::TemporaryQueue javax::jms::QueueSession::createTemporaryQueue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a TemporaryQueue object. Its lifetime will be that of the QueueConnection unless it is deleted earlier. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a temporary queue identity Reimplemented from javax::jms::Session.

---

The documentation for this class was generated from the following file:

• javax_jms_QueueSession.h

---