public class Settings extends Object
Modifier and Type | Class and Description |
---|---|
static class |
Settings.AuthenticationSettings
Settings for the
Authenticator implementation. |
static class |
Settings.BaseMetrics |
static class |
Settings.ConsoleReporterMetrics
Settings for a
Metrics reporter that writes to the console. |
static class |
Settings.CsvReporterMetrics
Settings for a
Metrics reporter that writes to a CSV file. |
static class |
Settings.GangliaReporterMetrics
Settings for a
Metrics reporter that writes to Ganglia. |
static class |
Settings.GraphiteReporterMetrics
Settings for a
Metrics reporter that writes to Graphite. |
static class |
Settings.HostPortIntervalMetrics |
static class |
Settings.IntervalMetrics |
static class |
Settings.JmxReporterMetrics
Settings for a
Metrics reporter that writes to JMX. |
static class |
Settings.ProcessorSettings
Custom configurations for any
OpProcessor implementations. |
static class |
Settings.ScriptEngineSettings
Settings for the
ScriptEngine . |
static class |
Settings.SerializerSettings
Settings for the
MessageSerializer implementations. |
static class |
Settings.ServerMetrics
Settings for
Metrics recorded by Gremlin Server. |
static class |
Settings.Slf4jReporterMetrics
Settings for a
Metrics reporter that writes to the SL4J output. |
static class |
Settings.SslSettings
Settings to configure SSL support.
|
Modifier and Type | Field and Description |
---|---|
Settings.AuthenticationSettings |
authentication |
String |
channelizer
The full class name of the
Channelizer to use in Gremlin Server. |
long |
evaluationTimeout
Time in milliseconds to wait for a request (script or bytecode) to complete execution.
|
String |
graphManager
The full class name of the
GraphManager to use in Gremlin Server. |
Map<String,String> |
graphs
|
int |
gremlinPool
Size of the Gremlin thread pool.
|
String |
host
Host to bind the server to.
|
long |
idleConnectionTimeout
Time in milliseconds that the server will allow a channel to not receive requests from a client before it
automatically closes.
|
long |
keepAliveInterval
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.
|
int |
maxAccumulationBufferComponents
Maximum number of request components that can be aggregated for a message.
|
int |
maxChunkSize
The maximum length of the content or each chunk.
|
int |
maxContentLength
The maximum length of the aggregated content for a message.
|
int |
maxHeaderSize
The maximum length of all headers.
|
int |
maxInitialLineLength
The maximum length of the initial line (e.g.
|
Settings.ServerMetrics |
metrics
Configured metrics for Gremlin Server.
|
int |
port
Port to bind the server to.
|
List<Settings.ProcessorSettings> |
processors
Custom settings for
OpProcessor implementations. |
int |
resultIterationBatchSize
Number of items in a particular resultset to iterate and serialize prior to pushing the data down the wire
to the client.
|
Map<String,Settings.ScriptEngineSettings> |
scriptEngines
Map of settings for ScriptEngine setting objects keyed by the name of the ScriptEngine
implementation. |
long |
scriptEvaluationTimeout
Deprecated.
As of release 3.3.9, replaced by
evaluationTimeout . |
List<Settings.SerializerSettings> |
serializers
List of
MessageSerializer to configure. |
Settings.SslSettings |
ssl
Configures settings for SSL.
|
boolean |
strictTransactionManagement
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. |
int |
threadPoolBoss
Size of the boss thread pool.
|
int |
threadPoolWorker
Size of the worker thread pool.
|
boolean |
useEpollEventLoop
detect if the OS is linux, then use epoll instead of NIO which causes less GC
|
int |
writeBufferHighWaterMark
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
writeBufferLowWaterMark is met. |
int |
writeBufferLowWaterMark
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.
|
Constructor and Description |
---|
Settings() |
Modifier and Type | Method and Description |
---|---|
protected static Constructor |
createDefaultYamlConstructor()
Creates
Constructor which contains all configurations to parse
a Gremlin Server YAML configuration file using SnakeYAML. |
long |
getEvaluationTimeout() |
Optional<Settings.ServerMetrics> |
optionalMetrics() |
Optional<Settings.ProcessorSettings> |
optionalProcessor(Class<? extends OpProcessor> clazz)
Find the
Settings.ProcessorSettings related to the specified class. |
Optional<Settings.SslSettings> |
optionalSsl() |
static Settings |
read(InputStream stream)
Read configuration from a file into a new
Settings object. |
static Settings |
read(String file)
Read configuration from a file into a new
Settings object. |
public String host
public int port
public int threadPoolWorker
public boolean useEpollEventLoop
public int gremlinPool
Runtime#availableProcessors()
.public int threadPoolBoss
@Deprecated public long scriptEvaluationTimeout
evaluationTimeout
.evaluationTimeout
for this configuration. When set to something greater than -1 then
this configuration is used.public long evaluationTimeout
public int resultIterationBatchSize
public int maxInitialLineLength
"GET / HTTP/1.0"
) processed in a request, which essentially
controls the maximum length of the submitted URI. This setting ties to the Netty HttpRequestDecoder
.public int maxHeaderSize
HttpRequestDecoder
public int maxChunkSize
HttpContent
s. If the transfer encoding of the HTTP request is 'chunked' already, each chunk will be
split into smaller chunks if the length of the chunk exceeds this value.public int maxContentLength
maxChunkSize
where
chunked requests are accumulated back into a single message. A request exceeding this size will
return a 413 - Request Entity Too Large status code. A response exceeding this size will raise an internal
exception.public int maxAccumulationBufferComponents
public int writeBufferHighWaterMark
writeBufferLowWaterMark
is met.public int writeBufferLowWaterMark
public long idleConnectionTimeout
keepAliveInterval
. Note that while this value is to be provided as milliseconds it will resolve to
second precision. Set this value to 0 to disable this feature.public long keepAliveInterval
idleConnectionTimeout
and keep the channel open. If enabled, this number should be
smaller than the value provided to the idleConnectionTimeout
. Note that while this value is to be
provided as milliseconds it will resolve to second precision. Set this value to 0 to disable this feature.public boolean strictTransactionManagement
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. If this
setting is false (which is the default), specification of aliases
is not required and Gremlin
Server will simply apply a commit for all graphs. This setting only applies to sessionless requests.
With either setting the user is responsible for their own transaction management for in-session requests.public String channelizer
Channelizer
to use in Gremlin Server.public String graphManager
GraphManager
to use in Gremlin Server.public Settings.ServerMetrics metrics
public Map<String,Settings.ScriptEngineSettings> scriptEngines
Map
of settings for ScriptEngine
setting objects keyed by the name of the ScriptEngine
implementation.public List<Settings.SerializerSettings> serializers
MessageSerializer
to configure. If no serializers are specified then default serializers for
the most current versions of "application/json" and "application/vnd.gremlin-v1.0+gryo" are applied.public Settings.SslSettings ssl
public Settings.AuthenticationSettings authentication
public List<Settings.ProcessorSettings> processors
OpProcessor
implementations. Implementations are loaded via
ServiceLoader
but custom configurations can be supplied through this configuration.public Optional<Settings.ProcessorSettings> optionalProcessor(Class<? extends OpProcessor> clazz)
Settings.ProcessorSettings
related to the specified class. If there are multiple entries then only the
first is returned.public Optional<Settings.ServerMetrics> optionalMetrics()
public Optional<Settings.SslSettings> optionalSsl()
public long getEvaluationTimeout()
public static Settings read(String file) throws Exception
Settings
object.protected static Constructor createDefaultYamlConstructor()
Constructor
which contains all configurations to parse
a Gremlin Server YAML configuration file using SnakeYAML.Constructor
to parse a Gremlin Server YAMLpublic static Settings read(InputStream stream)
Settings
object.Copyright © 2013–2021 Apache Software Foundation. All rights reserved.