org.infinispan.commons.tx

Class TransactionImpl

java.lang.Object

org.infinispan.commons.tx.TransactionImpl

All Implemented Interfaces:

Transaction

Direct Known Subclasses:

EmbeddedTransaction

public class TransactionImpl
extends Object
implements Transaction

A basic Transaction implementation.

Since:

9.1

Author:

Bela Ban, Pedro Ruivo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionImpl()

Method Summary

Modifier and Type	Method and Description
void	commit() Attempt to commit this transaction.
boolean	delistResource(XAResource xaRes, int flag) De-list an XA resource from this transaction.
boolean	enlistResource(XAResource resource) Enlist an XA resource with this transaction.
boolean	equals(Object obj)
Collection<XAResource>	getEnlistedResources()
Collection<Synchronization>	getEnlistedSynchronization()
int	getStatus() Get the status of the transaction.
XidImpl	getXid()
int	hashCode() Must be defined for increased performance
void	registerSynchronization(Synchronization sync) Register a Synchronization callback with this transaction.
void	rollback() Rolls back this transaction.
void	runCommit(boolean forceRollback) Runs the second phase of two-phase-commit protocol.
boolean	runPrepare()
void	setRollbackOnly() Mark the transaction so that the only possible outcome is a rollback.
void	setXid(XidImpl xid)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TransactionImpl

protected TransactionImpl()

Method Detail

commit

public void commit()
            throws RollbackException,
                   HeuristicMixedException,
                   HeuristicRollbackException,
                   SecurityException

Attempt to commit this transaction.

Specified by:

commit in interface Transaction

Throws:

RollbackException - If the transaction was marked for rollback only, the transaction is rolled back and this exception is thrown.

HeuristicMixedException - If a heuristic decision was made and some some parts of the transaction have been committed while other parts have been rolled back.

HeuristicRollbackException - If a heuristic decision to roll back the transaction was made.

SecurityException - If the caller is not allowed to commit this transaction.

rollback

public void rollback()
              throws IllegalStateException,
                     SystemException

Rolls back this transaction.

Specified by:

rollback in interface Transaction

Throws:

IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the transaction is no longer active, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.

setRollbackOnly

public void setRollbackOnly()
                     throws IllegalStateException

Mark the transaction so that the only possible outcome is a rollback.

Specified by:

setRollbackOnly in interface Transaction

Throws:

IllegalStateException - If the transaction is not in an active state.

getStatus

public int getStatus()

Get the status of the transaction.

Specified by:

getStatus in interface Transaction

Returns:

The status of the transaction. This is one of the Status constants.

enlistResource

public boolean enlistResource(XAResource resource)
                       throws RollbackException,
                              IllegalStateException,
                              SystemException

Enlist an XA resource with this transaction.

Specified by:

enlistResource in interface Transaction

Parameters:

resource - The XAResource object associated with the resource (connection).

Returns:

true if the resource could be enlisted with this transaction, otherwise false.

Throws:

RollbackException - If the transaction is marked for rollback only.

IllegalStateException - If the transaction is in a state where resources cannot be enlisted. This could be because the transaction is no longer active, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.

delistResource

public boolean delistResource(XAResource xaRes,
                              int flag)
                       throws IllegalStateException,
                              SystemException

De-list an XA resource from this transaction.

Specified by:

delistResource in interface Transaction

Parameters:

xaRes - The XAResource object associated with the resource (connection).

flag - One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL.

Returns:

true if the resource could be de-listed from this transaction, otherwise false.

Throws:

IllegalStateException - If the transaction is in a state where resources cannot be de-listed. This could be because the transaction is no longer active.

SystemException - If the transaction service fails in an unexpected way.

registerSynchronization

public void registerSynchronization(Synchronization sync)
                             throws RollbackException,
                                    IllegalStateException

Register a Synchronization callback with this transaction.

Specified by:

registerSynchronization in interface Transaction

Parameters:

sync - The Synchronization object for the transaction associated with the target object.

Throws:

RollbackException - If the transaction is marked for rollback only.

IllegalStateException - If the transaction is in a state where Synchronization callbacks cannot be registered. This could be because the transaction is no longer active, or because it is in the prepared state.

getEnlistedResources

public Collection<XAResource> getEnlistedResources()

runPrepare

public boolean runPrepare()

runCommit

public void runCommit(boolean forceRollback)
               throws HeuristicMixedException,
                      HeuristicRollbackException,
                      RollbackException

Runs the second phase of two-phase-commit protocol.

If forceRollback is true, then a RollbackException is thrown with the message FORCE_ROLLBACK_MESSAGE.

Parameters:

forceRollback - force the transaction to rollback.

Throws:

HeuristicMixedException

HeuristicRollbackException

RollbackException

toString

public String toString()

Overrides:

toString in class Object

getXid

public XidImpl getXid()

setXid

public void setXid(XidImpl xid)

getEnlistedSynchronization

public Collection<Synchronization> getEnlistedSynchronization()

hashCode

public final int hashCode()

Must be defined for increased performance

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object