org.multiverse.stms
Class AbstractTransaction<C extends AbstractTransactionConfiguration,S extends AbstractTransactionSnapshot>

java.lang.Object
  org.multiverse.stms.AbstractTransaction<C,S>

All Implemented Interfaces:

Transaction, MultiverseConstants

public abstract class AbstractTransaction<C extends AbstractTransactionConfiguration,S extends AbstractTransactionSnapshot>
extends java.lang.Object
implements Transaction, MultiverseConstants

An abstract Transaction implementation that contains most of the plumbing logic. Extend this and prevent duplicate logic.

The do-methods can be overridden.

The subclass needs to call the init() when it has completed its constructor. Can't be done inside the constructor of the AbstractTransaction because fields in the subclass perhaps are not set.

AbstractTransaction requires the clock.time to be at least 1. It used the version field to encode the transaction state. See the version field for more information.

Author:

Peter Veentjer.

Field Summary

protected C

config

Fields inherited from interface org.multiverse.MultiverseConstants

___SANITY_CHECKS_ENABLED

Constructor Summary

AbstractTransaction(C config)

Method Summary

void	abort() Aborts this Transaction.
void	commit() Commits this Transaction.
protected void	doAbortActive() Method is designed to be overridden to add custom behavior on the abort of the transaction.
protected void	doAbortPrepared()
protected void	doClear()
protected void	doInit() Method is designed to be overridden to add custom behavior on the init of the transaction.
protected void	doPrepare()
protected boolean	doRegisterRetryLatch(Latch latch, long wakeupVersion) Register retry.
void	endOr()
void	endOrAndStartElse()
int	getAttempt()
TransactionConfiguration	getConfiguration() Gets the TransactionConfiguration that is used by this Transaction.
long	getReadVersion() Returns the clock version of the stm when this Transaction started.
long	getRemainingTimeoutNs()
protected S	getSnapshot()
TransactionStatus	getStatus() Returns the status of this Transaction.
protected void	init()
protected void	makeChangesPermanent()
void	prepare() Prepares this transaction to be committed.
void	registerLifecycleListener(TransactionLifecycleListener listener) Registers a TransactionLifecycleListener on this Transaction.
void	registerRetryLatch(Latch latch) Registers the retry Latch on this Transaction.
void	restart() Restarts this Transaction.
void	setAttempt(int attempt)
void	setRemainingTimeoutNs(long newTimeoutNs)
void	startOr()
protected void	storeSnapshot(S snapshot)
protected S	takeSnapshot()

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final C extends AbstractTransactionConfiguration config

Constructor Detail

AbstractTransaction

public AbstractTransaction(C config)

Method Detail

getAttempt

public final int getAttempt()

Specified by:

getAttempt in interface Transaction

setAttempt

public final void setAttempt(int attempt)

Specified by:

setAttempt in interface Transaction

getRemainingTimeoutNs

public final long getRemainingTimeoutNs()

Specified by:

getRemainingTimeoutNs in interface Transaction

setRemainingTimeoutNs

public final void setRemainingTimeoutNs(long newTimeoutNs)

Specified by:

setRemainingTimeoutNs in interface Transaction

getReadVersion

public final long getReadVersion()

Description copied from interface: Transaction

Returns the clock version of the stm when this Transaction started. This version is needed to provide a transaction level read consistent view (so a transaction will always see a stable view of the objects at some point in time).

The value is unspecified once the Transaction is aborted or committed.

Method depends on long as time, and is going to be removed or replaced in the future.

Specified by:

getReadVersion in interface Transaction

Returns:

the version of the stm when this Transaction started.

getStatus

public final TransactionStatus getStatus()

Description copied from interface: Transaction

Returns the status of this Transaction.

Specified by:

getStatus in interface Transaction

Returns:

the status of this Transaction.

getConfiguration

public TransactionConfiguration getConfiguration()

Description copied from interface: Transaction

Gets the TransactionConfiguration that is used by this Transaction.

Specified by:

getConfiguration in interface Transaction

Returns:

the used TransactionConfiguration.

init

protected final void init()

doInit

protected void doInit()

Method is designed to be overridden to add custom behavior on the init of the transaction.

doClear

protected void doClear()

registerLifecycleListener

public final void registerLifecycleListener(TransactionLifecycleListener listener)

Description copied from interface: Transaction

Registers a TransactionLifecycleListener on this Transaction. It can be used to receive a callback from the transaction if the TransactionStatus of that transaction. Without this functionality it would not be possible to execute compensating or deferred action once a transaction aborts or commits.

If the execution of one of the listeners fails, the others won't be executed. If one of the listeners fails before the commit/abort, the transaction is aborted (no matter what).

The listeners are executed in the order they are registered.

If the same listener is added multiple times, it will be notified multiple times.

The listener will be executed on the thread that starts the commit/abort.

If the listener is added after the Transaction is prepared, the preCommit event will not be called on the listener.

If the listener accesses the stm after the transaction has been committed or aborted, it could see changes made after that transaction. So all assumptions about state are possibly wrong so one needs to take care of re-validating state if needed.

A good use case of this feature is starting up threads. If you need to start threads, you don't want to start them immediately because eventually the transaction could be aborted.

Specified by:

registerLifecycleListener in interface Transaction

Parameters:

listener - the TransactionLifecycleListener to registerLifecycleListener

prepare

public final void prepare()

Description copied from interface: Transaction

Prepares this transaction to be committed. It can lock resources to make sure that no conflicting changes are made after the transaction has been prepared. If the transaction already is prepared, the call is ignored. If the prepare fails, the transaction automatically is aborted.

It is very important that the transaction eventually commits or aborts, if it doesn't no other transaction reading/writing the committed resources, can't commit.

Specified by:

prepare in interface Transaction

doPrepare

protected void doPrepare()

restart

public final void restart()

Description copied from interface: Transaction

Restarts this Transaction. It doesn't matter what the transaction state of the transaction is. This is the preferred way to restart a transaction once a recoverable exception or retry occurred.

If the Transaction is prepared or committed, it will be aborted before it is restarted. If there are TransactionLifecycleListeners that cause problems while executing the pre/post abort notification, the transaction will be aborted and the exception will be propagated.

Specified by:

restart in interface Transaction

abort

public final void abort()

Description copied from interface: Transaction

Aborts this Transaction. This means that the changes made in this transaction are not committed. It depends on the implementation if this operation is simple (ditching objects for example), or if changes need to be rolled back. If an exception is thrown while executing the abort, the transaction is still aborted. And example of such a situation is a pre-abort task that fails. So the transaction always is aborted (unless it is committed).

If the Transaction already is aborted, the call is ignored.

Specified by:

abort in interface Transaction

doAbortPrepared

protected void doAbortPrepared()

doAbortActive

protected void doAbortActive()

Method is designed to be overridden to add custom behavior on the abort of the transaction.

commit

public final void commit()

Description copied from interface: Transaction

Commits this Transaction. If the Transaction is:

1. active: it is prepared for commit and then committed
2. prepared: it is committed (so changes persisted)
3. aborted: a DeadTransactionException is thrown
4. committed: a DeadTransactionException is thrown

So it is safe to call while active or prepared.

Transaction will be aborted if the commit does not succeed.

Commit will not throw any validation exceptions after the transaction is prepared.

Specified by:

commit in interface Transaction

makeChangesPermanent

protected void makeChangesPermanent()

registerRetryLatch

public final void registerRetryLatch(Latch latch)

Description copied from interface: Transaction

Registers the retry Latch on this Transaction. This functionality is required for the retry mechanism (so blocking!) and is something different than 'just' restarting. The Latch contains all the 'waiting' logic, so you can do timed and non interruptible timeouts on that structure. A latch can be compared to a Future because it also pops closed once some event occurs (an interesting write in the case of a Latch).

Specified by:

registerRetryLatch in interface Transaction

Parameters:

latch - the Latch to register.

doRegisterRetryLatch

protected boolean doRegisterRetryLatch(Latch latch,
                                       long wakeupVersion)

Register retry. Default implementation returns 0, indicating that a retry is not possible.

This method is designed to be overridden.

Parameters:

latch - the latch to registerLifecycleListener. Value will never be null.

wakeupVersion - the minimal version of the transactional object to wakeup for.

Returns:

true if there were tracked reads (so the latch was opened or registered at at least 1 transactional object)

startOr

public final void startOr()

endOr

public final void endOr()

endOrAndStartElse

public final void endOrAndStartElse()

takeSnapshot

protected S takeSnapshot()

getSnapshot

protected S getSnapshot()

storeSnapshot

protected void storeSnapshot(S snapshot)