Package org.apache.activemq

Class ActiveMQXASession

  • All Implemented Interfaces:
    AutoCloseable, Runnable, javax.jms.QueueSession, javax.jms.Session, javax.jms.TopicSession, javax.jms.XAQueueSession, javax.jms.XASession, javax.jms.XATopicSession, ActiveMQDispatcher, StatsCapable
    public class ActiveMQXASession
extends ActiveMQSession
implements javax.jms.QueueSession, javax.jms.TopicSession, javax.jms.XAQueueSession, javax.jms.XATopicSession
    The XASession interface extends the capability of Session 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 a regular JMS Session. Behind the scenes, the application server controls the transaction management of the underlying XASession.

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

    See Also:
    Session, QueueSession, TopicSession, XASession

    • Constructor Detail

      • ActiveMQXASession

        public ActiveMQXASession​(ActiveMQXAConnection connection,
                         SessionId sessionId,
                         int theAcknowlegeMode,
                         boolean dispatchAsync)
                  throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

    • Method Detail

      • rollback

        public void rollback()
              throws javax.jms.JMSException
        Description copied from class: ActiveMQSession
        Rolls back any messages done in this transaction and releases any locks currently held.
        Specified by:
        rollback in interface javax.jms.Session
        Specified by:
        rollback in interface javax.jms.XASession
        Overrides:
        rollback in class ActiveMQSession
        Throws:
        javax.jms.JMSException - if the JMS provider fails to roll back the transaction due to some internal error.
        javax.jms.IllegalStateException - if the method is not called by a transacted session.

      • commit

        public void commit()
            throws javax.jms.JMSException
        Description copied from class: ActiveMQSession
        Commits all messages done in this transaction and releases any locks currently held.
        Specified by:
        commit in interface javax.jms.Session
        Specified by:
        commit in interface javax.jms.XASession
        Overrides:
        commit in class ActiveMQSession
        Throws:
        javax.jms.JMSException - if the JMS provider fails to commit the transaction due to some internal error.
        javax.jms.TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.
        javax.jms.IllegalStateException - if the method is not called by a transacted session.

      • getSession

        public javax.jms.Session getSession()
                             throws javax.jms.JMSException
        Specified by:
        getSession in interface javax.jms.XASession
        Throws:
        javax.jms.JMSException

      • getXAResource

        public XAResource getXAResource()
        Specified by:
        getXAResource in interface javax.jms.XASession

      • getQueueSession

        public javax.jms.QueueSession getQueueSession()
                                       throws javax.jms.JMSException
        Specified by:
        getQueueSession in interface javax.jms.XAQueueSession
        Throws:
        javax.jms.JMSException

      • getTopicSession

        public javax.jms.TopicSession getTopicSession()
                                       throws javax.jms.JMSException
        Specified by:
        getTopicSession in interface javax.jms.XATopicSession
        Throws:
        javax.jms.JMSException

      • doStartTransaction

        protected void doStartTransaction()
                           throws javax.jms.JMSException
        Description copied from class: ActiveMQSession
        Send TransactionInfo to indicate transaction has started
        Overrides:
        doStartTransaction in class ActiveMQSession
        Throws:
        javax.jms.JMSException - if some internal error occurs