Package org.wildfly.transaction.client.spi

Interface SubordinateTransactionControl

public interface SubordinateTransactionControl

The control interface for subordinate transactions. This interface is used in the following cases:

• When a subordinate transaction is locally inflowed, an instance of this interface is used to control the lifecycle of the local transaction (the transaction's lifecycle methods are blocked in this case).
• The local handle for a subordinate transaction implements this interface.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field	Description
static SubordinateTransactionControl	EMPTY	An empty subordinate transaction controller.

Method Summary

Modifier and Type	Method	Description
void	beforeCompletion()	Perform before-commit operations, including running all transaction synchronizations.
void	commit(boolean onePhase)	Commit a transaction, either in a single phase or after a previous prepare.
void	end(int flags)	End work on behalf of a transaction branch, disassociating the subordinate from the transaction branch.
void	forget()	Forget the (previously prepared) transaction.
int	prepare()	Prepare the transaction.
void	rollback()	Roll back the subordinate.

Field Detail

EMPTY

static final SubordinateTransactionControl EMPTY

An empty subordinate transaction controller.

Method Detail

rollback

void rollback()
       throws XAException

Roll back the subordinate. In the event of error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_NOTA
• XAException.XAER_INVAL
• XAException.XAER_PROTO
• XAException.XA_HEURHAZ
• XAException.XA_HEURCOM
• XAException.XA_HEURRB
• XAException.XA_HEURMIX

Throws:

XAException - (with one of the above error codes) if an error occurs

end

void end(int flags)
  throws XAException

End work on behalf of a transaction branch, disassociating the subordinate from the transaction branch. The flags parameter may equal one of the following:

• XAResource.TMFAIL indicating that the transaction work has failed, and that the subordinate may mark the transaction as rollback-only
• XAResource.TMSUCCESS indicating that the work has completed successfully and that a subsequent prepare() is likely

In the event of error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_INVAL
• XAException.XAER_PROTO
• XAException.XA_RBCOMMFAIL
• XAException.XA_RBDEADLOCK
• XAException.XA_RBINTEGRITY
• XAException.XA_RBOTHER
• XAException.XA_RBPROTO
• XAException.XA_RBROLLBACK
• XAException.XA_RBTIMEOUT
• XAException.XA_RBTRANSIENT

Parameters:

flags - one of the valid flag values: TMSUSPEND, TMFAIL, or TMSUCCESS

Throws:

XAException - (with one of the above error codes) if an error occurs

beforeCompletion

void beforeCompletion()
               throws XAException

Perform before-commit operations, including running all transaction synchronizations. In the event of an error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_INVAL
• XAException.XAER_PROTO
• XAException.XA_RBCOMMFAIL
• XAException.XA_RBDEADLOCK
• XAException.XA_RBINTEGRITY
• XAException.XA_RBOTHER
• XAException.XA_RBPROTO
• XAException.XA_RBROLLBACK
• XAException.XA_RBTIMEOUT
• XAException.XA_RBTRANSIENT

Throws:

XAException - (with one of the above error codes) if an error occurs

prepare

int prepare()
     throws XAException

Prepare the transaction. If before-commit processing was not yet run, it is run. In the event of an error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_INVAL
• XAException.XAER_PROTO
• XAException.XA_RBCOMMFAIL
• XAException.XA_RBDEADLOCK
• XAException.XA_RBINTEGRITY
• XAException.XA_RBOTHER
• XAException.XA_RBPROTO
• XAException.XA_RBROLLBACK
• XAException.XA_RBTIMEOUT
• XAException.XA_RBTRANSIENT

Returns:

XAResource.XA_OK or XAResource.XA_RDONLY

Throws:

XAException - (with one of the above error codes) if an error occurs

forget

void forget()
     throws XAException

Forget the (previously prepared) transaction. In the event of error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_INVAL
• XAException.XAER_PROTO

Throws:

XAException - (with one of the above error codes) if an error occurs

commit

void commit(boolean onePhase)
     throws XAException

Commit a transaction, either in a single phase or after a previous prepare. In the event of error, the following error codes are possible:

• XAException.XAER_RMERR
• XAException.XAER_RMFAIL
• XAException.XAER_INVAL
• XAException.XAER_PROTO
• XAException.XA_HEURHAZ
• XAException.XA_HEURCOM
• XAException.XA_HEURRB
• XAException.XA_HEURMIX

If the onePhase flag is true, one of the following error codes is also possible:

• XAException.XA_RBCOMMFAIL
• XAException.XA_RBDEADLOCK
• XAException.XA_RBINTEGRITY
• XAException.XA_RBOTHER
• XAException.XA_RBPROTO
• XAException.XA_RBROLLBACK
• XAException.XA_RBTIMEOUT
• XAException.XA_RBTRANSIENT

Parameters:

onePhase - true to commit in a single phase, false to commit after prepare

Throws:

XAException - (with one of the above error codes) if an error occurs