public abstract class Client extends Object
Client is constructed from a Cluster and represents a way to send messages to Gremlin Server.
 This class itself is a base class as there are different implementations that provide differing kinds of
 functionality.  See the implementations for specifics on their individual usage.
 
 The Client is designed to be re-used and shared across threads.| Modifier and Type | Class and Description | 
|---|---|
| static class  | Client.ClusteredClientA  Clientimplementation that does not operate in a session. | 
| static class  | Client.ReboundClusteredClientUses a  Client.ClusteredClientthat rebinds requests to a
 specifiedGraphorTraversalSourceinstances on the server-side. | 
| static class  | Client.SessionedClientA  Clientimplementation that operates in the context of a session. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Cluster | cluster | 
| protected boolean | initialized | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract Client | alias(String graphOrTraversalSource)Create a new  Clientthat aliases the specifiedGraphorTraversalSourcename on the
 server to a variable called "g" for the context of the requests made through thatClient. | 
| org.apache.tinkerpop.gremlin.driver.message.RequestMessage | buildMessage(org.apache.tinkerpop.gremlin.driver.message.RequestMessage.Builder builder)Makes any final changes to the builder and returns the constructed  RequestMessage. | 
| protected abstract org.apache.tinkerpop.gremlin.driver.Connection | chooseConnection(org.apache.tinkerpop.gremlin.driver.message.RequestMessage msg)Chooses a  Connectionto write the message to. | 
| void | close()Closes the client by making a synchronous call to  closeAsync(). | 
| abstract CompletableFuture<Void> | closeAsync()Asynchronous close of the  Client. | 
| Client | init()Initializes the client which typically means that a connection is established to the server. | 
| protected abstract void | initializeImplementation()Called in the  init()method. | 
| abstract Client | rebind(String graphOrTraversalSource)Deprecated. 
 As of release 3.1.0, replaced by  alias(String) | 
| ResultSet | submit(String gremlin)Submits a Gremlin script to the server and returns a  ResultSetonce the write of the request is
 complete. | 
| ResultSet | submit(String gremlin,
      Map<String,Object> parameters)Submits a Gremlin script and bound parameters to the server and returns a  ResultSetonce the write of
 the request is complete. | 
| CompletableFuture<ResultSet> | submitAsync(org.apache.tinkerpop.gremlin.driver.message.RequestMessage msg)A low-level method that allows the submission of a manually constructed  RequestMessage. | 
| CompletableFuture<ResultSet> | submitAsync(String gremlin)The asynchronous version of  submit(String)where the returned future will complete when the
 write of the request completes. | 
| CompletableFuture<ResultSet> | submitAsync(String gremlin,
           Map<String,Object> parameters)The asynchronous version of  submit(String, Map)} where the returned future will complete when the
 write of the request completes. | 
protected final Cluster cluster
protected volatile boolean initialized
public org.apache.tinkerpop.gremlin.driver.message.RequestMessage buildMessage(org.apache.tinkerpop.gremlin.driver.message.RequestMessage.Builder builder)
RequestMessage.  Implementers
 may choose to override this message to append data to the request before sending.  By default, this method
 will simply call the RequestMessage.Builder.create() and return
 the RequestMessage.protected abstract void initializeImplementation()
init() method.protected abstract org.apache.tinkerpop.gremlin.driver.Connection chooseConnection(org.apache.tinkerpop.gremlin.driver.message.RequestMessage msg)
                                                                            throws TimeoutException,
                                                                                   org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
Connection to write the message to.TimeoutExceptionorg.apache.tinkerpop.gremlin.driver.exception.ConnectionExceptionpublic abstract CompletableFuture<Void> closeAsync()
Client.@Deprecated public abstract Client rebind(String graphOrTraversalSource)
alias(String)Client that aliases the specified Graph or TraversalSource name on the
 server to a variable called "g" for the context of the requests made through that Client.graphOrTraversalSource - rebinds the specified global Gremlin Server variable to "g"public abstract Client alias(String graphOrTraversalSource)
Client that aliases the specified Graph or TraversalSource name on the
 server to a variable called "g" for the context of the requests made through that Client.graphOrTraversalSource - rebinds the specified global Gremlin Server variable to "g"public Client init()
public ResultSet submit(String gremlin)
ResultSet once the write of the request is
 complete.gremlin - the gremlin script to executepublic ResultSet submit(String gremlin, Map<String,Object> parameters)
ResultSet once the write of
 the request is complete.  If a script is to be executed repeatedly with slightly different arguments, prefer
 this method to concatenating a Gremlin script from dynamically produced strings and sending it to
 submit(String).  Parameterized scripts will perform better.gremlin - the gremlin script to executeparameters - a map of parameters that will be bound to the script on executionpublic CompletableFuture<ResultSet> submitAsync(String gremlin)
submit(String) where the returned future will complete when the
 write of the request completes.gremlin - the gremlin script to executepublic CompletableFuture<ResultSet> submitAsync(String gremlin, Map<String,Object> parameters)
submit(String, Map)} where the returned future will complete when the
 write of the request completes.gremlin - the gremlin script to executeparameters - a map of parameters that will be bound to the script on executionpublic CompletableFuture<ResultSet> submitAsync(org.apache.tinkerpop.gremlin.driver.message.RequestMessage msg)
RequestMessage.public void close()
closeAsync().Copyright © 2013–2015 Apache Software Foundation. All rights reserved.