public class HornetQSession extends Object implements Session, QueueSession, TopicSession
Modifier and Type | Field and Description |
---|---|
static int |
TYPE_GENERIC_SESSION |
static int |
TYPE_QUEUE_SESSION |
static int |
TYPE_TOPIC_SESSION |
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED
Modifier | Constructor and Description |
---|---|
protected |
HornetQSession(HornetQConnection connection,
boolean transacted,
boolean xa,
int ackMode,
ClientSession session,
int sessionType) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the session.
|
void |
commit()
Commits all messages done in this transaction and releases any locks
currently held.
|
QueueBrowser |
createBrowser(Queue queue)
Creates a
QueueBrowser object to peek at the messages on
the specified queue. |
QueueBrowser |
createBrowser(Queue queue,
String filterString)
Creates a
QueueBrowser object to peek at the messages on
the specified queue using a message selector. |
BytesMessage |
createBytesMessage()
Creates a
BytesMessage object. |
MessageConsumer |
createConsumer(Destination destination)
Creates a
MessageConsumer for the specified destination. |
MessageConsumer |
createConsumer(Destination destination,
String messageSelector)
Creates a
MessageConsumer for the specified destination,
using a message selector. |
MessageConsumer |
createConsumer(Destination destination,
String messageSelector,
boolean noLocal)
Creates
MessageConsumer for the specified destination, using a
message selector. |
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name)
Creates a durable subscriber to the specified topic.
|
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name,
String messageSelector,
boolean noLocal)
Creates a durable subscriber to the specified topic, using a
message selector and specifying whether messages published by its
own connection should be delivered to it.
|
MapMessage |
createMapMessage()
Creates a
MapMessage object. |
Message |
createMessage()
Creates a
Message object. |
ObjectMessage |
createObjectMessage()
Creates an
ObjectMessage object. |
ObjectMessage |
createObjectMessage(Serializable object)
Creates an initialized
ObjectMessage object. |
MessageProducer |
createProducer(Destination destination)
Creates a
MessageProducer to send messages to the specified
destination. |
TopicPublisher |
createPublisher(Topic topic)
Creates a publisher for the specified topic.
|
Queue |
createQueue(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,
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. |
StreamMessage |
createStreamMessage()
Creates a
StreamMessage object. |
TopicSubscriber |
createSubscriber(Topic topic)
Creates a nondurable subscriber to the specified topic.
|
TopicSubscriber |
createSubscriber(Topic topic,
String messageSelector,
boolean noLocal)
Creates a nondurable subscriber to the specified topic, using a
message selector or specifying whether messages published by its
own connection should be delivered to it.
|
TemporaryQueue |
createTemporaryQueue()
Creates a
TemporaryQueue object. |
TemporaryTopic |
createTemporaryTopic()
Creates a
TemporaryTopic object. |
TextMessage |
createTextMessage()
Creates a
TextMessage object. |
TextMessage |
createTextMessage(String text)
Creates an initialized
TextMessage object. |
Topic |
createTopic(String topicName)
Creates a topic identity given a
Topic name. |
void |
deleteTemporaryQueue(HornetQDestination tempQueue) |
void |
deleteTemporaryTopic(HornetQDestination tempTopic) |
int |
getAcknowledgeMode()
Returns the acknowledgement mode of the session.
|
ClientSession |
getCoreSession() |
MessageListener |
getMessageListener()
Returns the session's distinguished message listener (optional).
|
QueueSession |
getQueueSession() |
Session |
getSession() |
TopicSession |
getTopicSession() |
boolean |
getTransacted()
Indicates whether the session is in transacted mode.
|
XAResource |
getXAResource() |
boolean |
isRecoverCalled() |
boolean |
isXA() |
void |
recover()
Stops message delivery in this session, and restarts message delivery
with the oldest unacknowledged message.
|
void |
removeConsumer(HornetQMessageConsumer consumer) |
void |
rollback()
Rolls back any messages done in this transaction and releases any locks
currently held.
|
void |
run()
Optional operation, intended to be used only by Application Servers,
not by ordinary JMS clients.
|
void |
setMessageListener(MessageListener listener)
Sets the session's distinguished message listener (optional).
|
void |
setRecoverCalled(boolean recoverCalled) |
void |
start() |
void |
stop() |
String |
toString() |
void |
unsubscribe(String name)
Unsubscribes a durable subscription that has been created by a client.
|
public static final int TYPE_GENERIC_SESSION
public static final int TYPE_QUEUE_SESSION
public static final int TYPE_TOPIC_SESSION
protected HornetQSession(HornetQConnection connection, boolean transacted, boolean xa, int ackMode, ClientSession session, int sessionType)
public BytesMessage createBytesMessage() throws JMSException
Session
BytesMessage
object. A BytesMessage
object is used to send a message containing a stream of uninterpreted
bytes.createBytesMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public MapMessage createMapMessage() throws JMSException
Session
MapMessage
object. A MapMessage
object is used to send a self-defining set of name-value pairs, where
names are String
objects and values are primitive values
in the Java programming language.createMapMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public Message createMessage() throws JMSException
Session
Message
object. The Message
interface is the root interface of all JMS messages. A
Message
object holds all the
standard message header information. It can be sent when a message
containing only header information is sufficient.createMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public ObjectMessage createObjectMessage() throws JMSException
Session
ObjectMessage
object. An
ObjectMessage
object is used to send a message
that contains a serializable Java object.createObjectMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public ObjectMessage createObjectMessage(Serializable object) throws JMSException
Session
ObjectMessage
object. An
ObjectMessage
object is used
to send a message that contains a serializable Java object.createObjectMessage
in interface Session
object
- the object to use to initialize this messageJMSException
- if the JMS provider fails to create this message
due to some internal error.public StreamMessage createStreamMessage() throws JMSException
Session
StreamMessage
object. A
StreamMessage
object is used to send a
self-defining stream of primitive values in the Java programming
language.createStreamMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public TextMessage createTextMessage() throws JMSException
Session
TextMessage
object. A TextMessage
object is used to send a message containing a String
object.createTextMessage
in interface Session
JMSException
- if the JMS provider fails to create this message
due to some internal error.public TextMessage createTextMessage(String text) throws JMSException
Session
TextMessage
object. A
TextMessage
object is used to send
a message containing a String
.createTextMessage
in interface Session
text
- the string used to initialize this messageJMSException
- if the JMS provider fails to create this message
due to some internal error.public boolean getTransacted() throws JMSException
Session
getTransacted
in interface Session
JMSException
- if the JMS provider fails to return the
transaction mode due to some internal error.public int getAcknowledgeMode() throws JMSException
Session
getAcknowledgeMode
in interface Session
JMSException
- if the JMS provider fails to return the
acknowledgment mode due to some internal error.Connection.createSession(boolean, int)
public boolean isXA()
public void commit() throws JMSException
Session
commit
in interface Session
JMSException
- if the JMS provider fails to commit the
transaction due to some internal error.TransactionRolledBackException
- if the transaction
is rolled back due to some internal error
during commit.IllegalStateException
- if the method is not called by a
transacted session.public void rollback() throws JMSException
Session
rollback
in interface Session
JMSException
- if the JMS provider fails to roll back the
transaction due to some internal error.IllegalStateException
- if the method is not called by a
transacted session.public void close() throws JMSException
Session
Since a provider may allocate some resources on behalf of a session outside the JVM, clients should close the resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.
There is no need to close the producers and consumers of a closed session.
This call will block until a receive
call or message
listener in progress has completed. A blocked message consumer
receive
call returns null
when this session
is closed.
Closing a transacted session must roll back the transaction in progress.
This method is the only Session
method that can
be called concurrently.
Invoking any other Session
method on a closed session
must throw a JMSException.IllegalStateException
. Closing a
closed session must not throw an exception.
close
in interface Session
JMSException
- if the JMS provider fails to close the
session due to some internal error.public void recover() throws JMSException
Session
All consumers deliver messages in a serial order. Acknowledging a received message automatically acknowledges all messages that have been delivered to the client.
Restarting a session causes it to take the following actions:
recover
in interface Session
JMSException
- if the JMS provider fails to stop and restart
message delivery due to some internal error.IllegalStateException
- if the method is called by a
transacted session.public MessageListener getMessageListener() throws JMSException
Session
getMessageListener
in interface Session
JMSException
- if the JMS provider fails to get the message
listener due to an internal error.Session.setMessageListener(javax.jms.MessageListener)
,
ServerSessionPool
,
ServerSession
public void setMessageListener(MessageListener listener) throws JMSException
Session
When the distinguished message listener is set, no other form of message receipt in the session can be used; however, all forms of sending messages are still supported.
This is an expert facility not used by regular JMS clients.
setMessageListener
in interface Session
listener
- the message listener to associate with this sessionJMSException
- if the JMS provider fails to set the message
listener due to an internal error.Session.getMessageListener()
,
ServerSessionPool
,
ServerSession
public void run()
Session
run
in interface Runnable
run
in interface Session
ServerSession
public MessageProducer createProducer(Destination destination) throws JMSException
Session
MessageProducer
to send messages to the specified
destination.
A client uses a MessageProducer
object to send
messages to a destination. Since Queue
and Topic
both inherit from Destination
, they can be used in
the destination parameter to create a MessageProducer
object.
createProducer
in interface Session
destination
- the Destination
to send to,
or null if this is a producer which does not have a specified
destination.JMSException
- if the session fails to create a MessageProducer
due to some internal error.InvalidDestinationException
- if an invalid destination
is specified.public MessageConsumer createConsumer(Destination destination) throws JMSException
Session
MessageConsumer
for the specified destination.
Since Queue
and Topic
both inherit from Destination
, they can be used in
the destination parameter to create a MessageConsumer
.createConsumer
in interface Session
destination
- the Destination
to access.JMSException
- if the session fails to create a consumer
due to some internal error.InvalidDestinationException
- if an invalid destination
is specified.public MessageConsumer createConsumer(Destination destination, String messageSelector) throws JMSException
Session
MessageConsumer
for the specified destination,
using a message selector.
Since Queue
and Topic
both inherit from Destination
, they can be used in
the destination parameter to create a MessageConsumer
.
A client uses a MessageConsumer
object to receive
messages that have been sent to a destination.
createConsumer
in interface Session
destination
- the Destination
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.JMSException
- if the session fails to create a MessageConsumer
due to some internal error.InvalidDestinationException
- if an invalid destination
is specified.InvalidSelectorException
- if the message selector is invalid.public MessageConsumer createConsumer(Destination destination, String messageSelector, boolean noLocal) throws JMSException
Session
MessageConsumer
for the specified destination, using a
message selector. This method can specify whether messages published by
its own connection should be delivered to it, if the destination is a
topic.
Since Queue
and Topic
both inherit from Destination
, they can be used in
the destination parameter to create a MessageConsumer
.
A client uses a MessageConsumer
object to receive
messages that have been published to a destination.
In some cases, a connection may both publish and subscribe to a
topic. The consumer NoLocal
attribute allows a consumer
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is False. The noLocal
value must be supported by destinations that are topics.
createConsumer
in interface Session
destination
- the Destination
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.noLocal
- - if true, and the destination is a topic,
inhibits the delivery of messages published
by its own connection. The behavior for
NoLocal
is
not specified if the destination is a queue.JMSException
- if the session fails to create a MessageConsumer
due to some internal error.InvalidDestinationException
- if an invalid destination
is specified.InvalidSelectorException
- if the message selector is invalid.public Queue createQueue(String queueName) throws JMSException
Session
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.
createQueue
in interface QueueSession
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.public Topic createTopic(String topicName) throws JMSException
Session
Topic
name.
This facility is provided for the rare cases where clients need to dynamically manipulate topic identity. This allows the creation of a topic 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 topic.
The physical creation of topics is an administrative task and is not
to be initiated by the JMS API. The one exception is the
creation of temporary topics, which is accomplished with the
createTemporaryTopic
method.
createTopic
in interface Session
createTopic
in interface TopicSession
topicName
- the name of this Topic
Topic
with the given nameJMSException
- if the session fails to create a topic
due to some internal error.public TopicSubscriber createDurableSubscriber(Topic topic, String name) throws JMSException
Session
If a client needs to receive all the messages published on a
topic, including the ones published while the subscriber is inactive,
it uses a durable TopicSubscriber
. The JMS provider
retains a record of this
durable subscription and insures that all messages from the topic's
publishers are retained until they are acknowledged by this
durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same
client identifier. In addition, each client must specify a name that
uniquely identifies (within client identifier) each durable
subscription it creates. Only one session at a time can have a
TopicSubscriber
for a particular durable subscription.
A client can change an existing durable subscription by creating
a durable TopicSubscriber
with the same name and a new
topic and/or
message selector. Changing a durable subscriber is equivalent to
unsubscribing (deleting) the old one and creating a new one.
In some cases, a connection may both publish and subscribe to a
topic. The subscriber NoLocal
attribute allows a subscriber
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is false.
createDurableSubscriber
in interface Session
createDurableSubscriber
in interface TopicSession
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionJMSException
- if the session fails to create a subscriber
due to some internal error.InvalidDestinationException
- if an invalid topic is specified.public TopicSubscriber createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException
Session
If a client needs to receive all the messages published on a
topic, including the ones published while the subscriber is inactive,
it uses a durable TopicSubscriber
. The JMS provider
retains a record of this
durable subscription and insures that all messages from the topic's
publishers are retained until they are acknowledged by this
durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same
client identifier. In addition, each client must specify a name which
uniquely identifies (within client identifier) each durable
subscription it creates. Only one session at a time can have a
TopicSubscriber
for a particular durable subscription.
An inactive durable subscriber is one that exists but
does not currently have a message consumer associated with it.
A client can change an existing durable subscription by creating
a durable TopicSubscriber
with the same name and a new
topic and/or
message selector. Changing a durable subscriber is equivalent to
unsubscribing (deleting) the old one and creating a new one.
createDurableSubscriber
in interface Session
createDurableSubscriber
in interface TopicSession
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionmessageSelector
- 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.noLocal
- if set, inhibits the delivery of messages published
by its own connectionJMSException
- if the session fails to create a subscriber
due to some internal error.InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.public QueueBrowser createBrowser(Queue queue) throws JMSException
Session
QueueBrowser
object to peek at the messages on
the specified queue.createBrowser
in interface QueueSession
createBrowser
in interface Session
queue
- the queue
to accessJMSException
- if the session fails to create a browser
due to some internal error.InvalidDestinationException
- if an invalid destination
is specifiedpublic QueueBrowser createBrowser(Queue queue, String filterString) throws JMSException
Session
QueueBrowser
object to peek at the messages on
the specified queue using a message selector.createBrowser
in interface QueueSession
createBrowser
in interface Session
queue
- the queue
to accessfilterString
- 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.JMSException
- if the session fails to create a browser
due to some internal error.InvalidDestinationException
- if an invalid destination
is specifiedInvalidSelectorException
- if the message selector is invalid.public TemporaryQueue createTemporaryQueue() throws JMSException
Session
TemporaryQueue
object. Its lifetime will be that
of the Connection
unless it is deleted earlier.createTemporaryQueue
in interface QueueSession
createTemporaryQueue
in interface Session
JMSException
- if the session fails to create a temporary queue
due to some internal error.public TemporaryTopic createTemporaryTopic() throws JMSException
Session
TemporaryTopic
object. Its lifetime will be that
of the Connection
unless it is deleted earlier.createTemporaryTopic
in interface Session
createTemporaryTopic
in interface TopicSession
JMSException
- if the session fails to create a temporary
topic due to some internal error.public void unsubscribe(String name) throws JMSException
Session
This method deletes the state being maintained on behalf of the subscriber by its provider.
It is erroneous for a client to delete a durable subscription
while there is an active MessageConsumer
or TopicSubscriber
for the
subscription, or while a consumed message is part of a pending
transaction or has not been acknowledged in the session.
unsubscribe
in interface Session
unsubscribe
in interface TopicSession
name
- the name used to identify this subscriptionJMSException
- if the session fails to unsubscribe to the
durable subscription due to some internal error.InvalidDestinationException
- if an invalid subscription name
is specified.public Session getSession() throws JMSException
JMSException
public XAResource getXAResource()
public QueueReceiver createReceiver(Queue queue, String messageSelector) throws JMSException
QueueSession
QueueReceiver
object to receive messages from the
specified queue using a message selector.createReceiver
in interface QueueSession
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.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.public QueueReceiver createReceiver(Queue queue) throws JMSException
QueueSession
QueueReceiver
object to receive messages from the
specified queue.createReceiver
in interface QueueSession
queue
- the Queue
to accessJMSException
- if the session fails to create a receiver
due to some internal error.InvalidDestinationException
- if an invalid queue is specified.public QueueSender createSender(Queue queue) throws JMSException
QueueSession
QueueSender
object to send messages to the
specified queue.createSender
in interface QueueSession
queue
- the Queue
to access, or null if this is an
unidentified producerJMSException
- if the session fails to create a sender
due to some internal error.InvalidDestinationException
- if an invalid queue is specified.public QueueSession getQueueSession() throws JMSException
JMSException
public TopicPublisher createPublisher(Topic topic) throws JMSException
TopicSession
A client uses a TopicPublisher
object to publish
messages on a topic.
Each time a client creates a TopicPublisher
on a topic, it
defines a
new sequence of messages that have no ordering relationship with the
messages it has previously sent.
createPublisher
in interface TopicSession
topic
- the Topic
to publish to, or null if this is an
unidentified producerJMSException
- if the session fails to create a publisher
due to some internal error.InvalidDestinationException
- if an invalid topic is specified.public TopicSubscriber createSubscriber(Topic topic, String messageSelector, boolean noLocal) throws JMSException
TopicSession
A client uses a TopicSubscriber
object to receive
messages that have been published to a topic.
Regular TopicSubscriber
objects are not durable.
They receive only messages that are published while they are active.
Messages filtered out by a subscriber's message selector will never be delivered to the subscriber. From the subscriber's perspective, they do not exist.
In some cases, a connection may both publish and subscribe to a
topic. The subscriber NoLocal
attribute allows a subscriber
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is false.
createSubscriber
in interface TopicSession
topic
- the Topic
to subscribe tomessageSelector
- 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.noLocal
- if set, inhibits the delivery of messages published
by its own connectionJMSException
- if the session fails to create a subscriber
due to some internal error.InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.public TopicSubscriber createSubscriber(Topic topic) throws JMSException
TopicSession
A client uses a TopicSubscriber
object to receive
messages that have been published to a topic.
Regular TopicSubscriber
objects are not durable.
They receive only messages that are published while they are active.
In some cases, a connection may both publish and subscribe to a
topic. The subscriber NoLocal
attribute allows a subscriber
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is false.
createSubscriber
in interface TopicSession
topic
- the Topic
to subscribe toJMSException
- if the session fails to create a subscriber
due to some internal error.InvalidDestinationException
- if an invalid topic is specified.public TopicSession getTopicSession() throws JMSException
JMSException
public ClientSession getCoreSession()
public boolean isRecoverCalled()
public void setRecoverCalled(boolean recoverCalled)
public void deleteTemporaryTopic(HornetQDestination tempTopic) throws JMSException
JMSException
public void deleteTemporaryQueue(HornetQDestination tempQueue) throws JMSException
JMSException
public void start() throws JMSException
JMSException
public void stop() throws JMSException
JMSException
public void removeConsumer(HornetQMessageConsumer consumer)
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.