Package org.jboss.narayana.jta.jms

Interface TransactionHelper

All Known Implementing Classes:
TransactionHelperImpl
public interface TransactionHelper
Utility class to make transaction status checking and resources registration easier.
Author:
Gytis Trikleris

  • Method Details

    • isTransactionAvailable

      boolean isTransactionAvailable() throws jakarta.jms.JMSException
      Check if transaction is active. If error occurs wrap an original exception with JMSException.
      Returns:
      whether transaction is active or not.
      Throws:
      jakarta.jms.JMSException - if transaction service has failed in unexpected way to obtain transaction status

    • registerSynchronization

      void registerSynchronization(jakarta.transaction.Synchronization synchronization) throws jakarta.jms.JMSException
      Register synchronization with a current transaction. If error occurs wrap an original exception with JMSException.
      Parameters:
      synchronization - synchronization to be registered.
      Throws:
      jakarta.jms.JMSException - if error occurred registering synchronization that occurs when transaction service fails in an unexpected way or when the transaction is marked for rollback only or when transaction is in a state where Synchronization callbacks cannot be registered

    • registerXAResource

      void registerXAResource(XAResource xaResource) throws jakarta.jms.JMSException
      Enlist XA resource to a current transaction. If error occurs wrap an original exception with JMSException.
      Parameters:
      xaResource - resource to be enlisted.
      Throws:
      jakarta.jms.JMSException - if error occurred enlisting resource that occurs when transaction service fails in an unexpected way or when the transaction is marked for rollback only or when transaction is in a state where resources cannot be enlisted.

    • deregisterXAResource

      void deregisterXAResource(XAResource xaResource) throws jakarta.jms.JMSException
      Delist XA resource from a current transaction. If error occurs wrap an original exception with JMSException.
      Parameters:
      xaResource - resource to be delisted.
      Throws:
      jakarta.jms.JMSException - if error occurred delisting resource. that occurs when transaction service fails in an unexpected way or when transaction is in a state where resources cannot be delisted.