public interface XASession extends Session
XASession
interface extends the capability of
Session
by adding access to a JMS provider's support for the
Java Transaction API (JTA) (optional). This support takes the form of a
javax.transaction.xa.XAResource
object. The functionality of
this object closely resembles that defined by the standard X/Open XA
Resource interface.
An application server controls the transactional assignment of an
XASession
by obtaining its XAResource
. It uses
the XAResource
to assign the session to a transaction, prepare
and commit work on the transaction, and so on.
An XAResource
provides some fairly sophisticated facilities
for interleaving work on multiple transactions, recovering a list of
transactions in progress, and so on. A JTA aware JMS provider must fully
implement this functionality. This could be done by using the services
of a database that supports XA, or a JMS provider may choose to implement
this functionality from scratch.
A client of the application server is given what it thinks is a
regular JMS Session
. Behind the scenes, the application server
controls the transaction management of the underlying
XASession
.
The XASession
interface is optional. JMS providers
are not required to support this interface. This interface is for
use by JMS providers to support transactional environments.
Client programs are strongly encouraged to use the transactional support
available in their environment, rather than use these XA
interfaces directly.
Session
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED
Modifier and Type | Method and Description |
---|---|
void |
commit()
Throws a
TransactionInProgressException , since it should
not be called for an XASession object. |
Session |
getSession()
Gets the session associated with this
XASession . |
boolean |
getTransacted()
Indicates whether the session is in transacted mode.
|
XAResource |
getXAResource()
Returns an XA resource to the caller.
|
void |
rollback()
Throws a
TransactionInProgressException , since it should
not be called for an XASession object. |
close, createBrowser, createBrowser, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createQueue, createStreamMessage, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, recover, run, setMessageListener, unsubscribe
Session getSession() throws JMSException
XASession
.JMSException
- if an internal error occurs.XAResource getXAResource()
boolean getTransacted() throws JMSException
getTransacted
in interface Session
JMSException
- if the JMS provider fails to return the
transaction mode due to some internal error.void commit() throws JMSException
TransactionInProgressException
, since it should
not be called for an XASession
object.commit
in interface Session
TransactionInProgressException
- if the method is called on
an XASession
.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.void rollback() throws JMSException
TransactionInProgressException
, since it should
not be called for an XASession
object.rollback
in interface Session
TransactionInProgressException
- if the method is called on
an XASession
.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.Copyright 2004-2024 Solace Corporation. All rights reserved.