-
- All Superinterfaces:
AutoCloseable
,Runnable
,Session
- All Known Subinterfaces:
XAQueueSession
,XATopicSession
public interface XASession extends Session
TheXASession
interface extends the capability ofSession
by adding access to a Jakarta Messaging provider's support for the Java Transaction API (JTA) (optional). This support takes the form of ajavax.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 itsXAResource
. It uses theXAResource
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 underlyingXASession
.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.- Since:
- JMS 1.0
- Version:
- Jakarta Messaging 2.0
- See Also:
Session
-
-
Field Summary
-
Fields inherited from interface jakarta.jms.Session
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
commit()
Throws aTransactionInProgressException
, since it should not be called for anXASession
object.Session
getSession()
Gets the session associated with thisXASession
.boolean
getTransacted()
Indicates whether the session is in transacted mode.XAResource
getXAResource()
Returns an XA resource to the caller.void
rollback()
Throws aTransactionInProgressException
, since it should not be called for anXASession
object.-
Methods inherited from interface jakarta.jms.Session
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, unsubscribe
-
-
-
-
Method Detail
-
getSession
Session getSession() throws JMSException
Gets the session associated with thisXASession
.- Returns:
- the session object
- Throws:
JMSException
- if an internal error occurs.- Since:
- JMS 1.1
-
getXAResource
XAResource getXAResource()
Returns an XA resource to the caller.- Returns:
- an XA resource to the caller
-
getTransacted
boolean getTransacted() throws JMSException
Indicates whether the session is in transacted mode.- Specified by:
getTransacted
in interfaceSession
- Returns:
- true
- Throws:
JMSException
- if the Jakarta Messaging provider fails to return the transaction mode due to some internal error.
-
commit
void commit() throws JMSException
Throws aTransactionInProgressException
, since it should not be called for anXASession
object.- Specified by:
commit
in interfaceSession
- Throws:
TransactionInProgressException
- if the method is called on anXASession
.IllegalStateException
-- the session is not using a local transaction
- this method has been called by a CompletionListener callback method on its own Session
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.
-
rollback
void rollback() throws JMSException
Throws aTransactionInProgressException
, since it should not be called for anXASession
object.- Specified by:
rollback
in interfaceSession
- Throws:
TransactionInProgressException
- if the method is called on anXASession
.IllegalStateException
-- the session is not using a local transaction
- this method has been called by a CompletionListener callback method on its own Session
JMSException
- if the Jakarta Messaging provider fails to roll back the transaction due to some internal error.
-
-