javax.jms

Interface XAJMSContext

Contents
  • All Superinterfaces:
    AutoCloseable, JMSContext

    public interface XAJMSContext
extends JMSContext
    The XAJMSContext interface extends the capability of JMSContext 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 an ordinary JMSContext. Behind the scenes, the application server controls the transaction management of the underlying XAJMSContext.

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

    Since:
    JMS 2.0
    Version:
    JMS 2.0

    • Method Detail

      • getContext

        JMSContext getContext()
        Returns the JMSContext object associated with this XAJMSContext.
        Returns:
        the JMSContext object associated with this XAJMSContext

      • getXAResource

        XAResource getXAResource()
        Returns an XAResource to the caller.
        Returns:
        an XAResource

      • getTransacted

        boolean getTransacted()
        Returns whether the session is in transacted mode; this method always returns true.
        Specified by:
        getTransacted in interface JMSContext
        Returns:
        true

      • commit

        void commit()
        Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.
        Specified by:
        commit in interface JMSContext
        Throws:
        TransactionInProgressRuntimeException - if the method is called on an XAJMSContext.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/jms/xajmscontext.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.