public class ActiveMQSession extends Object implements 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 |
ActiveMQSession(ConnectionFactoryOptions options,
ActiveMQConnection connection,
boolean transacted,
boolean xa,
int ackMode,
boolean cacheDestination,
boolean enable1xPrefixes,
ClientSession session,
int sessionType) |
Modifier and Type | Method and Description |
---|---|
void |
ackAllConsumers() |
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 a
MessageConsumer for the specified destination, specifying a
message selector and the noLocal parameter. |
MessageConsumer |
createDurableConsumer(Topic topic,
String name)
Creates an unshared durable subscription on the specified topic (if one
does not already exist) and creates a consumer on that durable
subscription.
|
MessageConsumer |
createDurableConsumer(Topic topic,
String name,
String messageSelector,
boolean noLocal)
Creates an unshared durable subscription on the specified topic (if one
does not already exist), specifying a message selector and the
noLocal parameter, and creates a consumer on that durable
subscription. |
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name)
Creates an unshared durable subscription on the specified topic (if one
does not already exist) and creates a consumer on that durable
subscription.
|
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name,
String messageSelector,
boolean noLocal)
Creates an unshared durable subscription on the specified topic (if one
does not already exist), specifying a message selector and the
noLocal parameter, and creates a consumer on that durable
subscription. |
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. |
MessageConsumer |
createSharedConsumer(Topic topic,
String sharedSubscriptionName)
Creates a shared non-durable subscription with the specified name on the
specified topic (if one does not already exist) and creates a consumer on
that subscription.
|
MessageConsumer |
createSharedConsumer(Topic topic,
String name,
String messageSelector)
Note: Needs to throw an exception if a subscriptionName is already in use by another topic, or if the messageSelector is different
validate multiple subscriptions on the same session.
|
MessageConsumer |
createSharedDurableConsumer(Topic topic,
String name)
Creates a shared durable subscription on the specified topic (if one does
not already exist), specifying a message selector and the
noLocal
parameter, and creates a consumer on that durable subscription. |
MessageConsumer |
createSharedDurableConsumer(Topic topic,
String name,
String messageSelector)
Creates a shared durable subscription on the specified topic (if one
does not already exist), specifying a message selector,
and creates a consumer on that durable subscription.
|
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 object which encapsulates a specified
provider-specific topic name. |
void |
deleteTemporaryQueue(ActiveMQDestination tempQueue) |
void |
deleteTemporaryTopic(ActiveMQDestination tempTopic) |
int |
getAcknowledgeMode()
Returns the acknowledgement mode of the session.
|
ClientSession |
getCoreSession() |
String |
getDeserializationBlackList() |
String |
getDeserializationWhiteList() |
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() |
protected Queue |
internalCreateQueue(String queueName) |
protected ActiveMQQueue |
internalCreateQueueCompatibility(String queueName) |
protected Topic |
internalCreateTopic(String topicName,
boolean retry) |
boolean |
isEnable1xPrefixes() |
boolean |
isRecoverCalled() |
boolean |
isXA() |
void |
recover()
Stops message delivery in this session, and restarts message delivery
with the oldest unacknowledged message.
|
void |
removeConsumer(ActiveMQMessageConsumer 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 ActiveMQSession(ConnectionFactoryOptions options, ActiveMQConnection connection, boolean transacted, boolean xa, int ackMode, boolean cacheDestination, boolean enable1xPrefixes, 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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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
.
The message object returned may be sent using any Session
or JMSContext
.
It is not restricted to being sent using the JMSContext
used to create it.
The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
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
This method must not return until any incomplete asynchronous send operations for this Session have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.
A CompletionListener callback method must not call commit on its own Session. Doing so will cause an IllegalStateException to be thrown.
commit
in interface Session
IllegalStateException
- 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.public void rollback() throws JMSException
Session
This method must not return until any incomplete asynchronous send operations for this Session have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.
A CompletionListener callback method must not call commit on its own Session. Doing so will cause an IllegalStateException to be thrown.
rollback
in interface Session
IllegalStateException
- JMSException
- if the JMS provider fails to roll back the
transaction due to some internal error.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.
This method must not return until any incomplete asynchronous send operations for this Session have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.
For the avoidance of doubt, if an exception listener for this session's
connection is running when close
is invoked, there is no
requirement for the close
call to wait until the exception
listener has returned before it may return.
Closing a transacted session must roll back the transaction in progress.
This method is the only Session
method that can be called
concurrently.
A MessageListener must not attempt to close its own Session as this would lead to deadlock. The JMS provider must detect this and throw a IllegalStateException.
A CompletionListener callback method must not call close on its own Session. Doing so will cause an IllegalStateException to be thrown.
Invoking any other Session
method on a closed session must
throw a IllegalStateException
. Closing a closed
session must not throw an exception.
close
in interface AutoCloseable
close
in interface Session
IllegalStateException
- 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
This method must not be used in a Java EE web or EJB application.
Doing so may cause a JMSException
to be thrown though this is not guaranteed.
getMessageListener
in interface Session
JMSException
- if the JMS provider fails to get the session's distinguished message
listener for one of the following reasons:
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 ordinary JMS clients.
This method must not be used in a Java EE web or EJB application.
Doing so may cause a JMSException
to be thrown though this is not guaranteed.
setMessageListener
in interface Session
listener
- the message listener to associate with this sessionJMSException
- if the JMS provider fails to set the session's distinguished message
listener for one of the following reasons:
Session.getMessageListener()
,
ServerSessionPool
,
ServerSession
public void run()
Session
This method must not be used in a Java EE web or EJB application.
Doing so may cause a JMSRuntimeException
to be thrown though this is not guaranteed.
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, specifying a
message selector and the noLocal
parameter.
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.
The noLocal
argument is for use when the
destination is a topic and the session's connection
is also being used to publish messages to that topic.
If noLocal
is set to true then the
MessageConsumer
will not receive messages published
to the topic by its own connection. The default value of this
argument is false. If the destination is a queue
then the effect of setting noLocal
to true is not specified.
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,
then the MessageConsumer
will
not receive messages published to the topic
by its own connection.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
QueueSession
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.protected Queue internalCreateQueue(String queueName) throws ActiveMQException, JMSException
ActiveMQException
JMSException
protected ActiveMQQueue internalCreateQueueCompatibility(String queueName) throws ActiveMQException, JMSException
ActiveMQException
JMSException
public Topic createTopic(String topicName) throws JMSException
Session
Topic
object which encapsulates a specified
provider-specific topic name.
The use of provider-specific topic names in an application may render the
application non-portable. Portable applications are recommended to not
use this method but instead look up an administratively-defined
Topic
object using JNDI.
Note that this method simply creates an object that encapsulates the name
of a topic. It does not create the physical topic in the JMS provider.
JMS does not provide a method to create the physical topic, since this
would be specific to a given JMS provider. Creating a physical topic is
provider-specific and is typically an administrative task performed by an
administrator, though some providers may create them automatically when
needed. The one exception to this is the creation of a temporary topic,
which is done using the createTemporaryTopic
method.
createTopic
in interface Session
createTopic
in interface TopicSession
topicName
- A provider-specific topic nameJMSException
- if a Topic object cannot be created due to some internal
errorprotected Topic internalCreateTopic(String topicName, boolean retry) throws ActiveMQException, JMSException
ActiveMQException
JMSException
public TopicSubscriber createDurableSubscriber(Topic topic, String name) throws JMSException
Session
noLocal
value of false
.
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with unshared durable subscriptions. Any
durable subscription created using this method will be unshared. This
means that only one active (i.e. not closed) consumer on the subscription
may exist at a time. The term "consumer" here means a
TopicSubscriber
, MessageConsumer
or JMSConsumer
object in any client.
An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.
If an unshared durable subscription already exists with the same name and
client identifier, and the same topic, message selector and
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then
this method creates a TopicSubscriber
on the existing durable subscription.
If an unshared durable subscription already exists with the same name and
client identifier, and there is a consumer already active (i.e. not
closed) on the durable subscription, then a JMSException
will be
thrown.
If an unshared durable subscription already exists with the same name and
client identifier but a different topic, message selector or
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then this is
equivalent to unsubscribing (deleting) the old one and creating a new
one.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier. If a shared durable
subscription already exists with the same name and client identifier then
a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.
This method is identical to the corresponding
createDurableConsumer
method except that it returns a
TopicSubscriber
rather than a MessageConsumer
to
represent the consumer.
createDurableSubscriber
in interface Session
createDurableSubscriber
in interface TopicSession
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionInvalidDestinationException
- if an invalid topic is specified.IllegalStateException
- if the client identifier is unsetJMSException
- TopicSubscriber
due to some
internal error
public TopicSubscriber createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException
Session
noLocal
parameter, and creates a consumer on that durable
subscription.
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with unshared durable subscriptions. Any
durable subscription created using this method will be unshared. This
means that only one active (i.e. not closed) consumer on the subscription
may exist at a time. The term "consumer" here means a
TopicSubscriber
, MessageConsumer
or JMSConsumer
object in any client.
An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.
If an unshared durable subscription already exists with the same name and
client identifier, and the same topic, message selector and
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then
this method creates a TopicSubscriber
on the existing durable subscription.
If an unshared durable subscription already exists with the same name and
client identifier, and there is a consumer already active (i.e. not
closed) on the durable subscription, then a JMSException
will be
thrown.
If an unshared durable subscription already exists with the same name and
client identifier but a different topic, message selector or
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then this is
equivalent to unsubscribing (deleting) the old one and creating a new
one.
If noLocal
is set to true then any messages published to the topic
using this session's connection, or any other connection with the same client
identifier, will not be added to the durable subscription.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier. If a shared durable
subscription already exists with the same name and client identifier then
a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.
This method is identical to the corresponding
createDurableConsumer
method except that it returns a
TopicSubscriber
rather than a MessageConsumer
to
represent the consumer.
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 added to the durable subscription. A value of
null or an empty string indicates that there is no message
selector for the durable subscription.noLocal
- if true then any messages published to the topic using this
session's connection, or any other connection with the same
client identifier, will not be added to the durable
subscription.InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.IllegalStateException
- if the client identifier is unsetJMSException
- TopicSubscriber
due to some
internal error
public MessageConsumer createSharedConsumer(Topic topic, String sharedSubscriptionName) throws JMSException
Session
If a shared non-durable subscription already exists with the same name
and client identifier (if set), and the same topic and message selector
value has been specified, then this method creates a
MessageConsumer
on the existing subscription.
A non-durable shared subscription is used by a client which needs to be
able to share the work of receiving messages from a topic subscription
amongst multiple consumers. A non-durable shared subscription may
therefore have more than one consumer. Each message from the subscription
will be delivered to only one of the consumers on that subscription. Such
a subscription is not persisted and will be deleted (together with any
undelivered messages associated with it) when there are no consumers on
it. The term "consumer" here means a MessageConsumer
or
JMSConsumer
object in any client.
A shared non-durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared non-durable subscription must use the same client identifier.
If a shared non-durable subscription already exists with the same name
and client identifier (if set) but a different topic or message selector
has been specified, and there is a consumer already
active (i.e. not closed) on the subscription, then a JMSException
will be thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.
createSharedConsumer
in interface Session
topic
- the Topic
to subscribe tosharedSubscriptionName
- the name used to identify the shared non-durable subscriptionJMSException
- if the session fails to create the shared non-durable
subscription and MessageConsumer
due to some internal
error.InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.public MessageConsumer createSharedConsumer(Topic topic, String name, String messageSelector) throws JMSException
createSharedConsumer
in interface Session
topic
- name
- messageSelector
- JMSException
InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.public MessageConsumer createDurableConsumer(Topic topic, String name) throws JMSException
Session
noLocal
value of false
.
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with unshared durable subscriptions. Any
durable subscription created using this method will be unshared. This
means that only one active (i.e. not closed) consumer on the subscription
may exist at a time. The term "consumer" here means a
TopicSubscriber
, MessageConsumer
or JMSConsumer
object in any client.
An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.
If an unshared durable subscription already exists with the same name and
client identifier, and the same topic, message selector and
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then
this method creates a MessageConsumer
on the existing durable subscription.
If an unshared durable subscription already exists with the same name and
client identifier, and there is a consumer already active (i.e. not
closed) on the durable subscription, then a JMSException
will be
thrown.
If an unshared durable subscription already exists with the same name and
client identifier but a different topic, message selector or
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then this is
equivalent to unsubscribing (deleting) the old one and creating a new
one.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier. If a shared durable
subscription already exists with the same name and client identifier then
a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.
This method is identical to the corresponding
createDurableSubscriber
method except that it returns a
MessageConsumer
rather than a TopicSubscriber
to
represent the consumer.
createDurableConsumer
in interface Session
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionInvalidDestinationException
- if an invalid topic is specified.IllegalStateException
- if the client identifier is unsetJMSException
- MessageConsumer
due to some
internal error
public MessageConsumer createDurableConsumer(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException
Session
noLocal
parameter, and creates a consumer on that durable
subscription.
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with unshared durable subscriptions. Any
durable subscription created using this method will be unshared. This
means that only one active (i.e. not closed) consumer on the subscription
may exist at a time. The term "consumer" here means a
TopicSubscriber
, MessageConsumer
or JMSConsumer
object in any client.
An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.
If an unshared durable subscription already exists with the same name and
client identifier, and the same topic, message selector and
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then
this method creates a MessageConsumer
on the existing durable subscription.
If an unshared durable subscription already exists with the same name and
client identifier, and there is a consumer already active (i.e. not
closed) on the durable subscription, then a JMSException
will be
thrown.
If an unshared durable subscription already exists with the same name and
client identifier but a different topic, message selector or
noLocal
value has been specified, and there is no consumer
already active (i.e. not closed) on the durable subscription then this is
equivalent to unsubscribing (deleting) the old one and creating a new
one.
If noLocal
is set to true then any messages published to the topic
using this session's connection, or any other connection with the same client
identifier, will not be added to the durable subscription.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier. If a shared durable
subscription already exists with the same name and client identifier then
a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.
This method is identical to the corresponding
createDurableSubscriber
method except that it returns a
MessageConsumer
rather than a TopicSubscriber
to
represent the consumer.
createDurableConsumer
in interface Session
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 added to the durable subscription. A value of
null or an empty string indicates that there is no message
selector for the durable subscription.noLocal
- if true then any messages published to the topic using this
session's connection, or any other connection with the same
client identifier, will not be added to the durable
subscription.InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.IllegalStateException
- if the client identifier is unsetJMSException
- MessageConsumer
due to some
internal error
public MessageConsumer createSharedDurableConsumer(Topic topic, String name) throws JMSException
Session
noLocal
parameter, and creates a consumer on that durable subscription. This
method creates the durable subscription without a message selector.
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with shared durable subscriptions. Any
durable subscription created using this method will be shared. This means
that multiple active (i.e. not closed) consumers on the subscription may
exist at the same time. The term "consumer" here means a
MessageConsumer
or JMSConsumer
object in any client.
A shared durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared durable subscription must use the same client identifier.
If a shared durable subscription already exists with the same name and
client identifier (if set), and the same topic and message selector
has been specified, then this method creates a
MessageConsumer
on the existing shared durable subscription.
If a shared durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.
If a shared durable subscription already exists with the same name and
client identifier (if set) but a different topic or message selector
has been specified, and there is a consumer already
active (i.e. not closed) on the durable subscription, then a
JMSException
will be thrown.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier (if set). If an unshared
durable subscription already exists with the same name and client
identifier (if set) then a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.
createSharedDurableConsumer
in interface Session
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionJMSException
- MessageConsumer
due to some
internal error
InvalidDestinationException
- if an invalid topic is specified.public MessageConsumer createSharedDurableConsumer(Topic topic, String name, String messageSelector) throws JMSException
Session
A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The JMS provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.
A durable subscription will continue to accumulate messages until it is
deleted using the unsubscribe
method.
This method may only be used with shared durable subscriptions. Any
durable subscription created using this method will be shared. This means
that multiple active (i.e. not closed) consumers on the subscription may
exist at the same time. The term "consumer" here means a
MessageConsumer
or JMSConsumer
object in any client.
A shared durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared durable subscription must use the same client identifier.
If a shared durable subscription already exists with the same name and
client identifier (if set), and the same topic and message selector
has been specified, then this method creates a
MessageConsumer
on the existing shared durable subscription.
If a shared durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.
If a shared durable subscription already exists with the same name and
client identifier (if set) but a different topic or message selector
has been specified, and there is a consumer already
active (i.e. not closed) on the durable subscription, then a
JMSException
will be thrown.
A shared durable subscription and an unshared durable subscription may
not have the same name and client identifier (if set). If an unshared
durable subscription already exists with the same name and client
identifier (if set) then a JMSException
is thrown.
There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.
createSharedDurableConsumer
in interface Session
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 added to the durable subscription. A value of
null or an empty string indicates that there is no message
selector for the durable subscription.JMSException
- MessageConsumer
due to some
internal error
InvalidDestinationException
- if an invalid topic is specified.InvalidSelectorException
- if the message selector is invalid.public String getDeserializationBlackList()
public String getDeserializationWhiteList()
public void ackAllConsumers() throws JMSException
JMSException
public QueueBrowser createBrowser(Queue queue) throws JMSException
QueueSession
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 queue is specified.public QueueBrowser createBrowser(Queue queue, String filterString) throws JMSException
QueueSession
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 queue is specified.InvalidSelectorException
- if the message selector is invalid.public TemporaryQueue createTemporaryQueue() throws JMSException
QueueSession
TemporaryQueue
object. Its lifetime will be that
of the QueueConnection
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.
A durable subscription is identified by a name specified by the client and by the client identifier if set. If the client identifier was set when the durable subscription was created then a client which subsequently wishes to use this method to delete a durable subscription must use the same client identifier.
It is erroneous for a client to delete a durable subscription while there is an active (not closed) consumer 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(ActiveMQDestination tempTopic) throws JMSException
JMSException
public void deleteTemporaryQueue(ActiveMQDestination tempQueue) throws JMSException
JMSException
public void start() throws JMSException
JMSException
public void stop() throws JMSException
JMSException
public void removeConsumer(ActiveMQMessageConsumer consumer)
public boolean isEnable1xPrefixes()
Copyright © 2019 JBoss by Red Hat. All rights reserved.