org.apache.tinkerpop.gremlin.driver.remote

Class DriverRemoteTransaction

java.lang.Object

org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction

All Implemented Interfaces:

AutoCloseable, RemoteConnection, Transaction

public class DriverRemoteTransaction
extends Object
implements Transaction, RemoteConnection

A remote Transaction implementation that is implemented with the Java driver. It is also a proxy for a RemoteConnection that is bound to a session.

For users, starting a transaction with Transaction.begin() will produce a TraversalSource that can be used across multiple threads sending the bytecode based requests to a remote session. It is worth noting that the session will process these requests in a serial fashion and not in parallel. Calling commit() or rollback() will also close the session and no additional traversal can be executed on the TraversalSource. A fresh call to Transaction.begin() will be required to open a fresh session to work with. The default behavior of close() is to commit the transaction.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Transaction

Transaction.CLOSE_BEHAVIOR, Transaction.Exceptions, Transaction.READ_WRITE_BEHAVIOR, Transaction.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected Consumer<Transaction>	closeConsumer

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Transaction

NO_OP

Fields inherited from interface org.apache.tinkerpop.gremlin.process.remote.RemoteConnection

GREMLIN_REMOTE, GREMLIN_REMOTE_CONNECTION_CLASS

Constructor Summary

Constructors

Constructor and Description
DriverRemoteTransaction(DriverRemoteConnection sessionBasedConnection)

Method Summary

Modifier and Type	Method and Description
void	addTransactionListener(Consumer<Transaction.Status> listener) There is no support for remote transaction listeners.
<T extends TraversalSource> T	begin(Class<T> traversalSourceClass)
void	clearTransactionListeners() There is no support for remote transaction listeners.
void	close() The default close behavior for this Transaction implementation is to commit().
void	commit()
boolean	isOpen()
Transaction	onClose(Consumer<Transaction> consumer)
Transaction	onReadWrite(Consumer<Transaction> consumer) This Transaction implementation is not auto-managed and therefore this method is not supported.
void	open() By virtue of creating a DriverRemoteTransaction, the transaction is considered open.
void	readWrite() This Transaction implementation is not auto-managed and therefore this method is not supported.
void	removeTransactionListener(Consumer<Transaction.Status> listener) There is no support for remote transaction listeners.
void	rollback()
<E> CompletableFuture<RemoteTraversal<?,E>>	submitAsync(Bytecode bytecode)
Transaction	tx() It is not possible to have child transactions, therefore this method always returns Transaction.NO_OP.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Transaction

begin, createThreadedTx

Methods inherited from interface org.apache.tinkerpop.gremlin.process.remote.RemoteConnection

from

Field Detail

closeConsumer

protected Consumer<Transaction> closeConsumer

Constructor Detail

DriverRemoteTransaction

public DriverRemoteTransaction(DriverRemoteConnection sessionBasedConnection)

Method Detail

begin

public <T extends TraversalSource> T begin(Class<T> traversalSourceClass)

Specified by:

begin in interface Transaction

open

public void open()

By virtue of creating a DriverRemoteTransaction, the transaction is considered open. There is no need to call this method. Calling it when the transaction is closed will result in exception.

Specified by:

open in interface Transaction

commit

public void commit()

Specified by:

commit in interface Transaction

rollback

public void rollback()

Specified by:

rollback in interface Transaction

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Transaction

close

public void close()

The default close behavior for this Transaction implementation is to commit().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Transaction

readWrite

public void readWrite()

This Transaction implementation is not auto-managed and therefore this method is not supported.

Specified by:

readWrite in interface Transaction

onReadWrite

public Transaction onReadWrite(Consumer<Transaction> consumer)

This Transaction implementation is not auto-managed and therefore this method is not supported.

Specified by:

onReadWrite in interface Transaction

onClose

public Transaction onClose(Consumer<Transaction> consumer)

Specified by:

onClose in interface Transaction

addTransactionListener

public void addTransactionListener(Consumer<Transaction.Status> listener)

There is no support for remote transaction listeners.

Specified by:

addTransactionListener in interface Transaction

removeTransactionListener

public void removeTransactionListener(Consumer<Transaction.Status> listener)

There is no support for remote transaction listeners.

Specified by:

removeTransactionListener in interface Transaction

clearTransactionListeners

public void clearTransactionListeners()

There is no support for remote transaction listeners.

Specified by:

clearTransactionListeners in interface Transaction

tx

public Transaction tx()

It is not possible to have child transactions, therefore this method always returns Transaction.NO_OP.

Specified by:

tx in interface RemoteConnection

submitAsync

public <E> CompletableFuture<RemoteTraversal<?,E>> submitAsync(Bytecode bytecode)
                                                        throws RemoteConnectionException

Specified by:

submitAsync in interface RemoteConnection

Throws:

RemoteConnectionException