public class ActiveMQSession extends Object implements javax.jms.Session, javax.jms.QueueSession, javax.jms.TopicSession, StatsCapable, ActiveMQDispatcher
A Session
object is a single-threaded context for producing
and consuming messages. Although it may allocate provider resources outside
the Java virtual machine (JVM), it is considered a lightweight JMS object.
A session serves several purposes:
TemporaryTopics
and
TemporaryQueues
.
Queue
or Topic
objects for those clients that need to dynamically manipulate
provider-specific destination names.
QueueBrowsers
.
A session can create and service multiple message producers and consumers.
One typical use is to have a thread block on a synchronous
MessageConsumer
until a message arrives. The thread may then
use one or more of the Session
'sMessageProducer
s.
If a client desires to have one thread produce messages while others consume them, the client should use a separate session for its producing thread.
Once a connection has been started, any session with one or more registered
message listeners is dedicated to the thread of control that delivers
messages to it. It is erroneous for client code to use this session or any of
its constituent objects from another thread of control. The only exception to
this rule is the use of the session or connection close
method.
It should be easy for most clients to partition their work naturally into sessions. This model allows clients to start simply and incrementally add message processing complexity as their need for concurrency grows.
The close
method is the only session method that can be called
while some other session method is being executed in another thread.
A session may be specified as transacted. Each transacted session supports a single series of transactions. Each transaction groups a set of message sends and a set of message receives into an atomic unit of work. In effect, transactions organize a session's input message stream and output message stream into series of atomic units. When a transaction commits, its atomic unit of input is acknowledged and its associated atomic unit of output is sent. If a transaction rollback is done, the transaction's sent messages are destroyed and the session's input is automatically recovered.
The content of a transaction's input and output units is simply those messages that have been produced and consumed within the session's current transaction.
A transaction is completed using either its session's commit
method or its session's rollback
method. The completion of a
session's current transaction automatically begins the next. The result is
that a transacted session always has a current transaction within which its
work is done.
The Java Transaction Service (JTS) or some other transaction monitor may be
used to combine a session's transaction with transactions on other resources
(databases, other JMS sessions, etc.). Since Java distributed transactions
are controlled via the Java Transaction API (JTA), use of the session's
commit
and rollback
methods in this context is
prohibited.
The JMS API does not require support for JTA; however, it does define how a provider supplies this support.
Although it is also possible for a JMS client to handle distributed transactions directly, it is unlikely that many JMS clients will do this. Support for JTA in the JMS API is targeted at systems vendors who will be integrating the JMS API into their application server products.
Session
,
QueueSession
,
TopicSession
,
XASession
Modifier and Type | Class and Description |
---|---|
static interface |
ActiveMQSession.DeliveryListener |
Modifier and Type | Field and Description |
---|---|
protected int |
acknowledgementMode |
protected boolean |
asyncDispatch |
protected boolean |
closed |
protected ActiveMQConnection |
connection |
protected LongSequenceGenerator |
consumerIdGenerator |
protected CopyOnWriteArrayList<ActiveMQMessageConsumer> |
consumers |
protected boolean |
debug |
protected LongSequenceGenerator |
deliveryIdGenerator |
protected ActiveMQSessionExecutor |
executor |
static int |
INDIVIDUAL_ACKNOWLEDGE
Only acknowledge an individual message - using message.acknowledge()
as opposed to CLIENT_ACKNOWLEDGE which
acknowledges all messages consumed by a session at when acknowledge()
is called
|
protected SessionInfo |
info |
static int |
MAX_ACK_CONSTANT |
protected LongSequenceGenerator |
producerIdGenerator |
protected CopyOnWriteArrayList<ActiveMQMessageProducer> |
producers |
protected Object |
redeliveryGuard |
protected Object |
sendMutex |
protected boolean |
sessionAsyncDispatch |
protected AtomicBoolean |
started |
Modifier | Constructor and Description |
---|---|
protected |
ActiveMQSession(ActiveMQConnection connection,
SessionId sessionId,
int acknowledgeMode,
boolean asyncDispatch) |
protected |
ActiveMQSession(ActiveMQConnection connection,
SessionId sessionId,
int acknowledgeMode,
boolean asyncDispatch,
boolean sessionAsyncDispatch)
Construct the Session
|
Modifier and Type | Method and Description |
---|---|
void |
acknowledge()
Acknowledges all consumed messages of the session of this consumed
message.
|
protected void |
addConsumer(ActiveMQMessageConsumer consumer)
Add a message consumer.
|
protected void |
addProducer(ActiveMQMessageProducer producer)
Adds a message producer.
|
void |
asyncSendPacket(Command command)
Send the asynchronous command.
|
protected void |
checkClosed()
Check if the session is closed.
|
void |
checkMessageListener() |
void |
close()
Closes the session.
|
protected void |
close(ConsumerId id) |
void |
commit()
Commits all messages done in this transaction and releases any locks
currently held.
|
protected void |
configureMessage(ActiveMQMessage message)
Checks that the session is not closed then configures the message
|
BlobMessage |
createBlobMessage(File file)
Creates an initialized
BlobMessage object. |
BlobMessage |
createBlobMessage(InputStream in)
Creates an initialized
BlobMessage object. |
BlobMessage |
createBlobMessage(URL url)
Creates an initialized
BlobMessage object. |
BlobMessage |
createBlobMessage(URL url,
boolean deletedByBroker)
Creates an initialized
BlobMessage object. |
javax.jms.QueueBrowser |
createBrowser(javax.jms.Queue queue)
Creates a
QueueBrowser object to peek at the messages on
the specified queue. |
javax.jms.QueueBrowser |
createBrowser(javax.jms.Queue queue,
String messageSelector)
Creates a
QueueBrowser object to peek at the messages on
the specified queue using a message selector. |
javax.jms.BytesMessage |
createBytesMessage()
Creates a
BytesMessage object. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination)
Creates a
MessageConsumer for the specified destination. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination,
javax.jms.MessageListener messageListener)
Creates a
MessageConsumer for the specified destination. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination,
String messageSelector)
Creates a
MessageConsumer for the specified destination,
using a message selector. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination,
String messageSelector,
boolean noLocal)
Creates
MessageConsumer for the specified destination,
using a message selector. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination,
String messageSelector,
boolean noLocal,
javax.jms.MessageListener messageListener)
Creates
MessageConsumer for the specified destination,
using a message selector. |
javax.jms.MessageConsumer |
createConsumer(javax.jms.Destination destination,
String messageSelector,
javax.jms.MessageListener messageListener)
Creates a
MessageConsumer for the specified destination,
using a message selector. |
javax.jms.TopicSubscriber |
createDurableSubscriber(javax.jms.Topic topic,
String name)
Creates a durable subscriber to the specified topic.
|
javax.jms.TopicSubscriber |
createDurableSubscriber(javax.jms.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.
|
javax.jms.MapMessage |
createMapMessage()
Creates a
MapMessage object. |
javax.jms.Message |
createMessage()
Creates a
Message object. |
javax.jms.ObjectMessage |
createObjectMessage()
Creates an
ObjectMessage object. |
javax.jms.ObjectMessage |
createObjectMessage(Serializable object)
Creates an initialized
ObjectMessage object. |
javax.jms.MessageProducer |
createProducer(javax.jms.Destination destination)
Creates a
MessageProducer to send messages to the
specified destination. |
javax.jms.TopicPublisher |
createPublisher(javax.jms.Topic topic)
Creates a publisher for the specified topic.
|
javax.jms.Queue |
createQueue(String queueName)
Creates a queue identity given a
Queue name. |
javax.jms.QueueReceiver |
createReceiver(javax.jms.Queue queue)
Creates a
QueueReceiver object to receive messages from
the specified queue. |
javax.jms.QueueReceiver |
createReceiver(javax.jms.Queue queue,
String messageSelector)
Creates a
QueueReceiver object to receive messages from
the specified queue using a message selector. |
javax.jms.QueueSender |
createSender(javax.jms.Queue queue)
Creates a
QueueSender object to send messages to the
specified queue. |
javax.jms.StreamMessage |
createStreamMessage()
Creates a
StreamMessage object. |
javax.jms.TopicSubscriber |
createSubscriber(javax.jms.Topic topic)
Creates a nondurable subscriber to the specified topic.
|
javax.jms.TopicSubscriber |
createSubscriber(javax.jms.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.
|
javax.jms.TemporaryQueue |
createTemporaryQueue()
Creates a
TemporaryQueue object. |
javax.jms.TemporaryTopic |
createTemporaryTopic()
Creates a
TemporaryTopic object. |
javax.jms.TextMessage |
createTextMessage()
Creates a
TextMessage object. |
javax.jms.TextMessage |
createTextMessage(String text)
Creates an initialized
TextMessage object. |
javax.jms.Topic |
createTopic(String topicName)
Creates a topic identity given a
Topic name. |
void |
dispatch(MessageDispatch messageDispatch) |
void |
dispose() |
protected void |
doStartTransaction()
Send TransactionInfo to indicate transaction has started
|
int |
getAcknowledgeMode()
Returns the acknowledgement mode of the session.
|
BlobTransferPolicy |
getBlobTransferPolicy() |
ActiveMQConnection |
getConnection() |
protected ThreadPoolExecutor |
getConnectionExecutor() |
ActiveMQSession.DeliveryListener |
getDeliveryListener()
Returns the message delivery listener.
|
long |
getLastDeliveredSequenceId()
highest sequence id of the last message delivered by this session.
|
javax.jms.MessageListener |
getMessageListener()
Returns the session's distinguished message listener (optional).
|
protected ConsumerId |
getNextConsumerId() |
long |
getNextDeliveryId() |
protected ProducerId |
getNextProducerId() |
protected Scheduler |
getScheduler() |
protected SessionId |
getSessionId()
Returns the session id.
|
protected SessionInfo |
getSessionInfo()
Returns the SessionInfo bean.
|
JMSSessionStatsImpl |
getSessionStats()
Returns the session's statistics.
|
StatsImpl |
getStats() |
boolean |
getTransacted()
Indicates whether the session is in transacted mode.
|
TransactionContext |
getTransactionContext()
Returns the transaction context of the session.
|
MessageTransformer |
getTransformer() |
List<MessageDispatch> |
getUnconsumedMessages() |
boolean |
hasUncomsumedMessages()
Checks whether the session has unconsumed messages.
|
boolean |
isAsyncDispatch() |
boolean |
isAutoAcknowledge()
Checks whether the session used auto acknowledgment.
|
protected boolean |
isClientAcknowledge()
Checks whether the session used client acknowledgment.
|
boolean |
isClosed()
Checks if the session is closed.
|
boolean |
isDupsOkAcknowledge()
Checks whether the session used dup ok acknowledgment.
|
boolean |
isIndividualAcknowledge() |
boolean |
isInUse(ActiveMQTempDestination destination) |
boolean |
isRunning() |
boolean |
isSessionAsyncDispatch() |
boolean |
isTransacted()
Checks whether the session uses transactions.
|
void |
recover()
Stops message delivery in this session, and restarts message delivery
with the oldest unacknowledged message.
|
void |
redispatch(ActiveMQDispatcher dispatcher,
MessageDispatchChannel unconsumedMessages) |
protected void |
removeConsumer(ActiveMQMessageConsumer consumer)
Remove the message consumer.
|
protected void |
removeProducer(ActiveMQMessageProducer producer)
Removes a message producer.
|
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.
|
protected void |
send(ActiveMQMessageProducer producer,
ActiveMQDestination destination,
javax.jms.Message message,
int deliveryMode,
int priority,
long timeToLive,
MemoryUsage producerWindow,
int sendTimeout,
AsyncCallback onComplete)
Sends the message for dispatch by the broker.
|
protected void |
sendAck(MessageAck ack) |
protected void |
sendAck(MessageAck ack,
boolean lazy) |
void |
setAsyncDispatch(boolean asyncDispatch) |
void |
setBlobTransferPolicy(BlobTransferPolicy blobTransferPolicy)
Sets the policy used to describe how out-of-band BLOBs (Binary Large
OBjects) are transferred from producers to brokers to consumers
|
void |
setDeliveryListener(ActiveMQSession.DeliveryListener deliveryListener)
Sets the message delivery listener.
|
void |
setMessageListener(javax.jms.MessageListener listener)
Sets the session's distinguished message listener (optional).
|
protected void |
setOptimizeAcknowledge(boolean value) |
protected void |
setPrefetchSize(ConsumerId id,
int prefetch) |
void |
setSessionAsyncDispatch(boolean sessionAsyncDispatch) |
void |
setTransactionContext(TransactionContext transactionContext)
Sets the transaction context of the session.
|
void |
setTransformer(MessageTransformer transformer)
Sets the transformer used to transform messages before they are sent on
to the JMS bus or when they are received from the bus but before they are
delivered to the JMS client
|
protected void |
start()
Start this Session.
|
protected void |
stop()
Stops this session.
|
Response |
syncSendPacket(Command command)
Send the synchronous command.
|
String |
toString() |
void |
unsubscribe(String name)
Unsubscribes a durable subscription that has been created by a client.
|
public static final int INDIVIDUAL_ACKNOWLEDGE
public static final int MAX_ACK_CONSTANT
protected int acknowledgementMode
protected final ActiveMQConnection connection
protected final SessionInfo info
protected final LongSequenceGenerator consumerIdGenerator
protected final LongSequenceGenerator producerIdGenerator
protected final LongSequenceGenerator deliveryIdGenerator
protected final ActiveMQSessionExecutor executor
protected final AtomicBoolean started
protected final CopyOnWriteArrayList<ActiveMQMessageConsumer> consumers
protected final CopyOnWriteArrayList<ActiveMQMessageProducer> producers
protected boolean closed
protected boolean asyncDispatch
protected boolean sessionAsyncDispatch
protected final boolean debug
protected final Object redeliveryGuard
protected ActiveMQSession(ActiveMQConnection connection, SessionId sessionId, int acknowledgeMode, boolean asyncDispatch, boolean sessionAsyncDispatch) throws javax.jms.JMSException
connection
- sessionId
- acknowledgeMode
- n.b if transacted - the acknowledgeMode ==
Session.SESSION_TRANSACTEDasyncDispatch
- sessionAsyncDispatch
- javax.jms.JMSException
- on internal errorprotected ActiveMQSession(ActiveMQConnection connection, SessionId sessionId, int acknowledgeMode, boolean asyncDispatch) throws javax.jms.JMSException
javax.jms.JMSException
public void setTransactionContext(TransactionContext transactionContext)
transactionContext
- - provides the means to control a JMS
transaction.public TransactionContext getTransactionContext()
public StatsImpl getStats()
getStats
in interface StatsCapable
public JMSSessionStatsImpl getSessionStats()
public javax.jms.BytesMessage createBytesMessage() throws javax.jms.JMSException
BytesMessage
object. A BytesMessage
object is used to send a message containing a stream of uninterpreted
bytes.createBytesMessage
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.MapMessage createMapMessage() throws javax.jms.JMSException
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 javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.Message createMessage() throws javax.jms.JMSException
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 javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.ObjectMessage createObjectMessage() throws javax.jms.JMSException
ObjectMessage
object. An
ObjectMessage
object is used to send a message that
contains a serializable Java object.createObjectMessage
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.ObjectMessage createObjectMessage(Serializable object) throws javax.jms.JMSException
ObjectMessage
object. An
ObjectMessage
object is used to send a message that
contains a serializable Java object.createObjectMessage
in interface javax.jms.Session
object
- the object to use to initialize this messagejavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.StreamMessage createStreamMessage() throws javax.jms.JMSException
StreamMessage
object. A
StreamMessage
object is used to send a self-defining
stream of primitive values in the Java programming language.createStreamMessage
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.TextMessage createTextMessage() throws javax.jms.JMSException
TextMessage
object. A TextMessage
object is used to send a message containing a String
object.createTextMessage
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public javax.jms.TextMessage createTextMessage(String text) throws javax.jms.JMSException
TextMessage
object. A
TextMessage
object is used to send a message containing a
String
.createTextMessage
in interface javax.jms.Session
text
- the string used to initialize this messagejavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public BlobMessage createBlobMessage(URL url) throws javax.jms.JMSException
BlobMessage
object. A
BlobMessage
object is used to send a message containing a
URL
which points to some network addressible BLOB.url
- the network addressable URL used to pass directly to the
consumerjavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public BlobMessage createBlobMessage(URL url, boolean deletedByBroker) throws javax.jms.JMSException
BlobMessage
object. A
BlobMessage
object is used to send a message containing a
URL
which points to some network addressible BLOB.url
- the network addressable URL used to pass directly to the
consumerdeletedByBroker
- indicates whether or not the resource is deleted
by the broker when the message is acknowledgedjavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public BlobMessage createBlobMessage(File file) throws javax.jms.JMSException
BlobMessage
object. A
BlobMessage
object is used to send a message containing
the File
content. Before the message is sent the file
conent will be uploaded to the broker or some other remote repository
depending on the getBlobTransferPolicy()
.file
- the file to be uploaded to some remote repo (or the broker)
depending on the strategyjavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public BlobMessage createBlobMessage(InputStream in) throws javax.jms.JMSException
BlobMessage
object. A
BlobMessage
object is used to send a message containing
the File
content. Before the message is sent the file
conent will be uploaded to the broker or some other remote repository
depending on the getBlobTransferPolicy()
.
The caller of this method is responsible for closing the
input stream that is used, however the stream can not be closed
until after the message has been sent. To have this class
manage the stream and close it automatically, use the method
createBlobMessage(File)
in
- the stream to be uploaded to some remote repo (or the broker)
depending on the strategyjavax.jms.JMSException
- if the JMS provider fails to create this message due
to some internal error.public boolean getTransacted() throws javax.jms.JMSException
getTransacted
in interface javax.jms.Session
javax.jms.JMSException
- if there is some internal error.public int getAcknowledgeMode() throws javax.jms.JMSException
getAcknowledgeMode
in interface javax.jms.Session
javax.jms.JMSException
Connection.createSession(boolean,int)
public void commit() throws javax.jms.JMSException
commit
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to commit the transaction
due to some internal error.javax.jms.TransactionRolledBackException
- if the transaction is rolled back
due to some internal error during commit.javax.jms.IllegalStateException
- if the method is not called by a
transacted session.public void rollback() throws javax.jms.JMSException
rollback
in interface javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to roll back the
transaction due to some internal error.javax.jms.IllegalStateException
- if the method is not called by a
transacted session.public void close() throws javax.jms.JMSException
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 javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to close the session due
to some internal error.public void dispose() throws javax.jms.JMSException
javax.jms.JMSException
protected void configureMessage(ActiveMQMessage message) throws javax.jms.IllegalStateException
javax.jms.IllegalStateException
protected void checkClosed() throws javax.jms.IllegalStateException
javax.jms.IllegalStateException
- if the Session is closedpublic boolean isClosed()
public void recover() throws javax.jms.JMSException
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 javax.jms.Session
javax.jms.JMSException
- if the JMS provider fails to stop and restart
message delivery due to some internal error.javax.jms.IllegalStateException
- if the method is called by a transacted
session.public javax.jms.MessageListener getMessageListener() throws javax.jms.JMSException
getMessageListener
in interface javax.jms.Session
javax.jms.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(javax.jms.MessageListener listener) throws javax.jms.JMSException
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.
If this session has been closed, then an IllegalStateException
is
thrown, if trying to set a new listener. However setting the listener
to null is allowed, to clear the listener, even if this session
has been closed prior.
This is an expert facility not used by regular JMS clients.
setMessageListener
in interface javax.jms.Session
listener
- the message listener to associate with this sessionjavax.jms.JMSException
- if the JMS provider fails to set the message
listener due to an internal error.Session.getMessageListener()
,
ServerSessionPool
,
ServerSession
public void run()
public javax.jms.MessageProducer createProducer(javax.jms.Destination destination) throws javax.jms.JMSException
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 javax.jms.Session
destination
- the Destination
to send to, or null if
this is a producer which does not have a specified
destination.javax.jms.JMSException
- if the session fails to create a MessageProducer due
to some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination) throws javax.jms.JMSException
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 javax.jms.Session
destination
- the Destination
to access.javax.jms.JMSException
- if the session fails to create a consumer due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector) throws javax.jms.JMSException
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 javax.jms.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.javax.jms.JMSException
- if the session fails to create a MessageConsumer due
to some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination, javax.jms.MessageListener messageListener) throws javax.jms.JMSException
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
.destination
- the Destination
to access.messageListener
- the listener to use for async consumption of messagesjavax.jms.JMSException
- if the session fails to create a consumer due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector, javax.jms.MessageListener messageListener) throws javax.jms.JMSException
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.
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.messageListener
- the listener to use for async consumption of messagesjavax.jms.JMSException
- if the session fails to create a MessageConsumer due
to some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector, boolean noLocal) throws javax.jms.JMSException
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 javax.jms.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.javax.jms.JMSException
- if the session fails to create a MessageConsumer due
to some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector, boolean noLocal, javax.jms.MessageListener messageListener) throws javax.jms.JMSException
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.
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.messageListener
- the listener to use for async consumption of messagesjavax.jms.JMSException
- if the session fails to create a MessageConsumer due
to some internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.Queue createQueue(String queueName) throws javax.jms.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 JMS API. The one exception is the creation of temporary
queues, which is accomplished with the createTemporaryQueue
method.
createQueue
in interface javax.jms.QueueSession
createQueue
in interface javax.jms.Session
queueName
- the name of this Queue
Queue
with the given namejavax.jms.JMSException
- if the session fails to create a queue due to some
internal error.public javax.jms.Topic createTopic(String topicName) throws javax.jms.JMSException
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 javax.jms.Session
createTopic
in interface javax.jms.TopicSession
topicName
- the name of this Topic
Topic
with the given namejavax.jms.JMSException
- if the session fails to create a topic due to some
internal error.public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic, String name) throws javax.jms.JMSException
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 javax.jms.Session
createDurableSubscriber
in interface javax.jms.TopicSession
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscriptionjavax.jms.JMSException
- if the session fails to create a subscriber due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid topic is specified.public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws javax.jms.JMSException
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 javax.jms.Session
createDurableSubscriber
in interface javax.jms.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 connectionjavax.jms.JMSException
- if the session fails to create a subscriber due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid topic is specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue) throws javax.jms.JMSException
QueueBrowser
object to peek at the messages on
the specified queue.createBrowser
in interface javax.jms.QueueSession
createBrowser
in interface javax.jms.Session
queue
- the queue
to accessjavax.jms.JMSException
- if the session fails to create a browser due to some
internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specifiedpublic javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue, String messageSelector) throws javax.jms.JMSException
QueueBrowser
object to peek at the messages on
the specified queue using a message selector.createBrowser
in interface javax.jms.QueueSession
createBrowser
in interface javax.jms.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.javax.jms.JMSException
- if the session fails to create a browser due to some
internal error.javax.jms.InvalidDestinationException
- if an invalid destination is
specifiedjavax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.TemporaryQueue createTemporaryQueue() throws javax.jms.JMSException
TemporaryQueue
object. Its lifetime will be that
of the Connection
unless it is deleted earlier.createTemporaryQueue
in interface javax.jms.QueueSession
createTemporaryQueue
in interface javax.jms.Session
javax.jms.JMSException
- if the session fails to create a temporary queue due
to some internal error.public javax.jms.TemporaryTopic createTemporaryTopic() throws javax.jms.JMSException
TemporaryTopic
object. Its lifetime will be that
of the Connection
unless it is deleted earlier.createTemporaryTopic
in interface javax.jms.Session
createTemporaryTopic
in interface javax.jms.TopicSession
javax.jms.JMSException
- if the session fails to create a temporary topic due
to some internal error.public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue) throws javax.jms.JMSException
QueueReceiver
object to receive messages from
the specified queue.createReceiver
in interface javax.jms.QueueSession
queue
- the Queue
to accessjavax.jms.JMSException
- if the session fails to create a receiver due to
some internal error.javax.jms.JMSException
javax.jms.InvalidDestinationException
- if an invalid queue is specified.public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue, String messageSelector) throws javax.jms.JMSException
QueueReceiver
object to receive messages from
the specified queue using a message selector.createReceiver
in interface javax.jms.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.javax.jms.JMSException
- if the session fails to create a receiver due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid queue is specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.QueueSender createSender(javax.jms.Queue queue) throws javax.jms.JMSException
QueueSender
object to send messages to the
specified queue.createSender
in interface javax.jms.QueueSession
queue
- the Queue
to access, or null if this is an
unidentified producerjavax.jms.JMSException
- if the session fails to create a sender due to some
internal error.javax.jms.InvalidDestinationException
- if an invalid queue is specified.public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic) throws javax.jms.JMSException
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 javax.jms.TopicSession
topic
- the Topic
to subscribe tojavax.jms.JMSException
- if the session fails to create a subscriber due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid topic is specified.public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic, String messageSelector, boolean noLocal) throws javax.jms.JMSException
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 javax.jms.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 connectionjavax.jms.JMSException
- if the session fails to create a subscriber due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid topic is specified.javax.jms.InvalidSelectorException
- if the message selector is invalid.public javax.jms.TopicPublisher createPublisher(javax.jms.Topic topic) throws javax.jms.JMSException
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 javax.jms.TopicSession
topic
- the Topic
to publish to, or null if this is
an unidentified producerjavax.jms.JMSException
- if the session fails to create a publisher due to
some internal error.javax.jms.InvalidDestinationException
- if an invalid topic is specified.public void unsubscribe(String name) throws javax.jms.JMSException
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 javax.jms.Session
unsubscribe
in interface javax.jms.TopicSession
name
- the name used to identify this subscriptionjavax.jms.JMSException
- if the session fails to unsubscribe to the durable
subscription due to some internal error.javax.jms.InvalidDestinationException
- if an invalid subscription name is
specified.public void dispatch(MessageDispatch messageDispatch)
dispatch
in interface ActiveMQDispatcher
public void acknowledge() throws javax.jms.JMSException
All consumed JMS messages support the acknowledge
method
for use when a client has specified that its JMS session's consumed
messages are to be explicitly acknowledged. By invoking
acknowledge
on a consumed message, a client acknowledges
all messages consumed by the session that the message was delivered to.
Calls to acknowledge
are ignored for both transacted
sessions and sessions specified to use implicit acknowledgement modes.
A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)
Messages that have been received but not acknowledged may be redelivered.
javax.jms.JMSException
- if the JMS provider fails to acknowledge the
messages due to some internal error.javax.jms.IllegalStateException
- if this method is called on a
closed session.Session.CLIENT_ACKNOWLEDGE
protected void addConsumer(ActiveMQMessageConsumer consumer) throws javax.jms.JMSException
consumer
- - message consumer.javax.jms.JMSException
protected void removeConsumer(ActiveMQMessageConsumer consumer)
consumer
- - consumer to be removed.javax.jms.JMSException
protected void addProducer(ActiveMQMessageProducer producer) throws javax.jms.JMSException
producer
- - message producer to be added.javax.jms.JMSException
protected void removeProducer(ActiveMQMessageProducer producer)
producer
- - message producer to be removed.javax.jms.JMSException
protected void start() throws javax.jms.JMSException
javax.jms.JMSException
protected void stop() throws javax.jms.JMSException
javax.jms.JMSException
protected SessionId getSessionId()
protected ConsumerId getNextConsumerId()
protected ProducerId getNextProducerId()
protected void send(ActiveMQMessageProducer producer, ActiveMQDestination destination, javax.jms.Message message, int deliveryMode, int priority, long timeToLive, MemoryUsage producerWindow, int sendTimeout, AsyncCallback onComplete) throws javax.jms.JMSException
producer
- - message producer.destination
- - message destination.message
- - message to be sent.deliveryMode
- - JMS message delivery mode.priority
- - message priority.timeToLive
- - message expiration.producerWindow
- onComplete
- javax.jms.JMSException
protected void doStartTransaction() throws javax.jms.JMSException
javax.jms.JMSException
- if some internal error occurspublic boolean hasUncomsumedMessages()
public boolean isTransacted()
protected boolean isClientAcknowledge()
public boolean isAutoAcknowledge()
public boolean isDupsOkAcknowledge()
public boolean isIndividualAcknowledge()
public ActiveMQSession.DeliveryListener getDeliveryListener()
public void setDeliveryListener(ActiveMQSession.DeliveryListener deliveryListener)
deliveryListener
- - message delivery listener.protected SessionInfo getSessionInfo() throws javax.jms.JMSException
javax.jms.JMSException
public void asyncSendPacket(Command command) throws javax.jms.JMSException
command
- - command to be executed.javax.jms.JMSException
public Response syncSendPacket(Command command) throws javax.jms.JMSException
command
- - command to be executed.javax.jms.JMSException
public long getNextDeliveryId()
public void redispatch(ActiveMQDispatcher dispatcher, MessageDispatchChannel unconsumedMessages) throws javax.jms.JMSException
javax.jms.JMSException
public boolean isRunning()
public boolean isAsyncDispatch()
public void setAsyncDispatch(boolean asyncDispatch)
public boolean isSessionAsyncDispatch()
public void setSessionAsyncDispatch(boolean sessionAsyncDispatch)
sessionAsyncDispatch
- The sessionAsyncDispatch to set.public MessageTransformer getTransformer()
public ActiveMQConnection getConnection()
public void setTransformer(MessageTransformer transformer)
public BlobTransferPolicy getBlobTransferPolicy()
public void setBlobTransferPolicy(BlobTransferPolicy blobTransferPolicy)
public List<MessageDispatch> getUnconsumedMessages()
public void checkMessageListener() throws javax.jms.JMSException
javax.jms.JMSException
protected void setOptimizeAcknowledge(boolean value)
protected void setPrefetchSize(ConsumerId id, int prefetch)
protected void close(ConsumerId id)
public boolean isInUse(ActiveMQTempDestination destination)
public long getLastDeliveredSequenceId()
protected void sendAck(MessageAck ack) throws javax.jms.JMSException
javax.jms.JMSException
protected void sendAck(MessageAck ack, boolean lazy) throws javax.jms.JMSException
javax.jms.JMSException
protected Scheduler getScheduler() throws javax.jms.JMSException
javax.jms.JMSException
protected ThreadPoolExecutor getConnectionExecutor()
Copyright © 2005–2019 The Apache Software Foundation. All rights reserved.