Package org.apache.tinkerpop.gremlin.server

Class Settings.AuthenticationSettings

java.lang.Object

org.apache.tinkerpop.gremlin.server.Settings.AuthenticationSettings

Enclosing class:

Settings

public static class Settings.AuthenticationSettings
extends Object

Settings for the Authenticator implementation.

Field Summary

Fields

Modifier and Type	Field	Description
String	authenticationHandler	The fully qualified class name of the AbstractAuthenticationHandler implementation.
String	authenticator	The fully qualified class name of the Authenticator implementation.
Map<String,Object>	config	A Map containing Authenticator specific configurations.
static int	DEFAULT_MAX_DEFERRED_REQUESTS	Default for maxDeferredRequests.
static long	DEFAULT_MAX_PRE_AUTH_RETAINED_BYTES	Default for maxPreAuthRetainedBytes.
static long	DEFAULT_PRE_AUTH_TIMEOUT	Default for preAuthTimeout.
int	maxDeferredRequests	Number of requests a channel may defer while its SASL authentication is pending.
long	maxPreAuthRetainedBytes	Total wire bytes a channel may have retained while its SASL authentication is pending, covering the request that started it as well as the deferred ones.
long	preAuthTimeout	Time in milliseconds a channel may stay unauthenticated, covering the whole handshake and not just the deferral window, after which it is closed.

Constructor Summary

Constructors

Constructor	Description
AuthenticationSettings()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_DEFERRED_REQUESTS

public static final int DEFAULT_MAX_DEFERRED_REQUESTS

Default for maxDeferredRequests.

See Also:

Constant Field Values

DEFAULT_MAX_PRE_AUTH_RETAINED_BYTES

public static final long DEFAULT_MAX_PRE_AUTH_RETAINED_BYTES

Default for maxPreAuthRetainedBytes.

See Also:

Constant Field Values

DEFAULT_PRE_AUTH_TIMEOUT

public static final long DEFAULT_PRE_AUTH_TIMEOUT

Default for preAuthTimeout.

authenticator

public String authenticator

The fully qualified class name of the Authenticator implementation. This class name will be used to load the implementation from the classpath. Defaults to AllowAllAuthenticator when not specified.

authenticationHandler

public String authenticationHandler

The fully qualified class name of the AbstractAuthenticationHandler implementation. This class name will be used to load the implementation from the classpath. Defaults to null when not specified.

config

public Map<String,Object> config

A Map containing Authenticator specific configurations. Consult the Authenticator implementation for specifics on what configurations are expected.

maxDeferredRequests

public int maxDeferredRequests

Number of requests a channel may defer while its SASL authentication is pending. Must be greater than zero. Only applies to SaslAuthenticationHandler and its subclasses.

maxPreAuthRetainedBytes

public long maxPreAuthRetainedBytes

Total wire bytes a channel may have retained while its SASL authentication is pending, covering the request that started it as well as the deferred ones. Deserialized, their heap footprint is a multiple of this. Must be greater than zero. Only applies to SaslAuthenticationHandler and its subclasses.

preAuthTimeout

public long preAuthTimeout

Time in milliseconds a channel may stay unauthenticated, covering the whole handshake and not just the deferral window, after which it is closed. Must be greater than zero. Only applies to SaslAuthenticationHandler and its subclasses.

Constructor Detail

AuthenticationSettings

public AuthenticationSettings()