public interface XAJMSContext extends JMSContext
XAJMSContext
interface extends the capability of JMSContext
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 an ordinary JMSContext
. Behind the scenes, the
application server controls the transaction management of the underlying XAJMSContext
.
The XAJMSContext
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.
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED
Modifier and Type | Method and Description |
---|---|
void |
commit()
Throws a
TransactionInProgressRuntimeException , since it should not be called for an XAJMSContext
object. |
JMSContext |
getContext()
Returns the
JMSContext object associated with this XAJMSContext . |
boolean |
getTransacted()
Returns whether the session is in transacted mode; this method always returns true.
|
javax.transaction.xa.XAResource |
getXAResource()
Returns an
XAResource to the caller. |
void |
rollback()
Throws a
TransactionInProgressRuntimeException , since it should not be called for an XAJMSContext
object. |
acknowledge, close, createBrowser, createBrowser, createBytesMessage, createConsumer, createConsumer, createConsumer, createContext, createDurableConsumer, createDurableConsumer, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createQueue, createSharedConsumer, createSharedConsumer, createSharedDurableConsumer, createSharedDurableConsumer, createStreamMessage, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAutoStart, getClientID, getExceptionListener, getMetaData, getSessionMode, recover, setAutoStart, setClientID, setExceptionListener, start, stop, unsubscribe
JMSContext getContext()
JMSContext
object associated with this XAJMSContext
.JMSContext
object associated with this XAJMSContext
javax.transaction.xa.XAResource getXAResource()
XAResource
to the caller.XAResource
boolean getTransacted()
getTransacted
in interface JMSContext
void commit()
TransactionInProgressRuntimeException
, since it should not be called for an XAJMSContext
object.commit
in interface JMSContext
TransactionInProgressRuntimeException
- if the method is called on an XAJMSContext
.void rollback()
TransactionInProgressRuntimeException
, since it should not be called for an XAJMSContext
object.rollback
in interface JMSContext
TransactionInProgressRuntimeException
- if the method is called on an XAJMSContext
.