io.lettuce.core

Class SslOptions.Builder

java.lang.Object

io.lettuce.core.SslOptions.Builder

Enclosing class:

SslOptions

public static class SslOptions.Builder
extends Object

Builder for SslOptions.

Method Summary

Modifier and Type	Method and Description
SslOptions	build() Create a new instance of SslOptions
SslOptions.Builder	jdkSslProvider() Use the JDK SSL provider for SSL connections.
SslOptions.Builder	keystore(File keystore) Sets the Keystore file to load client certificates.
SslOptions.Builder	keystore(File keystore, char[] keystorePassword) Sets the Keystore file to load client certificates.
SslOptions.Builder	keystore(URL keystore) Sets the Keystore resource to load client certificates.
SslOptions.Builder	keystore(URL keystore, char[] keystorePassword) Sets the Keystore resource to load client certificates.
SslOptions.Builder	openSslProvider() Use the OpenSSL provider for SSL connections.
SslOptions.Builder	truststore(File truststore) Sets the Truststore file to load trusted certificates.
SslOptions.Builder	truststore(File truststore, String truststorePassword) Sets the Truststore file to load trusted certificates.
SslOptions.Builder	truststore(URL truststore) Sets the Truststore resource to load trusted certificates.
SslOptions.Builder	truststore(URL truststore, String truststorePassword) Sets the Truststore resource to load trusted certificates.

Methods inherited from class java.lang.Object

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

Method Detail

jdkSslProvider

public SslOptions.Builder jdkSslProvider()

Use the JDK SSL provider for SSL connections.

Returns:

this

openSslProvider

public SslOptions.Builder openSslProvider()

Use the OpenSSL provider for SSL connections. The OpenSSL provider requires the netty-tcnative dependency with the OpenSSL JNI binary.

Returns:

this

Throws:

IllegalStateException - if OpenSSL is not available

keystore

public SslOptions.Builder keystore(File keystore)

Sets the Keystore file to load client certificates. The key store file must be supported by KeyStore which is jks by default. Keystores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore file, must not be null.

Returns:

this

Since:

4.4

keystore

public SslOptions.Builder keystore(File keystore,
                                   char[] keystorePassword)

Sets the Keystore file to load client certificates. The key store file must be supported by KeyStore which is jks by default. Keystores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore file, must not be null.

keystorePassword - the keystore password. May be empty to omit password and the keystore integrity check.

Returns:

this

Since:

4.4

keystore

public SslOptions.Builder keystore(URL keystore)

Sets the Keystore resource to load client certificates. The trust store file must be supported by KeyStore which is jks by default. Keystore are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore file, must not be null.

Returns:

this

Since:

4.4

keystore

public SslOptions.Builder keystore(URL keystore,
                                   char[] keystorePassword)

Sets the Keystore resource to load client certificates. The trust store file must be supported by KeyStore which is jks by default. Keystores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore file, must not be null.

keystorePassword - the keystore password. May be empty to omit password and the keystore integrity check.

Returns:

this

Since:

4.4

truststore

public SslOptions.Builder truststore(File truststore)

Sets the Truststore file to load trusted certificates. The trust store file must be supported by KeyStore which is jks by default. Truststores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

truststore - the truststore file, must not be null.

Returns:

this

truststore

public SslOptions.Builder truststore(File truststore,
                                     String truststorePassword)

Sets the Truststore file to load trusted certificates. The trust store file must be supported by KeyStore which is jks by default. Truststores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

truststore - the truststore file, must not be null.

truststorePassword - the truststore password. May be empty to omit password and the truststore integrity check.

Returns:

this

truststore

public SslOptions.Builder truststore(URL truststore)

Sets the Truststore resource to load trusted certificates. The trust store file must be supported by KeyStore which is jks by default. Truststores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

truststore - the truststore file, must not be null.

Returns:

this

truststore

public SslOptions.Builder truststore(URL truststore,
                                     String truststorePassword)

Sets the Truststore resource to load trusted certificates. The trust store file must be supported by KeyStore which is jks by default. Truststores are reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

truststore - the truststore file, must not be null.

truststorePassword - the truststore password. May be empty to omit password and the truststore integrity check.

Returns:

this

build

public SslOptions build()

Create a new instance of SslOptions

Returns:

new instance of SslOptions