com.syncleus.ferma

Interface WrappedTransaction

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Tx

All Known Implementing Classes:

AbstractTx, DelegatingTransaction

public interface WrappedTransaction
extends AutoCloseable

A set of methods that allow for control of transactional behavior of a WrappedFramedGraph instance. Providers may consider using AbstractTransaction as a base implementation that provides default features for most of these methods. It is expected that this interface be implemented by providers in a ThreadLocal fashion. In other words transactions are bound to the current thread, which means that any graph operation executed by the thread occurs in the context of that transaction and that there may only be one thread executing in a single transaction. It is important to realize that this class is not a "transaction object". It is a class that holds transaction related methods thus hiding them from the WrappedFramedGraph interface. This object is not meant to be passed around as a transactional context.

Method Summary

Modifier and Type	Method and Description
void	addTransactionListener(Consumer<org.apache.tinkerpop.gremlin.structure.Transaction.Status> listener) Adds a listener that is called back with a status when a commit or rollback is successful.
void	clearTransactionListeners() Removes all transaction listeners.
void	close()
void	commit() Commits a transaction.
WrappedFramedGraph	createThreadedTx() Creates a transaction that can be executed across multiple threads.
org.apache.tinkerpop.gremlin.structure.Transaction	getDelegate() Returns the raw wrapped tinkerpop transaction.
WrappedFramedGraph<? extends org.apache.tinkerpop.gremlin.structure.Graph>	getGraph() Returns the parent graph for the transaction.
boolean	isOpen() Determines if a transaction is currently open.
void	open() Opens a transaction.
void	readWrite() An internal function that signals a read or a write has occurred - not meant to be called directly by end users.
void	removeTransactionListener(Consumer<org.apache.tinkerpop.gremlin.structure.Transaction.Status> listener) Removes a transaction listener.
void	rollback() Rolls back a transaction.

Method Detail

open

void open()

Opens a transaction.

commit

void commit()

Commits a transaction.

rollback

void rollback()

Rolls back a transaction.

createThreadedTx

WrappedFramedGraph createThreadedTx()

Creates a transaction that can be executed across multiple threads. The WrappedFramedGraph returned from this method is not meant to represent some form of child transaction that can be committed from this object. A threaded transaction is a Graph instance that has a transaction context that enables multiple threads to collaborate on the same transaction. A standard transactional context tied to a WrappedFramedGraph that supports transactions will typically bind a transaction to a single thread via ThreadLocal.

Returns:

A new version of the graph which can be accessed in its own thread.

isOpen

boolean isOpen()

Determines if a transaction is currently open.

Returns:

true if currently open, false otherwise.

readWrite

void readWrite()

An internal function that signals a read or a write has occurred - not meant to be called directly by end users.

close

void close()

Specified by:

close in interface AutoCloseable

addTransactionListener

void addTransactionListener(Consumer<org.apache.tinkerpop.gremlin.structure.Transaction.Status> listener)

Adds a listener that is called back with a status when a commit or rollback is successful. It is expected that listeners be bound to the current thread as is standard for transactions. Therefore a listener registered in the current thread will not get callback events from a commit or rollback call in a different thread.

Parameters:

listener - the transaction listener to be added

removeTransactionListener

void removeTransactionListener(Consumer<org.apache.tinkerpop.gremlin.structure.Transaction.Status> listener)

Removes a transaction listener.

Parameters:

listener - The listener to be removed.

clearTransactionListeners

void clearTransactionListeners()

Removes all transaction listeners.

getDelegate

org.apache.tinkerpop.gremlin.structure.Transaction getDelegate()

Returns the raw wrapped tinkerpop transaction.

Returns:

wrapped tinkerpop transaction.

getGraph

WrappedFramedGraph<? extends org.apache.tinkerpop.gremlin.structure.Graph> getGraph()

Returns the parent graph for the transaction.

Returns:

parent graph.