Jakarta EE 11.0.0 · jakarta.jms.XAJMSContext · APIdia, the JavaDoc alternative

The 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.

Modifier and Type	Method and Description
public void	commit() Redeclares jakarta.jms.JMSContext.commit. Throws a `TransactionInProgressRuntimeException`, since it should not be called for an `XAJMSContext` object.
public JMSContext	Returns: the `JMSContext` object associated with this `XAJMSContext` getContext() Returns the `JMSContext` object associated with this `XAJMSContext`.
public boolean	Returns: true getTransacted() Redeclares jakarta.jms.JMSContext.getTransacted. Returns whether the session is in transacted mode; this method always returns true.
public XAResource	Returns: an `XAResource` getXAResource() Returns an `XAResource` to the caller.
public void	rollback() Redeclares jakarta.jms.JMSContext.rollback. Throws a `TransactionInProgressRuntimeException`, since it should not be called for an `XAJMSContext` object.

Method Detail

commit back to summary

commit	back to summary
public void commit() Redeclares jakarta.jms.JMSContext.commit. Throws a `TransactionInProgressRuntimeException`, since it should not be called for an `XAJMSContext` object. Annotations @Override Exceptions TransactionInProgressRuntimeException: if the method is called on an `XAJMSContext`.

public void commit()

Redeclares jakarta.jms.JMSContext.commit.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.

Annotations

@Override

Exceptions

TransactionInProgressRuntimeException:: if the method is called on an XAJMSContext.

getContext back to summary

getContext	back to summary
public JMSContext getContext() Returns the `JMSContext` object associated with this `XAJMSContext`. Returns:JMSContext the `JMSContext` object associated with this `XAJMSContext`

public JMSContext getContext()

Returns the JMSContext object associated with this XAJMSContext.

Returns:JMSContext: the JMSContext object associated with this XAJMSContext

getTransacted	back to summary
public boolean getTransacted() Redeclares jakarta.jms.JMSContext.getTransacted. Returns whether the session is in transacted mode; this method always returns true. Returns:boolean true Annotations @Override

getTransacted

back to summary

public boolean getTransacted()

Redeclares jakarta.jms.JMSContext.getTransacted.

Returns whether the session is in transacted mode; this method always returns true.

Returns:boolean

true

Annotations

@Override

getXAResource back to summary

getXAResource	back to summary
public XAResource getXAResource() Returns an `XAResource` to the caller. Returns:XAResource an `XAResource`

public XAResource getXAResource()

Returns an XAResource to the caller.

Returns:XAResource: an XAResource

rollback back to summary

rollback	back to summary
public void rollback() Redeclares jakarta.jms.JMSContext.rollback. Throws a `TransactionInProgressRuntimeException`, since it should not be called for an `XAJMSContext` object. Annotations @Override Exceptions TransactionInProgressRuntimeException: if the method is called on an `XAJMSContext`.

public void rollback()

Redeclares jakarta.jms.JMSContext.rollback.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.

Annotations

@Override

Exceptions

TransactionInProgressRuntimeException:: if the method is called on an XAJMSContext.

public Interface XAJMSContext

Field Summary

Method Summary

Method Detail