Package org.apache.tinkerpop.gremlin.server

Class GremlinServer

java.lang.Object

org.apache.tinkerpop.gremlin.server.GremlinServer

public class GremlinServer
extends Object

Start and stop Gremlin Server.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIT_LOGGER_NAME

Constructor Summary

Constructors

Constructor	Description
GremlinServer(Settings settings)	Construct a Gremlin Server instance from Settings.
GremlinServer(Settings settings, ExecutorService gremlinExecutorService)	Construct a Gremlin Server instance from Settings and ExecutorService.

Method Summary

Modifier and Type	Method	Description
Channelizer	getChannelizer()
static String	getHeader()
ServerGremlinExecutor	getServerGremlinExecutor()
static void	main(String[] args)
CompletableFuture<ServerGremlinExecutor>	start()	Start Gremlin Server with Settings provided to the constructor.
CompletableFuture<Void>	stop()	Stop Gremlin Server and free the port binding.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

AUDIT_LOGGER_NAME

public static final String AUDIT_LOGGER_NAME

See Also:

• Constant Field Values

Constructor Details

GremlinServer

public GremlinServer(Settings settings)

Construct a Gremlin Server instance from Settings.

GremlinServer

public GremlinServer(Settings settings,
 ExecutorService gremlinExecutorService)

Construct a Gremlin Server instance from Settings and ExecutorService. This constructor is useful when Gremlin Server is being used in an embedded style and there is a need to share thread pools with the hosting application.

Method Details

start

public CompletableFuture<ServerGremlinExecutor> start()
                                               throws Exception

Start Gremlin Server with Settings provided to the constructor.

Throws:

Exception

stop

public CompletableFuture<Void> stop()

Stop Gremlin Server and free the port binding. Note that multiple calls to this method will return the same instance of the CompletableFuture.

getServerGremlinExecutor

public ServerGremlinExecutor getServerGremlinExecutor()

getChannelizer

public Channelizer getChannelizer()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

getHeader

public static String getHeader()

toString

public String toString()

Overrides:

toString in class Object