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

Interface SubordinateTransaction

All Superinterfaces:

Transaction

All Known Implementing Classes:

TransactionImple, TransactionImple

public interface SubordinateTransaction
extends Transaction

Subordinate transactions are those designed to be driven by a foreign controller, so they expose methods for driving each of the termination phases individually.

Method Summary

Modifier and Type	Method and Description
boolean	activated()
Xid	baseXid()
boolean	doBeforeCompletion() Run beforeCompletion on Synchronizations.
void	doCommit() Drive the subordinate transaction to commit.
void	doForget() Called to tell the transaction to forget any heuristics.
void	doOnePhaseCommit() Drive the transaction to commit.
int	doPrepare() Drive the subordinate transaction through the prepare phase.
void	doRollback() Drive the subordinate transaction to roll back.
Uid	get_uid()
void	recover()

Methods inherited from interface javax.transaction.Transaction

commit, delistResource, enlistResource, getStatus, registerSynchronization, rollback, setRollbackOnly

Method Detail

doPrepare

int doPrepare()

Drive the subordinate transaction through the prepare phase. Any enlisted participants will also be prepared as a result.

Returns:

a TwoPhaseOutcome representing the result.

doCommit

void doCommit()
       throws IllegalStateException,
              HeuristicMixedException,
              HeuristicRollbackException,
              HeuristicCommitException,
              SystemException

Drive the subordinate transaction to commit. It must have previously been prepared.

Throws:

IllegalStateException - thrown if the transaction has not been prepared or is unknown.

HeuristicMixedException - thrown if a heuristic mixed outcome occurs (where some participants committed whilst others rolled back).

HeuristicRollbackException - thrown if the transaction rolled back.

SystemException - thrown if some other error occurs.

HeuristicCommitException

doRollback

void doRollback()
         throws IllegalStateException,
                HeuristicMixedException,
                HeuristicCommitException,
                HeuristicRollbackException,
                SystemException

Drive the subordinate transaction to roll back. It need not have been previously prepared.

Throws:

IllegalStateException - thrown if the transaction is not known by the system or has been previously terminated.

HeuristicMixedException - thrown if a heuristic mixed outcome occurs (can only happen if the transaction was previously prepared and then only if some participants commit whilst others roll back).

HeuristicCommitException - thrown if the transaction commits (can only happen if it was previously prepared).

SystemException - thrown if any other error occurs.

HeuristicRollbackException

doOnePhaseCommit

void doOnePhaseCommit()
               throws IllegalStateException,
                      HeuristicMixedException,
                      SystemException,
                      RollbackException

Drive the transaction to commit. It should not have been previously prepared and will be the only resource in the global transaction.

Throws:

IllegalStateException - if the transaction has already terminated

HeuristicRollbackException - thrown if the transaction rolls back.

HeuristicMixedException

SystemException

RollbackException

doForget

void doForget()
       throws IllegalStateException

Called to tell the transaction to forget any heuristics.

Throws:

IllegalStateException - thrown if the transaction cannot be found.

doBeforeCompletion

boolean doBeforeCompletion()
                    throws SystemException

Run beforeCompletion on Synchronizations. 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.

Returns:

outcome

Throws:

SystemException

activated

boolean activated()

recover

void recover()

baseXid

Xid baseXid()

get_uid

Uid get_uid()