public interface XASession extends Session
XASession interface extends the capability of Session by adding access to a Jakarta Messaging 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 Jakarta Messaging provider must fully implement this
functionality. This could be done by using the services of a database that supports XA, or a Jakarta Messaging provider may choose
to implement this functionality from scratch.
A client of the application server is given what it thinks is a regular Jakarta Messaging Session. Behind the scenes, the
application server controls the transaction management of the underlying XASession.
The XASession interface is optional. Jakarta Messaging providers are not required to support this interface. This interface
is for use by Jakarta Messaging 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.
SessionAUTO_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.
|
javax.transaction.xa.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, createDurableConsumer, createDurableConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createQueue, createSharedConsumer, createSharedConsumer, createSharedDurableConsumer, createSharedDurableConsumer, createStreamMessage, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, recover, run, setMessageListener, unsubscribeSession getSession() throws JMSException
XASession.JMSException - if an internal error occurs.javax.transaction.xa.XAResource getXAResource()
boolean getTransacted()
throws JMSException
getTransacted in interface SessionJMSException - if the Jakarta Messaging 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 SessionTransactionInProgressException - if the method is called on an XASession.IllegalStateException - JMSException - if the Jakarta Messaging 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.void rollback()
throws JMSException
TransactionInProgressException, since it should not be called for an XASession object.rollback in interface SessionTransactionInProgressException - if the method is called on an XASession.IllegalStateException - JMSException - if the Jakarta Messaging provider fails to roll back the transaction due to some internal error.