org.apache.tinkerpop.gremlin.driver

Class Client.SessionedClient

java.lang.Object

org.apache.tinkerpop.gremlin.driver.Client

org.apache.tinkerpop.gremlin.driver.Client.SessionedClient

Enclosing class:

Client

public static final class Client.SessionedClient
extends Client

A Client implementation that operates in the context of a session. Requests are sent to a single server, where each request is bound to the same thread with the same set of bindings across requests. Transaction are not automatically committed. It is up the client to issue commit/rollback commands.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.driver.Client

Client.ClusteredClient, Client.ReboundClusteredClient, Client.SessionedClient

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.driver.Client

cluster, initialized

Method Summary

Modifier and Type	Method and Description
RequestMessage	buildMessage(RequestMessage.Builder builder) Adds the Tokens.ARGS_SESSION value to every RequestMessage.
protected org.apache.tinkerpop.gremlin.driver.Connection	chooseConnection(RequestMessage msg) Since the session is bound to a single host, simply borrow a connection from that pool.
CompletableFuture<Void>	closeAsync() Close the bound ConnectionPool.
protected void	initializeImplementation() Randomly choose an available Host to bind the session too and initialize the ConnectionPool.
Client	rebind(String graphOrTraversalSourceName) Create a new Client that rebinds the specified Graph or TraversalSource name on the server to a variable called "g" for the context of the requests made through that Client.

Methods inherited from class org.apache.tinkerpop.gremlin.driver.Client

close, init, submit, submit, submitAsync, submitAsync, submitAsync

Methods inherited from class java.lang.Object

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

Method Detail

rebind

public Client rebind(String graphOrTraversalSourceName)

Description copied from class: Client

Create a new Client that rebinds the specified Graph or TraversalSource name on the server to a variable called "g" for the context of the requests made through that Client.

Specified by:

rebind in class Client

Parameters:

graphOrTraversalSourceName - rebinds the specified global Gremlin Server variable to "g"

buildMessage

public RequestMessage buildMessage(RequestMessage.Builder builder)

Adds the Tokens.ARGS_SESSION value to every RequestMessage.

Overrides:

buildMessage in class Client

chooseConnection

protected org.apache.tinkerpop.gremlin.driver.Connection chooseConnection(RequestMessage msg)
                                                                   throws TimeoutException,
                                                                          ConnectionException

Since the session is bound to a single host, simply borrow a connection from that pool.

Specified by:

chooseConnection in class Client

Throws:

TimeoutException

ConnectionException

initializeImplementation

protected void initializeImplementation()

Randomly choose an available Host to bind the session too and initialize the ConnectionPool.

Specified by:

initializeImplementation in class Client

closeAsync

public CompletableFuture<Void> closeAsync()

Close the bound ConnectionPool.

Specified by:

closeAsync in class Client