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 Summary

Modifier and Type	Method and Description
void	deregisterXAResource(XAResource xaResource) Delist XA resource from a current transaction.
boolean	isTransactionAvailable() Check if transaction is active.
void	registerSynchronization(Synchronization synchronization) Register synchronization with a current transaction.
void	registerXAResource(XAResource xaResource) Enlist XA resource to a current transaction.

Method Detail

isTransactionAvailable

boolean isTransactionAvailable()
                        throws JMSException

Check if transaction is active. If error occurs wrap an original exception with JMSException.

Returns:

whether transaction is active or not.

Throws:

JMSException - if transaction service has failed in unexpected way to obtain transaction status

registerSynchronization

void registerSynchronization(Synchronization synchronization)
                      throws JMSException

Register synchronization with a current transaction. If error occurs wrap an original exception with JMSException.

Parameters:

synchronization - synchronization to be registered.

Throws:

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 JMSException

Enlist XA resource to a current transaction. If error occurs wrap an original exception with JMSException.

Parameters:

xaResource - resource to be enlisted.

Throws:

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 JMSException

Delist XA resource from a current transaction. If error occurs wrap an original exception with JMSException.

Parameters:

xaResource - resource to be delisted.

Throws:

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.