Settings (Apache TinkerPop 3.0.1-incubating API)

java.lang.Object
- org.apache.tinkerpop.gremlin.server.Settings

```
public class Settings
extends Object
```
Server settings as configured by a YAML file.

Author:

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

Nested Class Summary

Nested Classes
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.

Field Summary

Fields
Modifier and Type	Field and Description
`Settings.AuthenticationSettings`	`authentication`
`String`	`channelizer` The full class name of the `Channelizer` to use in Gremlin Server.
`Map<String,String>`	`graphs` `Map` of `Graph` objects keyed by their binding name.
`int`	`gremlinPool` Size of the Gremlin thread pool.
`String`	`host` Host to bind the server to.
`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.
`List<String>`	`plugins` The list of plugins to enable for the 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` Time in milliseconds to wait for a script to complete execution.
`long`	`serializedResponseTimeout` Time in milliseconds to wait while an evaluated script serializes its results.
`List<Settings.SerializerSettings>`	`serializers` List of `MessageSerializer` to configure.
`Settings.SslSettings`	`ssl` Configures settings for SSL.
`int`	`threadPoolBoss` Size of the boss thread pool.
`int`	`threadPoolWorker` Size of the worker thread pool.
`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 Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<Settings.ServerMetrics>`	`optionalMetrics()`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - host
```
public String host
```
    Host to bind the server to. Defaults to localhost.
  - port
```
public int port
```
    Port to bind the server to. Defaults to 8182.
  - threadPoolWorker
```
public int threadPoolWorker
```
    Size of the worker thread pool. Defaults to 1 and should generally not exceed 2 * number of cores. A worker thread performs non-blocking read and write for one or more Channels in a non-blocking mode.
  - gremlinPool
```
public int gremlinPool
```
    Size of the Gremlin thread pool. This pool handles Gremlin script execution and other related "long-run" processing. This setting should be sufficiently large to ensure that requests processed by the non-blocking worker threads are processed with limited queuing. Defaults to 8.
  - threadPoolBoss
```
public int threadPoolBoss
```
    Size of the boss thread pool. Defaults to 1 and should likely stay at 1. The bossy thread accepts incoming connections on a port until it is unbound. Once a connection is accepted successfully, the boss thread passes processing to the worker threads.
  - scriptEvaluationTimeout
```
public long scriptEvaluationTimeout
```
    Time in milliseconds to wait for a script to complete execution. Defaults to 30000.
  - serializedResponseTimeout
```
public long serializedResponseTimeout
```
    Time in milliseconds to wait while an evaluated script serializes its results. This value represents the total serialization time for the request. Defaults to 30000.
  - resultIterationBatchSize
```
public int resultIterationBatchSize
```
    Number of items in a particular resultset to iterate and serialize prior to pushing the data down the wire to the client.
  - maxInitialLineLength
```
public int maxInitialLineLength
```
    The maximum length of the initial line (e.g. "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.
  - maxHeaderSize
```
public int maxHeaderSize
```
    The maximum length of all headers. This setting ties to the Netty HttpRequestDecoder
  - maxChunkSize
```
public int maxChunkSize
```
    The maximum length of the content or each chunk. If the content length exceeds this value, the transfer encoding of the decoded request will be converted to 'chunked' and the content will be split into multiple HttpContents. 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.
  - maxContentLength
```
public int maxContentLength
```
    The maximum length of the aggregated content for a message. Works in concert with 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.
  - maxAccumulationBufferComponents
```
public int maxAccumulationBufferComponents
```
    Maximum number of request components that can be aggregated for a message.
  - writeBufferHighWaterMark
```
public 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.
  - writeBufferLowWaterMark
```
public 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.
  - channelizer
```
public String channelizer
```
    The full class name of the Channelizer to use in Gremlin Server.
  - metrics
```
public Settings.ServerMetrics metrics
```
    Configured metrics for Gremlin Server.
  - graphs
```
public Map<String,String> graphs
```
    Map of Graph objects keyed by their binding name.
  - scriptEngines
```
public Map<String,Settings.ScriptEngineSettings> scriptEngines
```
    Map of settings for ScriptEngine setting objects keyed by the name of the ScriptEngine implementation.
  - serializers
```
public List<Settings.SerializerSettings> serializers
```
    List of MessageSerializer to configure.
  - ssl
```
public Settings.SslSettings ssl
```
    Configures settings for SSL.
  - authentication
```
public Settings.AuthenticationSettings authentication
```
  - plugins
```
public List<String> plugins
```
    The list of plugins to enable for the server. Plugins may be available on the classpath, but with this configuration it is possible to explicitly include or omit them.
  - processors
```
public List<Settings.ProcessorSettings> processors
```
    Custom settings for OpProcessor implementations. Implementations are loaded via ServiceLoader but custom configurations can be supplied through this configuration.
- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - optionalMetrics
```
public Optional<Settings.ServerMetrics> optionalMetrics()
```
  - optionalSsl
```
public Optional<Settings.SslSettings> optionalSsl()
```
  - read
```
public static Settings read(String file)
                     throws Exception
```
    Read configuration from a file into a new Settings object.
    
    Parameters:
    
    file - the location of a Gremlin Server YAML configuration file
    
    Returns:
    
    a new Optional object wrapping the created Settings
    
    Throws:
    
    Exception
  - read
```
public static Settings read(InputStream stream)
```
    Read configuration from a file into a new Settings object.
    
    Parameters:
    
    stream - an input stream containing a Gremlin Server YAML configuration
    
    Returns:
    
    a new Optional object wrapping the created Settings

Class Settings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

host

port

threadPoolWorker

gremlinPool

threadPoolBoss

scriptEvaluationTimeout

serializedResponseTimeout

resultIterationBatchSize

maxInitialLineLength

maxHeaderSize

maxChunkSize

maxContentLength

maxAccumulationBufferComponents

writeBufferHighWaterMark

writeBufferLowWaterMark

channelizer

metrics

graphs

scriptEngines

serializers

ssl

authentication

plugins

processors

Constructor Detail

Settings

Method Detail

optionalMetrics

optionalSsl

read

read