Interface QueueSession
- All Superinterfaces:
AutoCloseable,Runnable,Session
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:
createDurableSubscribercreateDurableConsumercreateSharedConsumercreateSharedDurableConsumercreateTemporaryTopiccreateTopicunsubscribe
- Since:
- JMS 1.0
- See Also:
-
Field Summary
Fields inherited from interface javax.jms.Session
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED -
Method Summary
Modifier and TypeMethodDescriptioncreateBrowser(Queue queue) Creates aQueueBrowserobject to peek at the messages on the specified queue.createBrowser(Queue queue, String messageSelector) Creates aQueueBrowserobject to peek at the messages on the specified queue using a message selector.createQueue(String queueName) Creates a queue identity given aQueuename.createReceiver(Queue queue) Creates aQueueReceiverobject to receive messages from the specified queue.createReceiver(Queue queue, String messageSelector) Creates aQueueReceiverobject to receive messages from the specified queue using a message selector.createSender(Queue queue) Creates aQueueSenderobject to send messages to the specified queue.Creates aTemporaryQueueobject.Methods inherited from interface javax.jms.Session
close, commit, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableConsumer, createDurableConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createSharedConsumer, createSharedConsumer, createSharedDurableConsumer, createSharedDurableConsumer, createStreamMessage, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, getTransacted, recover, rollback, run, setMessageListener, unsubscribe
-
Method Details
-
createQueue
Creates a queue identity given aQueuename.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
createTemporaryQueuemethod.- Specified by:
createQueuein interfaceSession- Parameters:
queueName- the name of thisQueue- Returns:
- a
Queuewith the given name - Throws:
JMSException- if the session fails to create a queue due to some internal error.
-
createReceiver
Creates aQueueReceiverobject to receive messages from the specified queue.- Parameters:
queue- theQueueto access- Throws:
JMSException- if the session fails to create a receiver due to some internal error.InvalidDestinationException- if an invalid queue is specified.
-
createReceiver
Creates aQueueReceiverobject to receive messages from the specified queue using a message selector.- Parameters:
queue- theQueueto accessmessageSelector- 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- if the session fails to create a receiver due to some internal error.InvalidDestinationException- if an invalid queue is specified.InvalidSelectorException- if the message selector is invalid.
-
createSender
Creates aQueueSenderobject to send messages to the specified queue.- Parameters:
queue- theQueueto access, or null if this is an unidentified producer- Throws:
JMSException- if the session fails to create a sender due to some internal error.InvalidDestinationException- if an invalid queue is specified.
-
createBrowser
Creates aQueueBrowserobject to peek at the messages on the specified queue.- Specified by:
createBrowserin interfaceSession- Parameters:
queue- theQueueto access- Throws:
JMSException- if the session fails to create a browser due to some internal error.InvalidDestinationException- if an invalid queue is specified.
-
createBrowser
Creates aQueueBrowserobject to peek at the messages on the specified queue using a message selector.- Specified by:
createBrowserin interfaceSession- Parameters:
queue- theQueueto accessmessageSelector- 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- if the session fails to create a browser due to some internal error.InvalidDestinationException- if an invalid queue is specified.InvalidSelectorException- if the message selector is invalid.
-
createTemporaryQueue
Creates aTemporaryQueueobject. Its lifetime will be that of theQueueConnectionunless it is deleted earlier.- Specified by:
createTemporaryQueuein interfaceSession- Returns:
- a temporary queue identity
- Throws:
JMSException- if the session fails to create a temporary queue due to some internal error.
-