public interface QueueSession extends 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
:
createDurableSubscriber
createDurableConsumer
createSharedConsumer
createSharedDurableConsumer
createTemporaryTopic
createTopic
unsubscribe
Session
,
QueueConnection.createQueueSession(boolean, int)
,
XAQueueSession.getQueueSession()
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED
Modifier and Type | Method and Description |
---|---|
QueueBrowser |
createBrowser(Queue queue)
Creates a
QueueBrowser object to peek at the messages on the specified queue. |
QueueBrowser |
createBrowser(Queue queue,
java.lang.String messageSelector)
Creates a
QueueBrowser object to peek at the messages on the specified queue using a message selector. |
Queue |
createQueue(java.lang.String queueName)
Creates a queue identity given a
Queue name. |
QueueReceiver |
createReceiver(Queue queue)
Creates a
QueueReceiver object to receive messages from the specified queue. |
QueueReceiver |
createReceiver(Queue queue,
java.lang.String messageSelector)
Creates a
QueueReceiver object to receive messages from the specified queue using a message selector. |
QueueSender |
createSender(Queue queue)
Creates a
QueueSender object to send messages to the specified queue. |
TemporaryQueue |
createTemporaryQueue()
Creates a
TemporaryQueue object. |
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
Queue createQueue(java.lang.String queueName) throws JMSException
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 Jakarta Messaging API. The one exception is the creation of temporary queues, which is
accomplished with the createTemporaryQueue
method.
createQueue
in interface Session
queueName
- the name of this Queue
Queue
with the given nameJMSException
- if the session fails to create a queue due to some internal error.QueueReceiver createReceiver(Queue queue) throws JMSException
QueueReceiver
object to receive messages from the specified queue.queue
- the Queue
to accessQueueReceiver
object to receive messages from the specified queueJMSException
- if the session fails to create a receiver due to some internal error.InvalidDestinationException
- if an invalid queue is specified.QueueReceiver createReceiver(Queue queue, java.lang.String messageSelector) throws JMSException
QueueReceiver
object to receive messages from the specified queue using a message selector.queue
- the Queue
to 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.QueueReceiver
object to receive messages from the specified queueJMSException
- 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.QueueSender createSender(Queue queue) throws JMSException
QueueSender
object to send messages to the specified queue.queue
- the Queue
to access, or null if this is an unidentified producerQueueSender
object to send messages to the specified queue.JMSException
- if the session fails to create a sender due to some internal error.InvalidDestinationException
- if an invalid queue is specified.QueueBrowser createBrowser(Queue queue) throws JMSException
QueueBrowser
object to peek at the messages on the specified queue.createBrowser
in interface Session
queue
- the Queue
to accessQueueBrowser
object to peek at the messages.JMSException
- if the session fails to create a browser due to some internal error.InvalidDestinationException
- if an invalid queue is specified.QueueBrowser createBrowser(Queue queue, java.lang.String messageSelector) throws JMSException
QueueBrowser
object to peek at the messages on the specified queue using a message selector.createBrowser
in interface Session
queue
- the Queue
to 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.QueueBrowser
object to peek at the messages on the specified queue.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.TemporaryQueue createTemporaryQueue() throws JMSException
TemporaryQueue
object. Its lifetime will be that of the QueueConnection
unless it is
deleted earlier.createTemporaryQueue
in interface Session
JMSException
- if the session fails to create a temporary queue due to some internal error.