com.syncleus.ferma.tx

Interface Tx

All Superinterfaces:

AutoCloseable, WrappedTransaction

All Known Implementing Classes:

AbstractTx

public interface Tx
extends WrappedTransaction

A Tx is an extended flavor of the WrappedTransaction. This interface provides methods to store and retrieve transaction references. This is useful if you want to access a running transaction without passing along the transaction object in your implementation. Additionally this interface provides the success() and failure() methods which can be used within the close() method in order to rollback or commit the transaction according to the state of the flag which is set using these methods. The AbstractTx class contains an abstract implementation of this mechanism.

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<Tx>	threadLocalGraph Thread local that is used to store references to the used graph.

Method Summary

Modifier and Type	Method and Description
default <T> T	addVertex(Class<T> kind) Add new isolated vertex to the graph.
void	close() Invoke rollback or commit when closing the autoclosable.
void	failure() Mark the transaction as failed.
static Tx	getActive() Return the current active graph.
static void	setActive(Tx tx) Set the nested active transaction for the current thread.
void	success() Mark the transaction as succeeded.

Methods inherited from interface com.syncleus.ferma.WrappedTransaction

addTransactionListener, clearTransactionListeners, commit, createThreadedTx, getDelegate, getGraph, isOpen, open, readWrite, removeTransactionListener, rollback

Field Detail

threadLocalGraph

static final ThreadLocal<Tx> threadLocalGraph

Thread local that is used to store references to the used graph.

Method Detail

setActive

static void setActive(Tx tx)

Set the nested active transaction for the current thread.

Parameters:

tx - Transaction

getActive

static Tx getActive()

Return the current active graph. A transaction should be the only place where this threadlocal is updated.

Returns:

Currently active transaction

success

void success()

Mark the transaction as succeeded. The autoclosable will invoke a commit when completing.

failure

void failure()

Mark the transaction as failed. The autoclosable will invoke a rollback when completing.

close

void close()

Invoke rollback or commit when closing the autoclosable. By default a rollback will be invoked.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface WrappedTransaction

addVertex

default <T> T addVertex(Class<T> kind)

Add new isolated vertex to the graph.

Type Parameters:

T - The type used to frame the element.

Parameters:

kind - The kind of the vertex

Returns:

The framed vertex