Transaction (Apache TinkerPop 3.0.0.M8-incubating API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractTransaction
```
public interface Transaction
extends Closeable
```
A set of methods that allow for control of transactional behavior of a Graph instance. Vendors 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 vendors 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.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com), TinkerPop Community (http://tinkerpop.com)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Transaction.CLOSE_BEHAVIOR` Behaviors to supply to the `onClose(java.util.function.Consumer)`.
`static class`	`Transaction.Exceptions`
`static class`	`Transaction.READ_WRITE_BEHAVIOR` Behaviors to supply to the `onReadWrite(java.util.function.Consumer)`.
`static class`	`Transaction.Status` A status provided to transaction listeners to inform whether a transaction was successfully committed or rolled back.
`static class`	`Transaction.Workload<R>` A `Transaction.Workload` represents a unit of work constructed by the `submit(java.util.function.Function)` method on the `Transaction` interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addTransactionListener(Consumer<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()` Closes the transaction where the default close behavior will be executed.
`void`	`commit()` Commits a transaction.
`<G extends Graph> G`	`create()` Creates a transaction that can be executed across multiple threads.
`boolean`	`isOpen()` Determines if a transaction is currently open.
`Transaction`	`onClose(Consumer<Transaction> consumer)` Describes what happens to a transaction on a call to `AutoCloseable.close()`.
`Transaction`	`onReadWrite(Consumer<Transaction> consumer)` Describes how a transaction is started when a read or a write occurs.
`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<Transaction.Status> listener)` Removes a transaction listener.
`void`	`rollback()` Rolls back a transaction.
`<R> Transaction.Workload<R>`	`submit(Function<Graph,R> work)` Submit a unit of work that represents a transaction returning a `Transaction.Workload` that can be automatically retried in the event of failure.

- Method Detail
  - open
```
void open()
```
    Opens a transaction.
  - commit
```
void commit()
```
    Commits a transaction.
  - rollback
```
void rollback()
```
    Rolls back a transaction.
  - submit
```
<R> Transaction.Workload<R> submit(Function<Graph,R> work)
```
    Submit a unit of work that represents a transaction returning a Transaction.Workload that can be automatically retried in the event of failure.
  - create
```
<G extends Graph> G create()
```
    Creates a transaction that can be executed across multiple threads.
  - isOpen
```
boolean isOpen()
```
    Determines if a transaction is currently open.
  - 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()
```
    Closes the transaction where the default close behavior will be executed.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - onReadWrite
```
Transaction onReadWrite(Consumer<Transaction> consumer)
```
    Describes how a transaction is started when a read or a write occurs. This value can be set using standard behaviors defined in Transaction.READ_WRITE_BEHAVIOR or a mapper Consumer function.
  - onClose
```
Transaction onClose(Consumer<Transaction> consumer)
```
    Describes what happens to a transaction on a call to AutoCloseable.close(). This value can be set using standard behavior defined in Transaction.CLOSE_BEHAVIOR or a mapper Consumer function.
  - addTransactionListener
```
void addTransactionListener(Consumer<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.
  - removeTransactionListener
```
void removeTransactionListener(Consumer<Transaction.Status> listener)
```
    Removes a transaction listener.
  - clearTransactionListeners
```
void clearTransactionListeners()
```
    Removes all transaction listeners.

Interface Transaction

Nested Class Summary

Method Summary

Method Detail

open

commit

rollback

submit

create

isOpen

readWrite

close

onReadWrite

onClose

addTransactionListener

removeTransactionListener

clearTransactionListeners