All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbstractAuthenticationHandler Provides an abstraction point to allow for http auth schemes beyond basic auth.AbstractChannelizer A base implementation for theChannelizer
which does a basic configuration of the pipeline, one that is generally common to virtually any Gremlin Server operation (i.e.AbstractEvalOpProcessor A baseOpProcessor
implementation that helps with operations that deal with script evaluation functions.AbstractEvalOpProcessor.BindingSupplier AbstractOpProcessor A baseOpProcessor
implementation that processes anIterator
of results in a generalized way while ensuring that graph transactions are properly managed.AbstractSession A base implementation ofSession
which offers some common functionality that matches typical Gremlin Server request response expectations for script, bytecode and graph operations.AbstractSession.CloseReason The reason that a particular session closed.AllowAllAuthenticator Allows all requests to be authenticated.AuthenticatedUser AuthenticationException An exception that occurs when during authentication such as a failed login.Authenticator Provides methods related to authentication of a request.Authenticator.SaslNegotiator Performs the actual SASL negotiation for a single authentication attempt.AuthorizationException An exception that occurs during authorization, i.e.Authorizer Provides the interface for authorizing a user per request.Channelizer 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.CheckedGraphManager AGraphManager
that will prevent Gremlin Server from starting if all configured graphs fail.Context The context of Gremlin Server within which a particular request is made.Context.RequestContentType The type of the request as determined by the contents ofTokens.ARGS_GREMLIN
.DefaultGraphManager Holder forGraph
andTraversalSource
instances configured for the server to be passed to script engine bindings.DefaultTemporaryException This is a defaultTemporaryException
implementation that server implementers could use if they wished to indicate retry operations to the client.ExceptionHelper Deprecated. As of release 3.5.3, replaced byExceptionHelper
ingremlin-core
Frame A holder for aString
orByteBuf
that represents a message to be written back to the requesting client.GraphManager TheGraphManager
interface allows for reference tracking of Graph references through aMap<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 forTraversalSource
objects.GremlinResponseFrameEncoder Ensures that anyResponseMessage
manages to get converted to aFrame
.GremlinServer Start and stop Gremlin Server.GremlinServerGremlinPlugin AGremlinPlugin
implementation that adds Gremlin Server specific classes to the imports.GremlinServerInstall Command line installer for plugins to Gremlin Server.HttpBasicAuthenticationHandler Implements basic HTTP authentication for use with theHttpGremlinEndpointHandler
and HTTP based API calls.HttpBasicAuthorizationHandler An authorization handler for the http channel that allows theAuthorizer
to be plugged into it.HttpChannelizer Constructs aChannelizer
that exposes an HTTP endpoint in Gremlin Server.HttpGremlinEndpointHandler Handler that processes HTTP requests to the HTTP Gremlin endpoint.HttpHandlerUtil Provides methods shared by the HTTP handlers.JaasKrbUtil JAAS utilities for Kerberos login.JaasKrbUtil.KrbCallbackHandler Krb5Authenticator A Kerberos (GSSAPI) implementation of anAuthenticator
This authenticator authenticates and autorizes all clients with a valid service ticket.LifeCycleHook Provides a method in which users can hook into the startup and shutdown lifecycle of Gremlin Server.LifeCycleHook.Context Contains objects from the server that might be useful to scripting during the startup and shutdown process.MetricManager Singleton that contains and configures Gremlin Server'sMetricRegistry
.MultiTaskSession ASession
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.OpExecutorHandler OpLoader UsesServiceLoader
to loadOpProcessor
instances into a cache.OpProcessor Interface for providing commands that websocket requests will respond to.OpProcessorException OpSelectorHandler SaslAndHttpBasicAuthenticationHandler An Authentication Handler for doing WebSocket Sasl and Http Basic authSaslAuthenticationHandler A SASL authentication handler that allows theAuthenticator
to be plugged into it.ServerGremlinExecutor The core of script execution in Gremlin Server.Session Requests that arrive through theUnifiedHandler
are all processed within aSession
implementation.Session Defines a "session" for theSessionOpProcessor
which preserves state between requests made to Gremlin Server.SessionException An exception that holds the error-relatedResponseMessage
which is meant to be returned to the calling client.SessionOpProcessor SimpleOpProcessor
implementation that handlesScriptEngine
script evaluation in the context of a session.SessionTask ASessionTask
equates to a particular incoming request to theUnifiedHandler
and is analogous to aContext
in theOpProcessor
approach to handling requests to the server.Settings Server settings as configured by a YAML file.Settings.AuthenticationSettings Settings for theAuthenticator
implementation.Settings.AuthorizationSettings Settings for theAuthenticator
implementation.Settings.BaseMetrics Settings.ConsoleReporterMetrics Settings for aMetrics
reporter that writes to the console.Settings.CsvReporterMetrics Settings for aMetrics
reporter that writes to a CSV file.Settings.GangliaReporterMetrics Settings for aMetrics
reporter that writes to Ganglia.Settings.GraphiteReporterMetrics Settings for aMetrics
reporter that writes to Graphite.Settings.HostPortIntervalMetrics Settings.IntervalMetrics Settings.JmxReporterMetrics Settings for aMetrics
reporter that writes to JMX.Settings.ProcessorSettings Custom configurations for anyOpProcessor
implementations.Settings.ScriptEngineSettings Settings for theScriptEngine
.Settings.SerializerSettings Settings for theMessageSerializer
implementations.Settings.ServerMetrics Settings forMetrics
recorded by Gremlin Server.Settings.Slf4jReporterMetrics Settings for aMetrics
reporter that writes to the SL4J output.Settings.SslSettings Settings to configure SSL support.SimpleAuthenticator A simple implementation of anAuthenticator
that uses aGraph
instance as a credential store.SingleTaskSession A simpleSession
implementation that accepts one request, processes it and exits.StandardOpProcessor SimpleOpProcessor
implementation that handlesScriptEngine
script evaluation outside the context of a session.StateKey Keys used in the various handlers to store state in the pipeline.ThreadFactoryUtil TraversalOpProcessor SimpleOpProcessor
implementation that iterates remotely submitted serializedTraversal
objects.TraverserIterator UnifiedChannelizer AChannelizer
that supports websocket and HTTP requests and does so with the most streamlined processing model for Gremlin Server introduced with 3.5.0.UnifiedHandler Handler for websockets to be used with theUnifiedChannelizer
.WebSocketAuthorizationHandler An authorization handler for the websockets channel that allows theAuthorizer
to be plugged into it.WebSocketChannelizer AChannelizer
that exposes a WebSocket-based Gremlin endpoint with a custom sub-protocol.WsAndHttpChannelizer A channelizer for port unification with websockets and httpWsAndHttpChannelizerHandler A ChannelInboundHandlerAdapter for use withWsAndHttpChannelizer
that toggles between WebSockets and http.WsGremlinBinaryRequestDecoder Decodes the contents of aBinaryWebSocketFrame
.WsGremlinCloseRequestDecoder Handles close requests over web sockets.WsGremlinResponseFrameEncoder EncodesByteBuf
andString
values to Websocket frames.WsGremlinTextRequestDecoder Decodes the contents of aTextWebSocketFrame
.WsUserAgentHandler 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.