A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages

A

AbstractAuthenticationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
Provides an abstraction point to allow for http auth schemes beyond basic auth.
AbstractAuthenticationHandler(Authenticator) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler
Deprecated.
AbstractAuthenticationHandler(Authenticator, Authorizer) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler
 
AbstractChannelizer - Class in org.apache.tinkerpop.gremlin.server
A base implementation for the Channelizer which does a basic configuration of the pipeline, one that is generally common to virtually any Gremlin Server operation (i.e.
AbstractChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
AbstractEvalOpProcessor - Class in org.apache.tinkerpop.gremlin.server.op
A base OpProcessor implementation that helps with operations that deal with script evaluation functions.
AbstractEvalOpProcessor(boolean) - Constructor for class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
 
AbstractEvalOpProcessor.BindingSupplier - Interface in org.apache.tinkerpop.gremlin.server.op
 
AbstractOpProcessor - Class in org.apache.tinkerpop.gremlin.server.op
A base OpProcessor implementation that processes an Iterator of results in a generalized way while ensuring that graph transactions are properly managed.
AbstractOpProcessor(boolean) - Constructor for class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
 
AbstractSession - Class in org.apache.tinkerpop.gremlin.server.handler
A base implementation of Session which offers some common functionality that matches typical Gremlin Server request response expectations for script, bytecode and graph operations.
AbstractSession.CloseReason - Enum in org.apache.tinkerpop.gremlin.server.handler
The reason that a particular session closed.
acceptingRequests() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
addConsoleReporter(long) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a ConsoleReporter attached to the MetricsRegistry.
addCsvReporter(long, String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a CsvReporter attached to the MetricsRegistry.
addGangliaReporter(String, int, String, int, Boolean, UUID, String, long) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a GangliaReporter attached to the MetricsRegistry.
addGraph(String, String) - Method in class org.apache.tinkerpop.gremlin.server.util.CheckedGraphManager
 
addGraph(String, String) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
addGraphiteReporter(String, int, String, long) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a GraphiteReporter attached to the MetricsRegistry.
addHostOption(String, Object) - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
addJmxReporter(String, String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a JmxReporter attached to the MetricsRegistry.
addressingMode - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 
addSlf4jReporter(long, String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Create a Slf4jReporter attached to the MetricsRegistry.
agentId - Variable in class org.apache.tinkerpop.gremlin.server.Settings.JmxReporterMetrics
 
aliasesUsedBySession - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
AllowAllAuthenticator - Class in org.apache.tinkerpop.gremlin.server.auth
Allows all requests to be authenticated.
AllowAllAuthenticator() - Constructor for class org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator
 
ANONYMOUS_USER - Static variable in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
ANONYMOUS_USERNAME - Static variable in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
attemptCommit(RequestMessage, GraphManager, boolean) - Static method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
 
attemptRollback(RequestMessage, GraphManager, boolean) - Static method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
 
AUDIT_LOGGER_NAME - Static variable in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
authenticate(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator
 
authenticate(Map<String, String>) - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator
A "standard" authentication implementation that can be used more generically without SASL support.
authenticate(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.server.auth.Krb5Authenticator
 
authenticate(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
 
AUTHENTICATED_USER - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key for the current AuthenticatedUser.
AuthenticatedUser - Class in org.apache.tinkerpop.gremlin.server.auth
 
AuthenticatedUser(String) - Constructor for class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
authentication - Variable in class org.apache.tinkerpop.gremlin.server.Settings
 
AuthenticationException - Exception in org.apache.tinkerpop.gremlin.server.auth
An exception that occurs when during authentication such as a failed login.
AuthenticationException() - Constructor for exception org.apache.tinkerpop.gremlin.server.auth.AuthenticationException
 
AuthenticationException(String) - Constructor for exception org.apache.tinkerpop.gremlin.server.auth.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.auth.AuthenticationException
 
AuthenticationException(String, Throwable, boolean, boolean) - Constructor for exception org.apache.tinkerpop.gremlin.server.auth.AuthenticationException
 
AuthenticationException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.auth.AuthenticationException
 
authenticationHandler - Variable in class org.apache.tinkerpop.gremlin.server.Settings.AuthenticationSettings
The fully qualified class name of the AbstractAuthenticationHandler implementation.
AuthenticationSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.AuthenticationSettings
 
authenticator - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
authenticator - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler
 
authenticator - Variable in class org.apache.tinkerpop.gremlin.server.Settings.AuthenticationSettings
The fully qualified class name of the Authenticator implementation.
Authenticator - Interface in org.apache.tinkerpop.gremlin.server.auth
Provides methods related to authentication of a request.
Authenticator.SaslNegotiator - Interface in org.apache.tinkerpop.gremlin.server.auth
Performs the actual SASL negotiation for a single authentication attempt.
authorization - Variable in class org.apache.tinkerpop.gremlin.server.Settings
 
AuthorizationException - Exception in org.apache.tinkerpop.gremlin.server.authz
An exception that occurs during authorization, i.e.
AuthorizationException() - Constructor for exception org.apache.tinkerpop.gremlin.server.authz.AuthorizationException
 
AuthorizationException(String) - Constructor for exception org.apache.tinkerpop.gremlin.server.authz.AuthorizationException
 
AuthorizationException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.authz.AuthorizationException
 
AuthorizationException(String, Throwable, boolean, boolean) - Constructor for exception org.apache.tinkerpop.gremlin.server.authz.AuthorizationException
 
AuthorizationException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.authz.AuthorizationException
 
AuthorizationSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.AuthorizationSettings
 
authorize(AuthenticatedUser, RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.server.authz.Authorizer
Checks whether a user is authorized to have a script request from a gremlin client answered and raises an AuthorizationException if this is not the case.
authorize(AuthenticatedUser, Bytecode, Map<String, String>) - Method in interface org.apache.tinkerpop.gremlin.server.authz.Authorizer
Checks whether a user is authorized to have a gremlin bytecode request from a client answered and raises an AuthorizationException if this is not the case.
authorizer - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
authorizer - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractAuthenticationHandler
 
authorizer - Variable in class org.apache.tinkerpop.gremlin.server.Settings.AuthorizationSettings
The fully qualified class name of the Authorizer implementation.
Authorizer - Interface in org.apache.tinkerpop.gremlin.server.authz
Provides the interface for authorizing a user per request.

B

BaseMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.BaseMetrics
 
beforeProcessing(Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
beforeProcessing(Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
beforeQueryStart(RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
This method will be called before a script or query is processed by the gremlin-server.
bindingMaker - Variable in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
BYTECODE - org.apache.tinkerpop.gremlin.server.Context.RequestContentType
Contents is of type Bytecode.

C

cancel(boolean) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
CHANNEL_CLOSED - org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
The session was interrupted by the channel closing, which can be something initiated by closing the Client or might be triggered by the server.
channelizer - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
channelizer - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The full class name of the Channelizer to use in Gremlin Server.
Channelizer - Interface in org.apache.tinkerpop.gremlin.server
An interface that makes it possible to plugin different Netty pipelines to Gremlin Server, enabling the use of different protocols, mapper security and other such functions.
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.HttpBasicAuthenticationHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.HttpBasicAuthorizationHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.HttpGremlinEndpointHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.SaslAndHttpBasicAuthenticationHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.SaslAuthenticationHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.WebSocketAuthorizationHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
channelRead0(ChannelHandlerContext, RequestMessage) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
channelRead0(ChannelHandlerContext, Pair<RequestMessage, ThrowingConsumer<Context>>) - Method in class org.apache.tinkerpop.gremlin.server.handler.OpExecutorHandler
 
CheckedGraphManager - Class in org.apache.tinkerpop.gremlin.server.util
A GraphManager that will prevent Gremlin Server from starting if all configured graphs fail.
CheckedGraphManager(Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.util.CheckedGraphManager
 
className - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ProcessorSettings
The fully qualified class name of an OpProcessor implementation.
className - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SerializerSettings
The fully qualified class name of the MessageSerializer implementation.
clearHostOptions() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
close() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Removes the session from the session list and cancels the future that manages the lifetime of the session.
close() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
This method stops incoming requests from being added to the session queue.
close() - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
close() - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
close() - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
closeReason - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
closeTransaction(SessionTask, Transaction.Status) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Closes a transaction with commit or rollback.
closeTransaction(Transaction.Status) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Close the transaction without a SessionTask which supplies null to that argument for AbstractSession.closeTransaction(SessionTask, Transaction.Status).
closeTransactionSafely(SessionTask, Transaction.Status) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Tries to close the transaction but will catch exceptions and log them.
closeTransactionSafely(Transaction.Status) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Tries to close the transaction but will catch exceptions and log them.
commit(Set<String>) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Selectively commit transactions on the specified graphs or the graphs of traversal sources.
commit(Set<String>) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Selectively commit transactions on the specified graphs or the graphs of traversal sources.
commitAll() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Commit transactions across all Graph objects.
commitAll() - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Commit transactions across all Graph objects.
config - Variable in class org.apache.tinkerpop.gremlin.server.Settings.AuthenticationSettings
A Map containing Authenticator specific configurations.
config - Variable in class org.apache.tinkerpop.gremlin.server.Settings.AuthorizationSettings
A Map containing Authorizer specific configurations.
config - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ProcessorSettings
A set of configurations as expected by the OpProcessor.
config - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
A Map of configuration settings for the ScriptEngine.
config - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SerializerSettings
A Map containing MessageSerializer specific configurations.
CONFIG_CREDENTIALS_DB - Static variable in class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
The location of the configuration file that contains the credentials database.
CONFIG_GLOBAL_FUNCTION_CACHE_ENABLED - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Configuration setting that behaves as an override to the global script engine setting of the same name that is provided to the GroovyCompilerGremlinPlugin.
CONFIG_MAX_PARAMETERS - Static variable in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
The maximum number of parameters that can be passed on a script evaluation request.
CONFIG_PER_GRAPH_CLOSE_TIMEOUT - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Configuration setting for how long to wait in milliseconds for each configured graph to close any open transactions when the session is killed.
CONFIG_SESSION_TIMEOUT - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Configuration setting for how long a session will be available before it times out.
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
This method is called from within AbstractChannelizer.initChannel(SocketChannel) just after the SSL handler is put in the pipeline.
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer
 
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer
 
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
 
configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
consoleReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
ConsoleReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.ConsoleReporterMetrics
 
contains(String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
Context - Class in org.apache.tinkerpop.gremlin.server
The context of Gremlin Server within which a particular request is made.
Context(RequestMessage, ChannelHandlerContext, Settings, GraphManager, GremlinExecutor, ScheduledExecutorService) - Constructor for class org.apache.tinkerpop.gremlin.server.Context
 
Context(Logger) - Constructor for class org.apache.tinkerpop.gremlin.server.util.LifeCycleHook.Context
 
Context.RequestContentType - Enum in org.apache.tinkerpop.gremlin.server
The type of the request as determined by the contents of Tokens.ARGS_GREMLIN.
create(String) - Static method in class org.apache.tinkerpop.gremlin.server.util.ThreadFactoryUtil
 
createAuthenticationHandler(Settings) - Method in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
createDefaultYamlConstructor() - Static method in class org.apache.tinkerpop.gremlin.server.Settings
Creates Constructor which contains all configurations to parse a Gremlin Server YAML configuration file using SnakeYAML.
createIdleDetectionMessage() - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
createIdleDetectionMessage() - Method in class org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer
 
createIdleDetectionMessage() - Method in class org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
 
createIdleDetectionMessage() - Method in interface org.apache.tinkerpop.gremlin.server.Channelizer
Create a message to send to seemingly dead clients to see if they respond back.
createMultiTaskSession(SessionTask, String) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
Called when creating a Session that will be long-lived to extend over multiple requests and therefore process the provided SessionTask as well as ones that may arrive in the future.
createSingleTaskSession(SessionTask, String) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
Called when creating a single task session where the provided SessionTask will be the only one to be executed and can therefore take a more efficient execution path.
csvReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
CsvReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.CsvReporterMetrics
 

D

decode(ChannelHandlerContext, BinaryWebSocketFrame, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsGremlinBinaryRequestDecoder
 
decode(ChannelHandlerContext, CloseWebSocketFrame, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsGremlinCloseRequestDecoder
 
decode(ChannelHandlerContext, TextWebSocketFrame, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsGremlinTextRequestDecoder
 
decode(ChannelHandlerContext, RequestMessage, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.OpSelectorHandler
 
DEFAULT_MAX_PARAMETERS - Static variable in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
Default number of parameters allowed on a script evaluation request.
DEFAULT_PER_GRAPH_CLOSE_TIMEOUT - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Default amount of time to wait in milliseconds for each configured graph to close any open transactions when the session is killed.
DEFAULT_SERIALIZERS - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
DEFAULT_SESSION_TIMEOUT - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Default timeout for a session is eight hours.
DefaultGraphManager - Class in org.apache.tinkerpop.gremlin.server.util
Holder for Graph and TraversalSource instances configured for the server to be passed to script engine bindings.
DefaultGraphManager(Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Create a new instance using the Settings from Gremlin Server.
DefaultTemporaryException - Exception in org.apache.tinkerpop.gremlin.server.util
This is a default TemporaryException implementation that server implementers could use if they wished to indicate retry operations to the client.
DefaultTemporaryException() - Constructor for exception org.apache.tinkerpop.gremlin.server.util.DefaultTemporaryException
 
DefaultTemporaryException(String) - Constructor for exception org.apache.tinkerpop.gremlin.server.util.DefaultTemporaryException
 
DefaultTemporaryException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.util.DefaultTemporaryException
 
DefaultTemporaryException(String, Throwable, boolean, boolean) - Constructor for exception org.apache.tinkerpop.gremlin.server.util.DefaultTemporaryException
 
DefaultTemporaryException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.server.util.DefaultTemporaryException
 
determineIfSpecialException(Throwable) - Static method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Check if any exception in the chain is TemporaryException or Failure then respond with the right error code so that the client knows to retry.
determineIfSpecialException(Throwable) - Static method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Check if any exception in the chain is TemporaryException or Failure then respond with the right error code so that the client knows to retry.
domain - Variable in class org.apache.tinkerpop.gremlin.server.Settings.JmxReporterMetrics
 

E

ENABLE_DEBUG - Static variable in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 
enableAuditLog - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Enable audit logging of authenticated users and gremlin evaluation requests.
enabled - Variable in class org.apache.tinkerpop.gremlin.server.Settings.BaseMetrics
 
enabled - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
Enables SSL.
encode(ChannelHandlerContext, ResponseMessage, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.GremlinResponseFrameEncoder
 
encode(ChannelHandlerContext, Frame, List<Object>) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsGremlinResponseFrameEncoder
 
equals(Object) - Method in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
evalOp(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
evalOpInternal(Context, Supplier<GremlinExecutor>, AbstractEvalOpProcessor.BindingSupplier) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
A generalized implementation of the "eval" operation.
evalOpTimer - Static variable in interface org.apache.tinkerpop.gremlin.server.handler.Session
 
evalOpTimer - Static variable in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
 
evaluateResponse(byte[]) - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator
Evaluates the client response data and generates a byte[] reply which may be a further challenge or purely informational in the case that the negotiation is completed on this round.
evaluationTimeout - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Time in milliseconds to wait for a request (script or bytecode) to complete execution.
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class org.apache.tinkerpop.gremlin.server.handler.HttpGremlinEndpointHandler
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
ExceptionHelper - Class in org.apache.tinkerpop.gremlin.server.util
Deprecated.
As of release 3.5.3, replaced by ExceptionHelper in gremlin-core
EXIT_PROCESSING - org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
The session exits in a fashion that did not precipitate from some form of interruption, timeout or exception, i.e.

F

fileName - Variable in class org.apache.tinkerpop.gremlin.server.Settings.CsvReporterMetrics
 
finalize(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
This method is called after the pipeline is completely configured.
finalize(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer
 
finalize(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
flush() - Method in class org.apache.tinkerpop.gremlin.server.Context
Flushes messages to the underlying transport.
Frame - Class in org.apache.tinkerpop.gremlin.server.handler
A holder for a String or ByteBuf that represents a message to be written back to the requesting client.
Frame(Object) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.Frame
 
fromBytecode(SessionTask, Bytecode) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Constructs an Iterator from Bytecode provided in the SessionTask.
fromScript(SessionTask, String) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Constructs an Iterator from the results of a script evaluation provided in the SessionTask.

G

gangliaReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
GangliaReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 
generateResponseMetaData(SessionTask, ResponseStatusCode, Iterator<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Generates response result meta-data to put on a ResponseMessage.
generateResultMetaData(ChannelHandlerContext, RequestMessage, ResponseStatusCode, Iterator, Settings) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Generates response result meta-data to put on a ResponseMessage.
generateStatusAttributes(ChannelHandlerContext, RequestMessage, ResponseStatusCode, Iterator, Settings) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Generates response status meta-data to put on a ResponseMessage.
generateStatusAttributes(SessionTask, ResponseStatusCode, Iterator<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Generates response status meta-data to put on a ResponseMessage.
get() - Method in interface org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor.BindingSupplier
 
getActiveSessionCount() - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
getActualTimeoutLengthWhenClosed() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
getAsBindings() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Get the Graph and TraversalSource list as a set of bindings.
getAsBindings() - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Get the Graph and TraversalSource list as a set of bindings.
getAuthenticatedUser() - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator
Following a successful negotiation, get the AuthenticatedUser representing the logged in subject.
getBindingMaker() - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
A useful method for those extending this class, where the means for binding construction can be supplied to this class.
getBindingMaker(Session) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
A useful method for those extending this class, where the means for binding construction can be supplied to this class.
getBindings() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
getChannelHandlerContext() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets the Netty context.
getChannelizer() - Method in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
getCloseReason() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
getCounter(String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getCounter(String, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getCounterSize() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getEvalOp() - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
Provides an operation for evaluating a Gremlin script.
getEvalOp() - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
getEvalOp() - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
getEvaluationTimeout() - Method in class org.apache.tinkerpop.gremlin.server.Settings
 
getExecutor() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
getGraph(String) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Get Graph instance whose name matches graphName.
getGraph(String) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
getGraphManager() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets the set of Graph objects configured in Gremlin Server.
getGraphManager() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getGraphNames() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Get a Set of String graphNames corresponding to names stored in the graph's reference tracker.
getGraphNames() - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
getGremlinArgument() - Method in class org.apache.tinkerpop.gremlin.server.Context
 
getGremlinExecutor() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets the executor chosen to evaluate incoming Gremlin scripts based on the request.
getGremlinExecutor() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
getGremlinExecutor() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getGremlinExecutorService() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getGuage(Gauge<T>, String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getGuage(Gauge<T>, String, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getHeader() - Static method in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
getHistogram(String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getHistogram(String, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getHooks() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getHostOptions() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getLogger() - Method in class org.apache.tinkerpop.gremlin.server.util.LifeCycleHook.Context
 
getMessageFromExceptionOrCause(Throwable) - Static method in class org.apache.tinkerpop.gremlin.server.util.ExceptionHelper
Deprecated.
getMessageOrName(Throwable) - Static method in class org.apache.tinkerpop.gremlin.server.util.ExceptionHelper
Deprecated.
getMeter(String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getMeter(String, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getMsg() - Method in class org.apache.tinkerpop.gremlin.server.handler.Frame
 
getName() - Method in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
getName() - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
getName() - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
getName() - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
getName() - Method in interface org.apache.tinkerpop.gremlin.server.OpProcessor
The name of the processor which requests must refer to "processor" field on a request.
getProcessor(String) - Static method in class org.apache.tinkerpop.gremlin.server.op.OpLoader
Gets an OpProcessor by its name.
getProcessors() - Static method in class org.apache.tinkerpop.gremlin.server.op.OpLoader
Gets a read-only map of the processors where the key is the OpProcessor name and the value is the instance created by ServiceLoader.
getRegistry() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Return the MetricsRegistry.
getRequestContentType() - Method in class org.apache.tinkerpop.gremlin.server.Context
 
getRequestMessage() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets the current request to Gremlin Server.
getRequestTimeout() - Method in class org.apache.tinkerpop.gremlin.server.Context
The timeout for the request.
getResponseMessage() - Method in exception org.apache.tinkerpop.gremlin.server.handler.SessionException
 
getResponseMessage() - Method in exception org.apache.tinkerpop.gremlin.server.op.OpProcessorException
 
getScheduledExecutorService() - Method in class org.apache.tinkerpop.gremlin.server.Context
 
getScheduledExecutorService() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getScriptEngine(SessionTask, String) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Gets the script engine from the cached one in the GremlinExecutor.
getScriptEngine(SessionTask, String) - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
Gets the script engine specific to this session which is dependent on the Settings.useCommonEngineForSessions configuration.
getServerGremlinExecutor() - Method in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
getSession(Context, RequestMessage) - Static method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Examines the RequestMessage and extracts the session token.
getSessionId() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
getSessionId() - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Gets the identifier for the session.
getSessionId() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
getSettings() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets the current configuration of Gremlin Server.
getSettings() - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
getSslContext() - Method in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
 
getStartedResponse() - Method in class org.apache.tinkerpop.gremlin.server.Context
Gets whether the server has started processing the response for this request.
getTimer(String) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getTimer(String, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
getTraversal() - Method in class org.apache.tinkerpop.gremlin.server.util.TraverserIterator
 
getTraversalSource(String) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Get TraversalSource instance whose name matches traversalSourceName
getTraversalSource(String) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
getTraversalSourceNames() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Get a Set of the names of the the stored TraversalSource instances.
getTraversalSourceNames() - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
getUnifiedHandler() - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
getUserAgent() - Method in class org.apache.tinkerpop.gremlin.server.Context
Returns the user agent (if any) which was sent from the client during the web socket handshake.
getWorkerBindings() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
getWorkerBindings() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
getWsChannelizer() - Method in class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
graphiteReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
GraphiteReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.GraphiteReporterMetrics
 
graphManager - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
graphManager - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
graphManager - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
graphManager - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The full class name of the GraphManager to use in Gremlin Server.
GraphManager - Interface in org.apache.tinkerpop.gremlin.server
The GraphManager interface allows for reference tracking of Graph references through a Map<String, Graph>; the interface plugs into the lifeline of gremlin script executions, meaning that commit() and rollback() will be called on all graphs stored in the graph reference tracker at the end of the script executions; you may want to implement this interface if you want to define a custom graph instantiation/closing mechanism; note that the interface also defines similar features for TraversalSource objects.
graphs - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Map of Graph objects keyed by their binding name.
GREMLIN_ENDPOINT - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
gremlinExecutor - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
gremlinExecutor - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
gremlinExecutorService - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
gremlinPool - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Size of the Gremlin thread pool.
GremlinResponseFrameEncoder - Class in org.apache.tinkerpop.gremlin.server.handler
Ensures that any ResponseMessage manages to get converted to a Frame.
GremlinResponseFrameEncoder() - Constructor for class org.apache.tinkerpop.gremlin.server.handler.GremlinResponseFrameEncoder
 
GremlinServer - Class in org.apache.tinkerpop.gremlin.server
Start and stop Gremlin Server.
GremlinServer(Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.GremlinServer
Construct a Gremlin Server instance from Settings.
GremlinServer(Settings, ExecutorService) - Constructor for class org.apache.tinkerpop.gremlin.server.GremlinServer
Construct a Gremlin Server instance from Settings and ExecutorService.
GremlinServerGremlinPlugin - Class in org.apache.tinkerpop.gremlin.server.jsr223
A GremlinPlugin implementation that adds Gremlin Server specific classes to the imports.
GremlinServerInstall - Class in org.apache.tinkerpop.gremlin.server.util
Command line installer for plugins to Gremlin Server.
GremlinServerInstall() - Constructor for class org.apache.tinkerpop.gremlin.server.util.GremlinServerInstall
 

H

handle(Callback[]) - Method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil.KrbCallbackHandler
 
handleException(SessionTask, Throwable) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
handleGraphOperation(Bytecode, Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
If Bytecode is detected to contain a "graph operation" then it gets processed by this method.
handleGraphOperation(SessionTask, Bytecode, Graph) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
If Bytecode is detected to contain a GraphOp then it gets processed by this method.
handleIterator(Context, Iterator) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Provides a generic way of iterating a result set back to the client.
handleIterator(Context, Iterator, Graph) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
handleIterator(Context, Iterator, Graph) - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
handleIterator(SessionTask, Iterator<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Provides a generic way of iterating a result set back to the client.
hasAnyOpenTransactions() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Determines if any Graph instances that support transactions have open transactions.
hashCode() - Method in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
hasNext() - Method in class org.apache.tinkerpop.gremlin.server.util.TraverserIterator
 
host - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Host to bind the server to.
host - Variable in class org.apache.tinkerpop.gremlin.server.Settings.HostPortIntervalMetrics
 
HostPortIntervalMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.HostPortIntervalMetrics
 
hostUUID - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 
HttpBasicAuthenticationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
Implements basic HTTP authentication for use with the HttpGremlinEndpointHandler and HTTP based API calls.
HttpBasicAuthenticationHandler(Authenticator, Authorizer, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.HttpBasicAuthenticationHandler
 
HttpBasicAuthenticationHandler(Authenticator, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.HttpBasicAuthenticationHandler
Deprecated.
HttpBasicAuthorizationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
An authorization handler for the http channel that allows the Authorizer to be plugged into it.
HttpBasicAuthorizationHandler(Authorizer) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.HttpBasicAuthorizationHandler
 
HttpChannelizer - Class in org.apache.tinkerpop.gremlin.server.channel
Constructs a Channelizer that exposes an HTTP endpoint in Gremlin Server.
HttpChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer
 
HttpGremlinEndpointHandler - Class in org.apache.tinkerpop.gremlin.server.handler
Handler that processes HTTP requests to the HTTP Gremlin endpoint.
HttpGremlinEndpointHandler(Map<String, MessageSerializer<?>>, GremlinExecutor, GraphManager, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.HttpGremlinEndpointHandler
 
HttpHandlerUtil - Class in org.apache.tinkerpop.gremlin.server.handler
Provides methods shared by the HTTP handlers.
HttpHandlerUtil() - Constructor for class org.apache.tinkerpop.gremlin.server.handler.HttpHandlerUtil
 

I

idleConnectionTimeout - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Time in milliseconds that the server will allow a channel to not receive requests from a client before it automatically closes.
imports - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
A comma separated list of classes/packages to make available to the ScriptEngine.
init(Settings) - Static method in class org.apache.tinkerpop.gremlin.server.op.OpLoader
Initialize the OpLoader with server settings.
init(Settings) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
init(Settings) - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
init(Settings) - Method in interface org.apache.tinkerpop.gremlin.server.OpProcessor
Initialize the OpProcessor with settings from the server.
init(ServerGremlinExecutor) - Method in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
init(ServerGremlinExecutor) - Method in class org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer
 
init(ServerGremlinExecutor) - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
init(ServerGremlinExecutor) - Method in class org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer
 
init(ServerGremlinExecutor) - Method in class org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
 
init(ServerGremlinExecutor) - Method in interface org.apache.tinkerpop.gremlin.server.Channelizer
This method is called just after the Channelizer is initialized.
init(ServerGremlinExecutor, HttpGremlinEndpointHandler) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
initChannel(SocketChannel) - Method in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
initializeGremlinExecutor(SessionTask) - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
instance() - Static method in class org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin
 
INSTANCE - org.apache.tinkerpop.gremlin.server.util.MetricManager
 
interval - Variable in class org.apache.tinkerpop.gremlin.server.Settings.IntervalMetrics
 
IntervalMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.IntervalMetrics
 
INVALID_BINDINGS_KEYS - Static variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
This may or may not be the full set of invalid binding keys.
INVALID_BINDINGS_KEYS - Static variable in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
This may or may not be the full set of invalid binding keys.
isAcceptingTasks() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
isAcceptingTasks() - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Determines if this session can accept additional tasks or not.
isAcceptingTasks() - Method in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
The SingleWorker can only process one request so the initial construction of it already has the request in it and no more can be added, therefore this method always return false.
isActiveSession(String) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
isAnonymous() - Method in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
If Authenticator doesn't require authentication, this method may return true.
isBoundTo(Channel) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
isBoundTo(Channel) - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Determines if the supplied Channel object is the same as the one bound to the Session.
isBoundTo(Channel) - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
Determines if the supplied Channel object is the same as the one bound to the Session.
isComplete() - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator
Called after each invocation of Authenticator.SaslNegotiator.evaluateResponse(byte[]) to determine whether the authentication has completed successfully or should be continued.
isFinalResponseWritten() - Method in class org.apache.tinkerpop.gremlin.server.Context
 
isForceFlushed(ChannelHandlerContext, RequestMessage, Iterator) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Determines if a Frame should be force flushed outside of the resultIterationBatchSize and the termination of the iterator.
isTransactionManaged() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
iterateComplete(ChannelHandlerContext, RequestMessage, Iterator) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
Called when iteration within AbstractOpProcessor.handleIterator(Context, Iterator) is on its final pass and the final frame is about to be sent back to the client.
iterateComplete(SessionTask, Iterator<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Called when iteration within AbstractSession.handleIterator(SessionTask, Iterator) is on its final pass and the final frame is about to be sent back to the client.

J

JaasKrbUtil - Class in org.apache.tinkerpop.gremlin.server.auth
JAAS utilities for Kerberos login.
JaasKrbUtil.KrbCallbackHandler - Class in org.apache.tinkerpop.gremlin.server.auth
 
jmxReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
JmxReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.JmxReporterMetrics
 

K

keepAliveInterval - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Time in milliseconds that the server will allow a channel to not send responses to a client before it sends a "ping" to see if it is still present.
keyStore - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
The file location of the private key in JKS or PKCS#12 format.
keyStorePassword - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
The password of the Settings.SslSettings.keyStore, or null if it's not password-protected.
keyStoreType - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
The format of the Settings.SslSettings.keyStore, either JKS or PKCS12
kill(boolean) - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
Kills the session and rollback any uncommitted changes on transactional graphs.
Krb5Authenticator - Class in org.apache.tinkerpop.gremlin.server.auth
A Kerberos (GSSAPI) implementation of an Authenticator This authenticator authenticates and autorizes all clients with a valid service ticket.
Krb5Authenticator() - Constructor for class org.apache.tinkerpop.gremlin.server.auth.Krb5Authenticator
 
KrbCallbackHandler(String, String) - Constructor for class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil.KrbCallbackHandler
 

L

LifeCycleHook - Interface in org.apache.tinkerpop.gremlin.server.util
Provides a method in which users can hook into the startup and shutdown lifecycle of Gremlin Server.
LifeCycleHook.Context - Class in org.apache.tinkerpop.gremlin.server.util
Contains objects from the server that might be useful to scripting during the startup and shutdown process.
loggerName - Variable in class org.apache.tinkerpop.gremlin.server.Settings.Slf4jReporterMetrics
 
loginUsingKeytab(String, File) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 
loginUsingPassword(String, String) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 
loginUsingTicketCache(String, File) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 

M

main(String[]) - Static method in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
main(String[]) - Static method in class org.apache.tinkerpop.gremlin.server.util.GremlinServerInstall
 
maintainStateAfterException - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
makeFrame(Context, RequestMessage, MessageSerializer<?>, boolean, List<Object>, ResponseStatusCode, Map<String, Object>, Map<String, Object>) - Static method in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
 
makeFrame(SessionTask, List<Object>, ResponseStatusCode, Iterator<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
manageTransactions - Variable in class org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor
When set to true, transactions are always managed otherwise they can be overridden by the request.
manualKill(boolean) - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
Stops the session with call to Session.kill(boolean) but also stops the session expiration call which ensures that the session is only killed once.
maxAccumulationBufferComponents - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Maximum number of request components that can be aggregated for a message.
maxChunkSize - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The maximum length of the content or each chunk.
maxContentLength - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The maximum length of the aggregated content for a message.
maxHeaderSize - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The maximum length of all headers.
maxInitialLineLength - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The maximum length of the initial line (e.g.
maxParameters - Variable in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
 
maxParameters - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Maximum number of parameters that can be passed on a request.
maxSessionTaskQueueSize - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Maximum size that an individual Session can queue requests before starting to reject them.
maxWorkQueueSize - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Maximum size the general processing queue can grow before starting to reject requests.
mergeBindingsFromRequest(SessionTask, Bindings) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
MetricManager - Enum in org.apache.tinkerpop.gremlin.server.util
Singleton that contains and configures Gremlin Server's MetricRegistry.
metrics - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Configured metrics for Gremlin Server.
MultiTaskSession - Class in org.apache.tinkerpop.gremlin.server.handler
A Session implementation that queues tasks given to it and executes them in a serial fashion within the same thread which thus allows multiple tasks to be executed in the same transaction.
MultiTaskSession(SessionTask, String, ConcurrentMap<String, Session>) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
Creates a new MultiTaskSession object providing the initial starting SessionTask that gets executed by the session when it starts.

N

needClientAuth - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
Require client certificate authentication
NEGOTIATOR - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key for the current SASL negotiator.
newSaslNegotiator(InetAddress) - Method in class org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator
 
newSaslNegotiator(InetAddress) - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator
Provide a SASL handler to perform authentication for an single connection.
newSaslNegotiator(InetAddress) - Method in class org.apache.tinkerpop.gremlin.server.auth.Krb5Authenticator
 
newSaslNegotiator(InetAddress) - Method in class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
 
next() - Method in class org.apache.tinkerpop.gremlin.server.util.TraverserIterator
 

O

onError(Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
onError(Graph, Context, Throwable) - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
onlySessionTask - Variable in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
 
onQueryError(RequestMessage, Throwable) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
This method will be called before a script or query is processed by the gremlin-server.
onQuerySuccess(RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
When a script or query successfully completes this method will be called.
onShutDown(LifeCycleHook.Context) - Method in interface org.apache.tinkerpop.gremlin.server.util.LifeCycleHook
Called when the server is shutdown.
onStartUp(LifeCycleHook.Context) - Method in interface org.apache.tinkerpop.gremlin.server.util.LifeCycleHook
Called when the server starts up.
onTraversalSuccess(Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
onTraversalSuccess(Graph, Context) - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
OP_PROCESSOR_NAME - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
OP_PROCESSOR_NAME - Static variable in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
OP_PROCESSOR_NAME - Static variable in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
openGraph(String, Function<String, Graph>) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Implementation that allows for custom graph-opening implementations; if the Map tracking graph references has a Graph object corresponding to the graph name, then we return that Graph-- otherwise, we use the custom Function to instantiate a new Graph, add it to the Map tracking graph references, and return said Graph.
openGraph(String, Function<String, Graph>) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Implementation that allows for custom graph-opening implementations; if the Map tracking graph references has a Graph object corresponding to the graph name, then we return that Graph-- otherwise, we use the custom Function to instantiate a new Graph, add it to the Map tracking graph references, and return said Graph.
OpExecutorHandler - Class in org.apache.tinkerpop.gremlin.server.handler
 
OpExecutorHandler(Settings, GraphManager, GremlinExecutor, ScheduledExecutorService) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.OpExecutorHandler
 
OpLoader - Class in org.apache.tinkerpop.gremlin.server.op
Uses ServiceLoader to load OpProcessor instances into a cache.
OpLoader() - Constructor for class org.apache.tinkerpop.gremlin.server.op.OpLoader
 
OpProcessor - Interface in org.apache.tinkerpop.gremlin.server
Interface for providing commands that websocket requests will respond to.
OpProcessorException - Exception in org.apache.tinkerpop.gremlin.server.op
 
OpProcessorException(String, ResponseMessage) - Constructor for exception org.apache.tinkerpop.gremlin.server.op.OpProcessorException
 
OpSelectorHandler - Class in org.apache.tinkerpop.gremlin.server.handler
 
OpSelectorHandler(Settings, GraphManager, GremlinExecutor, ScheduledExecutorService, Channelizer) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.OpSelectorHandler
 
optionalConsoleReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalCsvReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalGangliaReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalGraphiteReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalJmxReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalMetrics() - Method in class org.apache.tinkerpop.gremlin.server.Settings
 
optionalProcessor(Class<? extends OpProcessor>) - Method in class org.apache.tinkerpop.gremlin.server.Settings
Find the Settings.ProcessorSettings related to the specified class.
optionalSlf4jReporter() - Method in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
optionalSsl() - Method in class org.apache.tinkerpop.gremlin.server.Settings
 
org.apache.tinkerpop.gremlin.server - package org.apache.tinkerpop.gremlin.server
 
org.apache.tinkerpop.gremlin.server.auth - package org.apache.tinkerpop.gremlin.server.auth
 
org.apache.tinkerpop.gremlin.server.authz - package org.apache.tinkerpop.gremlin.server.authz
 
org.apache.tinkerpop.gremlin.server.channel - package org.apache.tinkerpop.gremlin.server.channel
 
org.apache.tinkerpop.gremlin.server.handler - package org.apache.tinkerpop.gremlin.server.handler
 
org.apache.tinkerpop.gremlin.server.jsr223 - package org.apache.tinkerpop.gremlin.server.jsr223
 
org.apache.tinkerpop.gremlin.server.op - package org.apache.tinkerpop.gremlin.server.op
 
org.apache.tinkerpop.gremlin.server.op.session - package org.apache.tinkerpop.gremlin.server.op.session
 
org.apache.tinkerpop.gremlin.server.op.standard - package org.apache.tinkerpop.gremlin.server.op.standard
 
org.apache.tinkerpop.gremlin.server.op.traversal - package org.apache.tinkerpop.gremlin.server.op.traversal
 
org.apache.tinkerpop.gremlin.server.util - package org.apache.tinkerpop.gremlin.server.util
 
overrideSslContext(SslContext) - Method in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
When this value is set, the other settings for SSL are ignored.

P

PIPELINE_AUTHENTICATOR - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_AUTHORIZER - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_HTTP_AGGREGATOR - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_HTTP_REQUEST_DECODER - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_HTTP_RESPONSE_ENCODER - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_OP_EXECUTOR - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_OP_SELECTOR - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_REQUEST_HANDLER - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_SSL - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
PIPELINE_UNIFIED - Static variable in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
PIPELINE_WEBSOCKET_SERVER_COMPRESSION - Static variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
plugins - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
A set of configurations for GremlinPlugin instances to apply to this GremlinScriptEngine.
port - Variable in class org.apache.tinkerpop.gremlin.server.Settings.HostPortIntervalMetrics
 
port - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Port to bind the server to.
prefix - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GraphiteReporterMetrics
 
process(SessionTask) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
PROCESSING_EXCEPTION - org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
The session encountered an exception related to execution like a script error, traversal iteration problem, serialization issue, etc.
processors - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Custom settings for OpProcessor implementations.
ProcessorSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.ProcessorSettings
 
protocol31 - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 
putGraph(String, Graph) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Add or update the specified Graph with the specified name to Map<String, Graph> .
putGraph(String, Graph) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
putTraversalSource(String, TraversalSource) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Add or update the specified TraversalSource with the specified name.
putTraversalSource(String, TraversalSource) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 

Q

queue - Variable in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 

R

read(InputStream) - Static method in class org.apache.tinkerpop.gremlin.server.Settings
Read configuration from a file into a new Settings object.
read(String) - Static method in class org.apache.tinkerpop.gremlin.server.Settings
Read configuration from a file into a new Settings object.
registerGremlinScriptEngineMetrics(GremlinScriptEngine, String...) - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Registers metrics from a GremlinScriptEngine.
removeAllMetrics() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
 
removeAllReporters() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Remove all reporters previously configured through the add* methods on this class.
removeConsoleReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a ConsoleReporter previously created by a call to MetricManager.addConsoleReporter(long) and release it for GC.
removeCsvReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a CsvReporter previously created by a call to MetricManager.addCsvReporter(long, String) and release it for GC.
removeGangliaReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a GangliaReporter previously created by a call to addGangliaReporter(String, int, GMetric.UDPAddressingMode, int, Boolean, UUID, long) and release it for GC.
removeGraph(String) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Implementation that allows for custom graph closing implementations; this method should remove the Graph from the GraphManager.
removeGraph(String) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Implementation that allows for custom graph closing implementations; this method should remove the Graph from the GraphManager.
removeGraphiteReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a GraphiteReporter previously created by a call to MetricManager.addGraphiteReporter(String, int, String, long) and release it for GC.
removeHostOption(String) - Method in class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
 
removeJmxReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a JmxReporter previously created by a call to MetricManager.addJmxReporter(String, String) and release it for GC.
removeSlf4jReporter() - Method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Stop a Slf4jReporter previously created by a call to MetricManager.addSlf4jReporter(long, String) and release it for GC.
removeTraversalSource(String) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Remove TraversalSource by name.
removeTraversalSource(String) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
 
REQUEST_MESSAGE - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key for the current request.
REQUEST_TIMEOUT - org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
The session was interrupted by the request timeout.
requireAuthentication() - Method in class org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator
 
requireAuthentication() - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator
Whether or not the authenticator requires explicit login.
requireAuthentication() - Method in class org.apache.tinkerpop.gremlin.server.auth.Krb5Authenticator
 
requireAuthentication() - Method in class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
 
reset() - Static method in class org.apache.tinkerpop.gremlin.server.op.OpLoader
Reset the processors so that they can be re-initialized with different settings which is useful in testing scenarios.
resultIterationBatchSize - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Number of items in a particular resultset to iterate and serialize prior to pushing the data down the wire to the client.
rollback(Set<String>) - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Selectively rollback transactions on the specified graphs or the graphs of traversal sources.
rollback(Set<String>) - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Selectively rollback transactions on the specified graphs or the graphs of traversal sources.
rollbackAll() - Method in interface org.apache.tinkerpop.gremlin.server.GraphManager
Rollback transactions across all Graph objects.
rollbackAll() - Method in class org.apache.tinkerpop.gremlin.server.util.DefaultGraphManager
Rollback transactions across all Graph objects.
run() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
run() - Method in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
 

S

SaslAndHttpBasicAuthenticationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
An Authentication Handler for doing WebSocket Sasl and Http Basic auth
SaslAndHttpBasicAuthenticationHandler(Authenticator, Authorizer, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SaslAndHttpBasicAuthenticationHandler
 
SaslAndHttpBasicAuthenticationHandler(Authenticator, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SaslAndHttpBasicAuthenticationHandler
SaslAuthenticationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
A SASL authentication handler that allows the Authenticator to be plugged into it.
SaslAuthenticationHandler(Authenticator, Authorizer, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SaslAuthenticationHandler
 
SaslAuthenticationHandler(Authenticator, Settings) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SaslAuthenticationHandler
Deprecated.
scheduledExecutorService - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
scheduledExecutorService - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
SCRIPT - org.apache.tinkerpop.gremlin.server.Context.RequestContentType
Contents is of type String.
scriptEngines - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Map of settings for ScriptEngine setting objects keyed by the name of the ScriptEngine implementation.
ScriptEngineSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
 
scripts - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
A comma separated list of script files to execute on ScriptEngine initialization.
select(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
 
select(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
select(Context) - Method in interface org.apache.tinkerpop.gremlin.server.OpProcessor
Given the context (which contains the RequestMessage), return back a Consumer function that will be executed with the context.
selectOther(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
A sub-class may have additional "ops" that it will service.
selectOther(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Older versions of session-based requests accepted a "close" operator in addition to "eval".
selectOther(Context) - Method in class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
sendTimeoutResponse() - Method in class org.apache.tinkerpop.gremlin.server.Context
Writes a default timeout error response message to the underlying channel.
sendTimeoutResponse(String) - Method in class org.apache.tinkerpop.gremlin.server.Context
Writes a specific timeout error response message to the underlying channel.
sendTimeoutResponseForUncommencedTask() - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Respond to the client with the specific timeout response for this Session implementation.
sendTimeoutResponseForUncommencedTask() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
sendTimeoutResponseForUncommencedTask() - Method in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
 
SERIALIZER - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key for the current serializer requested by the client.
serializers - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
serializers - Variable in class org.apache.tinkerpop.gremlin.server.Settings
List of MessageSerializer to configure.
SerializerSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.SerializerSettings
 
ServerGremlinExecutor - Class in org.apache.tinkerpop.gremlin.server.util
The core of script execution in Gremlin Server.
ServerGremlinExecutor(Settings, ExecutorService, ScheduledExecutorService) - Constructor for class org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor
Create a new object from Settings where thread pools are externally assigned.
ServerMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
Session - Class in org.apache.tinkerpop.gremlin.server.op.session
Defines a "session" for the SessionOpProcessor which preserves state between requests made to Gremlin Server.
Session - Interface in org.apache.tinkerpop.gremlin.server.handler
Requests that arrive through the UnifiedHandler are all processed within a Session implementation.
Session(String, Context, ConcurrentHashMap<String, Session>) - Constructor for class org.apache.tinkerpop.gremlin.server.op.session.Session
 
SESSION - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key for the current Session object.
SESSION_TIMEOUT - org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
The session was interrupted by the session lifetime timeout.
SessionException - Exception in org.apache.tinkerpop.gremlin.server.handler
An exception that holds the error-related ResponseMessage which is meant to be returned to the calling client.
SessionException(String, Throwable, ResponseMessage) - Constructor for exception org.apache.tinkerpop.gremlin.server.handler.SessionException
 
SessionException(String, ResponseMessage) - Constructor for exception org.apache.tinkerpop.gremlin.server.handler.SessionException
 
sessionExecutor - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
sessionLifetimeTimeout - Variable in class org.apache.tinkerpop.gremlin.server.Settings
The time in milliseconds that a UnifiedChannelizer session can exist.
SessionOpProcessor - Class in org.apache.tinkerpop.gremlin.server.op.session
Simple OpProcessor implementation that handles ScriptEngine script evaluation in the context of a session.
SessionOpProcessor() - Constructor for class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
sessions - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
sessions - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
sessions - Static variable in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
Script engines are evaluated in a per session context where imports/scripts are isolated per session.
SessionTask - Class in org.apache.tinkerpop.gremlin.server.handler
A SessionTask equates to a particular incoming request to the UnifiedHandler and is analogous to a Context in the OpProcessor approach to handling requests to the server.
SessionTask(RequestMessage, ChannelHandlerContext, Settings, GraphManager, GremlinExecutor, ScheduledExecutorService) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SessionTask
 
sessionTaskStarted - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
sessionThread - Variable in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
The session thread is a reference to the thread that is running the session and should be set by an implementation as the first line of the Runnable.run() method.
setSessionCancelFuture(ScheduledFuture<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
setSessionCancelFuture(ScheduledFuture<?>) - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Sets a reference to the job that will cancel this session if it exceeds its timeout period.
setSessionFuture(Future<?>) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
setSessionFuture(Future<?>) - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Sets a reference to the job itself that is running this session.
setStartedResponse() - Method in class org.apache.tinkerpop.gremlin.server.Context
Signal that the server has started processing the response.
settings - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
settings - Variable in class org.apache.tinkerpop.gremlin.server.handler.SaslAuthenticationHandler
 
settings - Variable in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
Settings - Class in org.apache.tinkerpop.gremlin.server
Server settings as configured by a YAML file.
Settings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings
 
Settings.AuthenticationSettings - Class in org.apache.tinkerpop.gremlin.server
Settings for the Authenticator implementation.
Settings.AuthorizationSettings - Class in org.apache.tinkerpop.gremlin.server
Settings for the Authenticator implementation.
Settings.BaseMetrics - Class in org.apache.tinkerpop.gremlin.server
 
Settings.ConsoleReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to the console.
Settings.CsvReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to a CSV file.
Settings.GangliaReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to Ganglia.
Settings.GraphiteReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to Graphite.
Settings.HostPortIntervalMetrics - Class in org.apache.tinkerpop.gremlin.server
 
Settings.IntervalMetrics - Class in org.apache.tinkerpop.gremlin.server
 
Settings.JmxReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to JMX.
Settings.ProcessorSettings - Class in org.apache.tinkerpop.gremlin.server
Custom configurations for any OpProcessor implementations.
Settings.ScriptEngineSettings - Class in org.apache.tinkerpop.gremlin.server
Settings for the ScriptEngine.
Settings.SerializerSettings - Class in org.apache.tinkerpop.gremlin.server
Settings for the MessageSerializer implementations.
Settings.ServerMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for Metrics recorded by Gremlin Server.
Settings.Slf4jReporterMetrics - Class in org.apache.tinkerpop.gremlin.server
Settings for a Metrics reporter that writes to the SL4J output.
Settings.SslSettings - Class in org.apache.tinkerpop.gremlin.server
Settings to configure SSL support.
setup(Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator
 
setup(Map<String, Object>) - Method in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator
Setup is called once upon system startup to initialize the Authenticator.
setup(Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.server.auth.Krb5Authenticator
Called once on server startup with the authentication.config from the *.yaml file
setup(Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
 
setup(Map<String, Object>) - Method in interface org.apache.tinkerpop.gremlin.server.authz.Authorizer
This method is called once upon system startup to initialize the Authorizer.
SimpleAuthenticator - Class in org.apache.tinkerpop.gremlin.server.auth
A simple implementation of an Authenticator that uses a Graph instance as a credential store.
SimpleAuthenticator() - Constructor for class org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
 
SingleTaskSession - Class in org.apache.tinkerpop.gremlin.server.handler
A simple Session implementation that accepts one request, processes it and exits.
SingleTaskSession(SessionTask, String, ConcurrentMap<String, Session>) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
Constructs a SingleTaskSession that has the task to execute supplied on construction.
slf4jReporter - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ServerMetrics
 
Slf4jReporterMetrics() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.Slf4jReporterMetrics
 
spoof - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 
ssl - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Configures settings for SSL.
sslCipherSuites - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
A list of cipher suites to enable.
sslContext - Variable in class org.apache.tinkerpop.gremlin.server.AbstractChannelizer
 
sslEnabledProtocols - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
A list of SSL protocols to enable.
SslSettings() - Constructor for class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
 
StandardOpProcessor - Class in org.apache.tinkerpop.gremlin.server.op.standard
Simple OpProcessor implementation that handles ScriptEngine script evaluation outside the context of a session.
StandardOpProcessor() - Constructor for class org.apache.tinkerpop.gremlin.server.op.standard.StandardOpProcessor
 
start() - Method in class org.apache.tinkerpop.gremlin.server.GremlinServer
Start Gremlin Server with Settings provided to the constructor.
startTransaction(SessionTask) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
Called right before a transaction starts within Runnable.run().
StateKey - Class in org.apache.tinkerpop.gremlin.server.handler
Keys used in the various handlers to store state in the pipeline.
staticImports - Variable in class org.apache.tinkerpop.gremlin.server.Settings.ScriptEngineSettings
A comma separated list of "static" imports to make available to the ScriptEngine.
stop() - Method in class org.apache.tinkerpop.gremlin.server.GremlinServer
Stop Gremlin Server and free the port binding.
strictTransactionManagement - Variable in class org.apache.tinkerpop.gremlin.server.Settings
If set to true the aliases option is required on requests and Gremlin Server will use that information to control which Graph instances are transaction managed for that request.
submitTask(SessionTask) - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
submitTask(SessionTask) - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Adds a task for session to complete.
submitTask(SessionTask) - Method in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
This implementation only take a single SessionTask on construction - no additional tasks can be submitted.
supportsIdleMonitor() - Method in class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
supportsIdleMonitor() - Method in class org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer
 
supportsIdleMonitor() - Method in class org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
 
supportsIdleMonitor() - Method in interface org.apache.tinkerpop.gremlin.server.Channelizer
Determines if the channelizer supports a method for keeping the connection alive and auto-closing zombie channels.

T

ThreadFactoryUtil - Class in org.apache.tinkerpop.gremlin.server.util
 
threadPoolBoss - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Size of the boss thread pool.
threadPoolWorker - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Size of the worker thread pool.
toString() - Method in class org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser
 
toString() - Method in class org.apache.tinkerpop.gremlin.server.GremlinServer
 
toString() - Method in class org.apache.tinkerpop.gremlin.server.handler.MultiTaskSession
 
toString() - Method in class org.apache.tinkerpop.gremlin.server.handler.SingleTaskSession
 
touch() - Method in class org.apache.tinkerpop.gremlin.server.op.session.Session
 
TraversalOpProcessor - Class in org.apache.tinkerpop.gremlin.server.op.traversal
Simple OpProcessor implementation that iterates remotely submitted serialized Traversal objects.
TraversalOpProcessor() - Constructor for class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
traversalOpTimer - Static variable in interface org.apache.tinkerpop.gremlin.server.handler.Session
 
traversalOpTimer - Static variable in class org.apache.tinkerpop.gremlin.server.op.traversal.TraversalOpProcessor
 
TraverserIterator - Class in org.apache.tinkerpop.gremlin.server.util
 
TraverserIterator(Traversal.Admin) - Constructor for class org.apache.tinkerpop.gremlin.server.util.TraverserIterator
 
triggerTimeout(long, boolean) - Method in class org.apache.tinkerpop.gremlin.server.handler.AbstractSession
 
triggerTimeout(long, boolean) - Method in interface org.apache.tinkerpop.gremlin.server.handler.Session
Provides a general way to interrupt the session by way of a timeout.
trustStore - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
Trusted certificates for verifying the remote client's certificate.
trustStorePassword - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
The password of the Settings.SslSettings.trustStore, or null if it's not password-protected.
trustStoreType - Variable in class org.apache.tinkerpop.gremlin.server.Settings.SslSettings
The format of the Settings.SslSettings.trustStore, either JKS or PKCS12
tryRelease() - Method in class org.apache.tinkerpop.gremlin.server.handler.Frame
If the object contained in the frame is ReferenceCounted then it may need to be released or else Netty will generate warnings that counted resources are leaking.
ttl - Variable in class org.apache.tinkerpop.gremlin.server.Settings.GangliaReporterMetrics
 

U

UnifiedChannelizer - Class in org.apache.tinkerpop.gremlin.server.channel
A Channelizer that supports websocket and HTTP requests and does so with the most streamlined processing model for Gremlin Server introduced with 3.5.0.
UnifiedChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.server.channel.UnifiedChannelizer
 
UnifiedHandler - Class in org.apache.tinkerpop.gremlin.server.handler
Handler for websockets to be used with the UnifiedChannelizer.
UnifiedHandler(Settings, GraphManager, GremlinExecutor, ScheduledExecutorService, Channelizer) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
UNKNOWN - org.apache.tinkerpop.gremlin.server.Context.RequestContentType
Contents are not of a type that is expected.
USE_BINARY - Static variable in class org.apache.tinkerpop.gremlin.server.handler.StateKey
The key to indicate if the serializer should use its binary format.
useCommonEngineForSessions - Variable in class org.apache.tinkerpop.gremlin.server.Settings
When true and using the UnifiedChannelizer the same engine that will be used to server sessionless requests will also be use to serve sessions.
useEpollEventLoop - Variable in class org.apache.tinkerpop.gremlin.server.Settings
detect if the OS is linux, then use epoll instead of NIO which causes less GC
useGlobalFunctionCacheForSessions - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Enable the global function cache for sessions when using the UnifiedChannelizer.
useKeytab(String, File) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 
usePassword(String) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 
USER_AGENT_ATTR_KEY - Static variable in class org.apache.tinkerpop.gremlin.server.handler.WsUserAgentHandler
 
userEventTriggered(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.OpSelectorHandler
 
userEventTriggered(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
userEventTriggered(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.server.handler.WsUserAgentHandler
 
useTicketCache(String, File) - Static method in class org.apache.tinkerpop.gremlin.server.auth.JaasKrbUtil
 

V

validateEvalMessage(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor
 
validateEvalMessage(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor
 
validateRequest(RequestMessage, GraphManager) - Method in class org.apache.tinkerpop.gremlin.server.handler.UnifiedHandler
 
valueOf(String) - Static method in enum org.apache.tinkerpop.gremlin.server.Context.RequestContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.tinkerpop.gremlin.server.Context.RequestContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.tinkerpop.gremlin.server.handler.AbstractSession.CloseReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.tinkerpop.gremlin.server.util.MetricManager
Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocketAuthorizationHandler - Class in org.apache.tinkerpop.gremlin.server.handler
An authorization handler for the websockets channel that allows the Authorizer to be plugged into it.
WebSocketAuthorizationHandler(Authorizer) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WebSocketAuthorizationHandler
 
WebSocketChannelizer - Class in org.apache.tinkerpop.gremlin.server.channel
A Channelizer that exposes a WebSocket-based Gremlin endpoint with a custom sub-protocol.
WebSocketChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer
 
write(ResponseMessage) - Method in class org.apache.tinkerpop.gremlin.server.Context
 
write(ResponseStatusCode, Object) - Method in class org.apache.tinkerpop.gremlin.server.Context
 
writeAndFlush(ResponseMessage) - Method in class org.apache.tinkerpop.gremlin.server.Context
Writes a response message to the underlying channel while ensuring that at most one final response is written.
writeAndFlush(ResponseStatusCode, Object) - Method in class org.apache.tinkerpop.gremlin.server.Context
Writes a response message to the underlying channel while ensuring that at most one final response is written.
writeBufferHighWaterMark - Variable in class org.apache.tinkerpop.gremlin.server.Settings
If the number of bytes in the network send buffer exceeds this value then the channel is no longer writeable, accepting no additional writes until buffer is drained and the Settings.writeBufferLowWaterMark is met.
writeBufferLowWaterMark - Variable in class org.apache.tinkerpop.gremlin.server.Settings
Once the number of bytes queued in the network send buffer exceeds the high water mark, the channel will not become writeable again until the buffer is drained and it drops below this value.
WsAndHttpChannelizer - Class in org.apache.tinkerpop.gremlin.server.channel
A channelizer for port unification with websockets and http
WsAndHttpChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
 
WsAndHttpChannelizerHandler - Class in org.apache.tinkerpop.gremlin.server.handler
A ChannelInboundHandlerAdapter for use with WsAndHttpChannelizer that toggles between WebSockets and http.
WsAndHttpChannelizerHandler() - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsAndHttpChannelizerHandler
 
WsGremlinBinaryRequestDecoder - Class in org.apache.tinkerpop.gremlin.server.handler
Decodes the contents of a BinaryWebSocketFrame.
WsGremlinBinaryRequestDecoder(Map<String, MessageSerializer<?>>) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsGremlinBinaryRequestDecoder
 
WsGremlinCloseRequestDecoder - Class in org.apache.tinkerpop.gremlin.server.handler
Handles close requests over web sockets.
WsGremlinCloseRequestDecoder(Map<String, MessageSerializer<?>>) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsGremlinCloseRequestDecoder
 
WsGremlinResponseFrameEncoder - Class in org.apache.tinkerpop.gremlin.server.handler
Encodes ByteBuf and String values to Websocket frames.
WsGremlinResponseFrameEncoder() - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsGremlinResponseFrameEncoder
 
WsGremlinTextRequestDecoder - Class in org.apache.tinkerpop.gremlin.server.handler
Decodes the contents of a TextWebSocketFrame.
WsGremlinTextRequestDecoder(Map<String, MessageSerializer<?>>) - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsGremlinTextRequestDecoder
 
WsUserAgentHandler - Class in org.apache.tinkerpop.gremlin.server.handler
Channel handler which extracts a user agent header from a web socket handshake if present then logs the user agent and stores it as a channel attribute for future reference.
WsUserAgentHandler() - Constructor for class org.apache.tinkerpop.gremlin.server.handler.WsUserAgentHandler
 
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages