|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.activemq.ActiveMQSession
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
Field Summary | |
protected SynchronizedBoolean |
closed
|
protected ActiveMQConnection |
connection
|
protected static int |
CONSUMER_DISPATCH_ASYNC
|
protected static int |
CONSUMER_DISPATCH_SYNC
|
protected static int |
CONSUMER_DISPATCH_UNSET
|
protected CopyOnWriteArrayList |
consumers
|
protected String |
currentTransactionId
|
protected IdGenerator |
packetIdGenerator
|
protected CopyOnWriteArrayList |
producers
|
Fields inherited from interface javax.jms.Session |
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED |
Constructor Summary | |
protected |
ActiveMQSession(ActiveMQConnection theConnection,
int theAcknowledgeMode)
Construct the Session |
Method Summary | |
void |
acknowledge()
Acknowledges all consumed messages of the session of this consumed message. |
protected void |
addConsumer(ActiveMQMessageConsumer consumer)
|
protected void |
addProducer(ActiveMQMessageProducer producer)
|
protected void |
checkClosed()
|
protected void |
clearMessagesInProgress()
|
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 messageSelector)
Creates a QueueBrowser object to peek at the messages on the specified queue using a message
selector. |
BytesMessage |
createBytesMessage()
Creates a BytesMessage object. |
MessageConsumer |
createConsumer(Destination destination)
Creates a MessageConsumer for the specified destination. |
MessageConsumer |
createConsumer(Destination destination,
String messageSelector)
Creates a MessageConsumer for the specified destination, using a message selector. |
MessageConsumer |
createConsumer(Destination destination,
String messageSelector,
boolean NoLocal)
Creates MessageConsumer for the specified destination, using a message selector. |
protected ConsumerInfo |
createConsumerInfo(ActiveMQMessageConsumer consumer)
|
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name)
Creates a durable subscriber to the specified topic. |
TopicSubscriber |
createDurableSubscriber(Topic topic,
String name,
String messageSelector,
boolean noLocal)
Creates a durable subscriber to the specified topic, using a message selector and specifying whether messages published by its own connection should be delivered to it. |
MapMessage |
createMapMessage()
Creates a MapMessage object. |
Message |
createMessage()
Creates a Message object. |
ObjectMessage |
createObjectMessage()
Creates an ObjectMessage object. |
ObjectMessage |
createObjectMessage(Serializable object)
Creates an initialized ObjectMessage object. |
MessageProducer |
createProducer(Destination destination)
Creates a MessageProducer to send messages to the specified destination. |
protected ProducerInfo |
createProducerInfo(ActiveMQMessageProducer producer)
|
TopicPublisher |
createPublisher(Topic topic)
Creates a publisher for the specified topic. |
Queue |
createQueue(String queueName)
Creates a queue identity given a Queue name. |
QueueReceiver |
createReceiver(Queue queue)
Creates a QueueReceiver object to receive messages from the specified queue. |
QueueReceiver |
createReceiver(Queue queue,
String messageSelector)
Creates a QueueReceiver object to receive messages from the specified queue using a message
selector. |
QueueSender |
createSender(Queue queue)
Creates a QueueSender object to send messages to the specified queue. |
StreamMessage |
createStreamMessage()
Creates a StreamMessage object. |
TopicSubscriber |
createSubscriber(Topic topic)
Creates a nondurable subscriber to the specified topic. |
TopicSubscriber |
createSubscriber(Topic topic,
String messageSelector,
boolean noLocal)
Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it. |
TemporaryQueue |
createTemporaryQueue()
Creates a TemporaryQueue object. |
TemporaryTopic |
createTemporaryTopic()
Creates a TemporaryTopic object. |
TextMessage |
createTextMessage()
Creates a TextMessage object. |
TextMessage |
createTextMessage(String text)
Creates an initialized TextMessage object. |
Topic |
createTopic(String topicName)
Creates a topic identity given a Topic name. |
void |
dispatch(ActiveMQMessage message)
Dispatch an ActiveMQMessage |
protected void |
doAcknowledge(boolean isClosing)
|
protected void |
doClose()
|
protected void |
doStartTransaction()
Send TransactionInfo to indicate transaction has started |
int |
getAcknowledgeMode()
Returns the acknowledgement mode of the session. |
LocalTransactionEventListener |
getLocalTransactionEventListener()
|
MessageListener |
getMessageListener()
Returns the session's distinguished message listener (optional). |
protected String |
getNextTransactionId()
|
protected String |
getSessionId()
|
JMSSessionStatsImpl |
getSessionStats()
|
protected long |
getStartTime()
|
Stats |
getStats()
|
boolean |
getTransacted()
Indicates whether the session is in transacted mode. |
protected boolean |
isClientAcknowledge()
|
boolean |
isTarget(ActiveMQMessage message)
Tests to see if the Message Dispatcher is a target for this message |
protected boolean |
isTransacted()
|
protected boolean |
isXaTransacted()
|
protected void |
messageDelivered(boolean sendAcknowledge,
ActiveMQMessage message,
boolean messageConsumed)
|
void |
recover()
Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message. |
protected void |
redeliverUnacknowledgedMessages()
|
protected void |
redeliverUnacknowledgedMessages(boolean onlyDeliverTransientConsumed)
|
protected void |
removeConsumer(ActiveMQMessageConsumer consumer)
|
protected void |
removeProducer(ActiveMQMessageProducer 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,
Destination destination,
Message message,
int deliveryMode,
int priority,
long timeToLive,
boolean reuseMessageId)
send the message for dispatch by the broker |
void |
setLocalTransactionEventListener(LocalTransactionEventListener localTransactionEventListener)
Used by the resource adapter to listen to transaction events. |
void |
setMessageListener(MessageListener listener)
Sets the session's distinguished message listener (optional). |
protected void |
setSessionConsumerDispatchState(int value)
|
protected void |
setSessionId(String sessionId)
|
protected void |
setStartTime(long startTime)
|
protected void |
start()
Start this Session |
protected void |
stop()
Stop this Session |
void |
unsubscribe(String name)
Unsubscribes a durable subscription that has been created by a client. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int CONSUMER_DISPATCH_UNSET
protected static final int CONSUMER_DISPATCH_ASYNC
protected static final int CONSUMER_DISPATCH_SYNC
protected ActiveMQConnection connection
protected CopyOnWriteArrayList consumers
protected CopyOnWriteArrayList producers
protected IdGenerator packetIdGenerator
protected SynchronizedBoolean closed
protected String currentTransactionId
Constructor Detail |
protected ActiveMQSession(ActiveMQConnection theConnection, int theAcknowledgeMode) throws JMSException
theConnection
- theAcknowledgeMode
- n.b if transacted - the acknowledgeMode == Session.SESSION_TRANSACTED
JMSException
- on internal errorMethod Detail |
public Stats getStats()
getStats
in interface StatsCapable
public JMSSessionStatsImpl getSessionStats()
public BytesMessage createBytesMessage() throws JMSException
BytesMessage
object. A BytesMessage
object is used to send a message
containing a stream of uninterpreted bytes.
createBytesMessage
in interface Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public MapMessage createMapMessage() throws JMSException
MapMessage
object. A MapMessage
object is used to send a self-defining
set of name-value pairs, where names are String
objects and values are primitive values in the
Java programming language.
createMapMessage
in interface Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public Message createMessage() throws JMSException
Message
object. The Message
interface is the root interface of all JMS
messages. A Message
object holds all the standard message header information. It can be sent when
a message containing only header information is sufficient.
createMessage
in interface Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public ObjectMessage createObjectMessage() throws JMSException
ObjectMessage
object. An ObjectMessage
object is used to send a message
that contains a serializable Java object.
createObjectMessage
in interface Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public ObjectMessage createObjectMessage(Serializable object) throws JMSException
ObjectMessage
object. An ObjectMessage
object is used to
send a message that contains a serializable Java object.
createObjectMessage
in interface Session
object
- the object to use to initialize this message
JMSException
- if the JMS provider fails to create this message due to some internal error.public StreamMessage createStreamMessage() throws 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 Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public TextMessage createTextMessage() throws JMSException
TextMessage
object. A TextMessage
object is used to send a message
containing a String
object.
createTextMessage
in interface Session
JMSException
- if the JMS provider fails to create this message due to some internal error.public TextMessage createTextMessage(String text) throws JMSException
TextMessage
object. A TextMessage
object is used to send a
message containing a String
.
createTextMessage
in interface Session
text
- the string used to initialize this message
JMSException
- if the JMS provider fails to create this message due to some internal error.public boolean getTransacted() throws JMSException
getTransacted
in interface Session
JMSException
- if there is some internal error.public int getAcknowledgeMode() throws JMSException
getAcknowledgeMode
in interface Session
JMSException
Connection.createSession(boolean,int)
public void commit() throws JMSException
commit
in interface Session
JMSException
- if the JMS provider fails to commit the transaction due to some internal error.
TransactionRolledBackException
- if the transaction is rolled back due to some internal error during
commit.
IllegalStateException
- if the method is not called by a transacted session.public void rollback() throws JMSException
rollback
in interface Session
JMSException
- if the JMS provider fails to roll back the transaction due to some internal error.
IllegalStateException
- if the method is not called by a transacted session.public void close() throws JMSException
Since a provider may allocate some resources on behalf of a session outside the JVM, clients should close the resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.
There is no need to close the producers and consumers of a closed session.
This call will block until a receive
call or message listener in progress has completed. A blocked
message consumer receive
call returns null
when this session is closed.
Closing a transacted session must roll back the transaction in progress.
This method is the only Session
method that can be called concurrently.
Invoking any other Session
method on a closed session must throw a
JMSException.IllegalStateException
. Closing a closed session must not throw an exception.
close
in interface Session
JMSException
- if the JMS provider fails to close the session due to some internal error.protected void doClose() throws JMSException
JMSException
protected void checkClosed() throws IllegalStateException
IllegalStateException
- if the Session is closedpublic void recover() throws 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 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
getMessageListener
in interface Session
JMSException
- if the JMS provider fails to get the message listener due to an internal error.Session.setMessageListener(javax.jms.MessageListener)
,
ServerSessionPool
,
ServerSession
public void setMessageListener(MessageListener listener) throws JMSException
When the distinguished message listener is set, no other form of message receipt in the session can be used; however, all forms of sending messages are still supported.
This is an expert facility not used by regular JMS clients.
setMessageListener
in interface Session
listener
- the message listener to associate with this session
JMSException
- if the JMS provider fails to set the message listener due to an internal error.Session.getMessageListener()
,
ServerSessionPool
,
ServerSession
public void run()
run
in interface Session
ServerSession
public MessageProducer createProducer(Destination destination) throws 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 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
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
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
MessageConsumer
for the specified destination, using a message selector. This method can
specify whether messages published by its own connection should be delivered to it, if the destination is a
topic.
Since Queue
and Topic
both inherit from Destination
, they can be
used in the destination parameter to create a MessageConsumer
.
A client uses a MessageConsumer
object to receive messages that have been published to a
destination.
In some cases, a connection may both publish and subscribe to a topic. The consumer NoLocal
attribute allows a consumer to inhibit the delivery of messages published by its own connection. The default
value for this attribute is False. The noLocal
value must be supported by destinations that are
topics.
createConsumer
in interface Session
destination
- the Destination
to accessmessageSelector
- only messages with properties matching the message selector expression are delivered. A
value of null or an empty string indicates that there is no message selector for the message consumer.NoLocal
- - if true, and the destination is a topic, inhibits the delivery of messages published by its own
connection. The behavior for NoLocal
is not specified if the destination is a queue.
JMSException
- if the session fails to create a MessageConsumer due to some internal error.
InvalidDestinationException
- if an invalid destination is specified.
InvalidSelectorException
- if the message selector is invalid.public Queue createQueue(String queueName) throws JMSException
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 Session
queueName
- the name of this Queue
Queue
with the given name
JMSException
- if the session fails to create a queue due to some internal error.public Topic createTopic(String topicName) throws 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 Session
topicName
- the name of this Topic
Topic
with the given name
JMSException
- if the session fails to create a topic due to some internal error.public TopicSubscriber createDurableSubscriber(Topic topic, String name) throws 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 Session
topic
- the non-temporary Topic
to subscribe toname
- the name used to identify this subscription
JMSException
- if the session fails to create a subscriber due to some internal error.
InvalidDestinationException
- if an invalid topic is specified.public TopicSubscriber createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException
If a client needs to receive all the messages published on a topic, including the ones published while the
subscriber is inactive, it uses a durable TopicSubscriber
. The JMS provider retains a record of
this durable subscription and insures that all messages from the topic's publishers are retained until they are
acknowledged by this durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same client identifier. In addition, each client must
specify a name which uniquely identifies (within client identifier) each durable subscription it creates. Only
one session at a time can have a TopicSubscriber
for a particular durable subscription. An
inactive durable subscriber is one that exists but does not currently have a message consumer associated with it.
A client can change an existing durable subscription by creating a durable TopicSubscriber
with
the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to
unsubscribing (deleting) the old one and creating a new one.
createDurableSubscriber
in interface Session
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 connection
JMSException
- if the session fails to create a subscriber due to some internal error.
InvalidDestinationException
- if an invalid topic is specified.
InvalidSelectorException
- if the message selector is invalid.public QueueBrowser createBrowser(Queue queue) throws JMSException
QueueBrowser
object to peek at the messages on the specified queue.
createBrowser
in interface Session
queue
- the queue
to access
JMSException
- if the session fails to create a browser due to some internal error.
InvalidDestinationException
- if an invalid destination is specifiedpublic QueueBrowser createBrowser(Queue queue, String messageSelector) throws JMSException
QueueBrowser
object to peek at the messages on the specified queue using a message
selector.
createBrowser
in interface Session
queue
- the queue
to accessmessageSelector
- only messages with properties matching the message selector expression are delivered. A
value of null or an empty string indicates that there is no message selector for the message consumer.
JMSException
- if the session fails to create a browser due to some internal error.
InvalidDestinationException
- if an invalid destination is specified
InvalidSelectorException
- if the message selector is invalid.public TemporaryQueue createTemporaryQueue() throws JMSException
TemporaryQueue
object. Its lifetime will be that of the Connection
unless
it is deleted earlier.
createTemporaryQueue
in interface Session
JMSException
- if the session fails to create a temporary queue due to some internal error.public TemporaryTopic createTemporaryTopic() throws JMSException
TemporaryTopic
object. Its lifetime will be that of the Connection
unless
it is deleted earlier.
createTemporaryTopic
in interface Session
JMSException
- if the session fails to create a temporary topic due to some internal error.public QueueReceiver createReceiver(Queue queue) throws JMSException
QueueReceiver
object to receive messages from the specified queue.
createReceiver
in interface QueueSession
queue
- the Queue
to access
JMSException
InvalidDestinationException
- if an invalid queue is specified.public QueueReceiver createReceiver(Queue queue, String messageSelector) throws JMSException
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 QueueSender createSender(Queue queue) throws JMSException
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 producer
JMSException
- if the session fails to create a sender due to some internal error.
InvalidDestinationException
- if an invalid queue is specified.public TopicSubscriber createSubscriber(Topic topic) throws 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 TopicSession
topic
- the Topic
to subscribe to
JMSException
- if the session fails to create a subscriber due to some internal error.
InvalidDestinationException
- if an invalid topic is specified.public TopicSubscriber createSubscriber(Topic topic, String messageSelector, boolean noLocal) throws 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 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 connection
JMSException
- 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 TopicPublisher createPublisher(Topic topic) throws 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 TopicSession
topic
- the Topic
to publish to, or null if this is an unidentified producer
JMSException
- if the session fails to create a publisher due to some internal error.
InvalidDestinationException
- if an invalid topic is specified.public void unsubscribe(String name) throws 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 Session
name
- the name used to identify this subscription
JMSException
- if the session fails to unsubscribe to the durable subscription due to some internal error.
InvalidDestinationException
- if an invalid subscription name is specified.public boolean isTarget(ActiveMQMessage message)
isTarget
in interface ActiveMQMessageDispatcher
message
- the message to test
public void dispatch(ActiveMQMessage message)
dispatch
in interface ActiveMQMessageDispatcher
message
- public void acknowledge() throws 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.
acknowledge
in interface MessageAcknowledge
JMSException
- if the JMS provider fails to acknowledge the messages due to some internal error.
IllegalStateException
- if this method is called on a closed session.Session.CLIENT_ACKNOWLEDGE
protected void doAcknowledge(boolean isClosing) throws JMSException
JMSException
protected void messageDelivered(boolean sendAcknowledge, ActiveMQMessage message, boolean messageConsumed)
protected void addConsumer(ActiveMQMessageConsumer consumer) throws JMSException
consumer
-
JMSException
protected void removeConsumer(ActiveMQMessageConsumer consumer) throws JMSException
consumer
-
JMSException
protected ConsumerInfo createConsumerInfo(ActiveMQMessageConsumer consumer) throws JMSException
JMSException
protected void addProducer(ActiveMQMessageProducer producer) throws JMSException
producer
-
JMSException
protected void removeProducer(ActiveMQMessageProducer producer) throws JMSException
producer
-
JMSException
protected ProducerInfo createProducerInfo(ActiveMQMessageProducer producer) throws JMSException
JMSException
protected void start()
protected void stop()
protected String getSessionId()
protected void setSessionId(String sessionId)
sessionId
- The sessionId to set.protected long getStartTime()
protected void setStartTime(long startTime)
startTime
- The startTime to set.protected void send(ActiveMQMessageProducer producer, Destination destination, Message message, int deliveryMode, int priority, long timeToLive, boolean reuseMessageId) throws JMSException
producer
- destination
- message
- deliveryMode
- priority
- timeToLive
-
JMSException
protected void doStartTransaction() throws JMSException
JMSException
- if some internal error occurspublic LocalTransactionEventListener getLocalTransactionEventListener()
public void setLocalTransactionEventListener(LocalTransactionEventListener localTransactionEventListener)
localTransactionEventListener
- The localTransactionEventListener to set.protected boolean isXaTransacted()
protected String getNextTransactionId()
protected void setSessionConsumerDispatchState(int value) throws JMSException
JMSException
protected void redeliverUnacknowledgedMessages()
protected void redeliverUnacknowledgedMessages(boolean onlyDeliverTransientConsumed)
protected void clearMessagesInProgress()
protected boolean isTransacted()
protected boolean isClientAcknowledge()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |