com.arjuna.ats.internal.jta.transaction.arjunacore.jca

Class XATerminatorImple

java.lang.Object

com.arjuna.ats.internal.jta.transaction.arjunacore.jca.XATerminatorImple

All Implemented Interfaces:

XATerminatorExtensions, javax.resource.spi.XATerminator

Direct Known Subclasses:

XATerminator

public class XATerminatorImple
extends Object
implements javax.resource.spi.XATerminator, XATerminatorExtensions

The XATerminator implementation.

Author:

mcl

Constructor Summary

Constructors

Constructor and Description
XATerminatorImple()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	beforeCompletion(Xid xid) Call beforeCompletion on the registered instance.
void	commit(Xid xid, boolean onePhase) Commit the transaction identified and hence any inflow-associated work.
Xid[]	doRecover(Xid xid, String parentNodeName) Return a list of indoubt transactions.
void	forget(Xid xid) If the transaction subordinate generated a heuristic, then this operation will be called later once that heuristic has been resolved.
int	prepare(Xid xid) Prepare the imported transaction.
Xid[]	recover(int flag) Return a list of indoubt transactions.
void	rollback(Xid xid) Rollback the imported transaction subordinate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XATerminatorImple

public XATerminatorImple()

Method Detail

commit

public void commit(Xid xid,
          boolean onePhase)
            throws XAException

Commit the transaction identified and hence any inflow-associated work.

Specified by:

commit in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction to commit

onePhase - whether or not this is a one-phase commit (should only be true if there is a single resource associated with the transaction).

Throws:

XAException - thrown if there are any errors, including if the transaction cannot commit and has to roll back.

forget

public void forget(Xid xid)
            throws XAException

If the transaction subordinate generated a heuristic, then this operation will be called later once that heuristic has been resolved.

Specified by:

forget in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction.

Throws:

XAException - if any error happens.

prepare

public int prepare(Xid xid)
            throws XAException

Prepare the imported transaction.

Specified by:

prepare in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction to prepare.

Returns:

either XAResource.XA_OK if the transaction prepared, or XAResource.XA_RDONLY if it was a read-only transaction (and in which case, a second phase message is not expected/required.)

Throws:

XAException - thrown if any error occurs, including if the transaction has rolled back.

recover

public Xid[] recover(int flag)
              throws XAException

Return a list of indoubt transactions. This may include those transactions that are currently in-flight and running 2PC and do not need recovery invoked on them.

Specified by:

recover in interface javax.resource.spi.XATerminator

Parameters:

flag - either XAResource.TMSTARTRSCAN to indicate the start of a recovery scan, or XAResource.TMENDRSCAN to indicate the end of the recovery scan.

Returns:

a list of potentially indoubt transactions or null.

Throws:

XAException - thrown if any error occurs.

doRecover

public Xid[] doRecover(Xid xid,
              String parentNodeName)
                throws XAException

Return a list of indoubt transactions. This may include those transactions that are currently in-flight and running 2PC and do not need recovery invoked on them.

Parameters:

nodeName - Only recover transactions for this node (unless set to NodeNameXAResourceOrphanFilter.RECOVER_ALL_NODES)

Returns:

a list of potentially indoubt transactions or null.

Throws:

XAException - thrown if any error occurs.

rollback

public void rollback(Xid xid)
              throws XAException

Rollback the imported transaction subordinate.

Specified by:

rollback in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction to roll back.

Throws:

XAException - thrown if there are any errors.

beforeCompletion

public boolean beforeCompletion(Xid xid)
                         throws SystemException

Description copied from interface: XATerminatorExtensions

Call beforeCompletion on the registered instance. Exceptions will cause the transaction to be set rollback only. Note: this will run beforeCompletion even on setRollbackOnly transactions. Users may wish to avoid calling this method in such cases, or prior to calling rollback.

Specified by:

beforeCompletion in interface XATerminatorExtensions

Parameters:

xid - the transaction instance.

Returns:

success (or not).

Throws:

SystemException