Package org.apache.tinkerpop.gremlin.process.remote

Interface RemoteConnection

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DriverRemoteConnection, EmbeddedRemoteConnection

public interface RemoteConnection
extends AutoCloseable

A simple abstraction of a "connection" to a "server" that is capable of processing a Traversal and returning results. Results refer to both the Iterator of results from the submitted Traversal as well as the side-effects produced by that Traversal. Those results together are wrapped in a Traversal.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GREMLIN_REMOTE
static final String	GREMLIN_REMOTE_CONNECTION_CLASS

Method Summary

Modifier and Type	Method	Description
static RemoteConnection	from(org.apache.commons.configuration2.Configuration conf)	Create a RemoteConnection from a Configuration object.
default PDTRegistry	getPdtRegistry()	Returns the PDTRegistry associated with this connection, or null if none.
<E> CompletableFuture<RemoteTraversal<?,E>>	submitAsync(GremlinLang gremlinLang)	Submits Traversal GremlinLang to a server and returns a promise of a RemoteTraversal.
default Transaction	tx()	Creates a Transaction object designed to work with remote semantics.

Methods inherited from interface java.lang.AutoCloseable

close

Field Details

GREMLIN_REMOTE

static final String GREMLIN_REMOTE

See Also:

• Constant Field Values

GREMLIN_REMOTE_CONNECTION_CLASS

static final String GREMLIN_REMOTE_CONNECTION_CLASS

See Also:

• Constant Field Values

Method Details

tx

default Transaction tx()

Creates a Transaction object designed to work with remote semantics.

submitAsync

<E> CompletableFuture<RemoteTraversal<?,E>> submitAsync(GremlinLang gremlinLang)
                                                 throws RemoteConnectionException

Submits Traversal GremlinLang to a server and returns a promise of a RemoteTraversal. The RemoteTraversal is an abstraction over two types of results that can be returned as part of the response from the server: the results of the Traversal itself and the side-effects that it produced.

Throws:

RemoteConnectionException

getPdtRegistry

default PDTRegistry getPdtRegistry()

Returns the PDTRegistry associated with this connection, or null if none. Used by the gremlin-lang translator for registry-based dehydration of unknown types.

from

static RemoteConnection from(org.apache.commons.configuration2.Configuration conf)

Create a RemoteConnection from a Configuration object. The configuration must contain a gremlin.remote.remoteConnectionClass key which is the fully qualified class name of a RemoteConnection class.