org.apache.tinkerpop.gremlin.server

Class Context

java.lang.Object

org.apache.tinkerpop.gremlin.server.Context

public class Context
extends Object

The context of Gremlin Server within which a particular request is made.

Author:

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

Constructor Summary

Constructors

Constructor and Description
Context(RequestMessage requestMessage, ChannelHandlerContext ctx, Settings settings, GraphManager graphManager, GremlinExecutor gremlinExecutor, ScheduledExecutorService scheduledExecutorService)

Method Summary

Modifier and Type	Method and Description
ChannelHandlerContext	getChannelHandlerContext() Gets the Netty context.
GraphManager	getGraphManager() Gets the set of Graph objects configured in Gremlin Server.
GremlinExecutor	getGremlinExecutor() Gets the executor chosen to evaluate incoming Gremlin scripts based on the request.
RequestMessage	getRequestMessage() Gets the current request to Gremlin Server.
ScheduledExecutorService	getScheduledExecutorService()
Settings	getSettings() Gets the current configuration of Gremlin Server.
void	writeAndFlush(ResponseMessage message) Writes a response message to the underlying channel while ensuring that at most one final response is written.
void	writeAndFlush(ResponseStatusCode code, Object responseMessage) Writes a response message to the underlying channel while ensuring that at most one final response is written.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(RequestMessage requestMessage,
               ChannelHandlerContext ctx,
               Settings settings,
               GraphManager graphManager,
               GremlinExecutor gremlinExecutor,
               ScheduledExecutorService scheduledExecutorService)

Method Detail

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

getRequestMessage

public RequestMessage getRequestMessage()

Gets the current request to Gremlin Server.

getChannelHandlerContext

public ChannelHandlerContext getChannelHandlerContext()

Gets the Netty context.

getSettings

public Settings getSettings()

Gets the current configuration of Gremlin Server.

getGraphManager

public GraphManager getGraphManager()

Gets the set of Graph objects configured in Gremlin Server.

getGremlinExecutor

public GremlinExecutor getGremlinExecutor()

Gets the executor chosen to evaluate incoming Gremlin scripts based on the request.

writeAndFlush

public void writeAndFlush(ResponseMessage message)

Writes a response message to the underlying channel while ensuring that at most one final response is written.

Note: this method should be used instead of writing to the channel directly when multiple threads are expected to produce response messages concurrently.

Attempts to write more than one final response message will be ignored.

See Also:

writeAndFlush(ResponseStatusCode, Object)

writeAndFlush

public void writeAndFlush(ResponseStatusCode code,
                          Object responseMessage)

Writes a response message to the underlying channel while ensuring that at most one final response is written.

The caller must make sure that the provided response status code matches the content of the message.

Note: this method should be used instead of writing to the channel directly when multiple threads are expected to produce response messages concurrently.

Attempts to write more than one final response message will be ignored.

See Also:

writeAndFlush(ResponseMessage)