Package org.apache.tinkerpop.gremlin.server

Class Settings.SslSettings

java.lang.Object

org.apache.tinkerpop.gremlin.server.Settings.SslSettings

Enclosing class:

Settings

public static class Settings.SslSettings
extends Object

Settings to configure SSL support.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	enabled	Enables SSL.
String	keyStore	The file location of the private key in JKS or PKCS#12 format.
String	keyStorePassword	The password of the keyStore, or null if it's not password-protected.
String	keyStoreType	The format of the keyStore, either JKS or PKCS12
io.netty.handler.ssl.ClientAuth	needClientAuth	Require client certificate authentication
long	refreshIntervalMillis	The interval, in milliseconds, at which the trustStore and keyStore files are checked for updates.
List<String>	sslCipherSuites	A list of cipher suites to enable.
List<String>	sslEnabledProtocols	A list of SSL protocols to enable.
String	trustStore	Trusted certificates for verifying the remote client's certificate.
String	trustStorePassword	The password of the trustStore, or null if it's not password-protected.
String	trustStoreType	The format of the trustStore, either JKS or PKCS12

Constructor Summary

Constructors

Constructor	Description
SslSettings()

Method Summary

Modifier and Type	Method	Description
Optional<io.netty.handler.ssl.SslContext>	getSslContext()
void	overrideSslContext(io.netty.handler.ssl.SslContext sslContext)	When this value is set, the other settings for SSL are ignored.

Methods inherited from class java.lang.Object

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

Field Details

enabled

public boolean enabled

Enables SSL. Other SSL settings will be ignored unless this is set to true.

keyStore

public String keyStore

The file location of the private key in JKS or PKCS#12 format.

keyStorePassword

public String keyStorePassword

The password of the keyStore, or null if it's not password-protected.

trustStore

public String trustStore

Trusted certificates for verifying the remote client's certificate. If this value is not provided and SSL is enabled, the default TrustManager will be used.

trustStorePassword

public String trustStorePassword

The password of the trustStore, or null if it's not password-protected.

keyStoreType

public String keyStoreType

The format of the keyStore, either JKS or PKCS12

trustStoreType

public String trustStoreType

The format of the trustStore, either JKS or PKCS12

sslEnabledProtocols

public List<String> sslEnabledProtocols

A list of SSL protocols to enable. @see JSSE Protocols

sslCipherSuites

public List<String> sslCipherSuites

A list of cipher suites to enable. @see Cipher Suites

needClientAuth

public io.netty.handler.ssl.ClientAuth needClientAuth

Require client certificate authentication

refreshIntervalMillis

public long refreshIntervalMillis

The interval, in milliseconds, at which the trustStore and keyStore files are checked for updates. The default interval is 60 seconds.

Constructor Details

SslSettings

public SslSettings()

Method Details

overrideSslContext

public void overrideSslContext(io.netty.handler.ssl.SslContext sslContext)

When this value is set, the other settings for SSL are ignored. This option provides for a programmatic way to configure more complex SSL configurations. The enabled setting should still be set to true for this setting to take effect.

getSslContext

public Optional<io.netty.handler.ssl.SslContext> getSslContext()