redis.clients.jedis

Class SslOptions.Builder

java.lang.Object

redis.clients.jedis.SslOptions.Builder

Enclosing class:

SslOptions

public static class SslOptions.Builder
extends java.lang.Object

Builder for SslOptions.

Method Summary

Modifier and Type	Method and Description
SslOptions	build() Create a new instance of SslOptions
SslOptions.Builder	keystore(java.io.File keystore) Sets the Keystore file to load client certificates.
SslOptions.Builder	keystore(java.io.File keystore, char[] keystorePassword) Sets the Keystore file to load client certificates.
SslOptions.Builder	keystore(SslOptions.Resource resource, char[] keystorePassword) Sets the Java Keystore resource to load client certificates.
SslOptions.Builder	keystore(java.net.URL keystore) Sets the Keystore resource to load client certificates.
SslOptions.Builder	keystore(java.net.URL keystore, char[] keystorePassword) Sets the Keystore resource to load client certificates.
SslOptions.Builder	keyStoreType(java.lang.String keyStoreType) Sets the KeyStore type.
SslOptions.Builder	sslParameters(javax.net.ssl.SSLParameters sslParameters) Sets a configured SSLParameters.
SslOptions.Builder	sslProtocol(java.lang.String protocol) The SSL/TLS protocol to be used to initialize SSLContext.
SslOptions.Builder	sslVerifyMode(SslVerifyMode sslVerifyMode) Sets the SslVerifyMode.
SslOptions.Builder	truststore(java.io.File truststore) Sets the Truststore file to load trusted certificates.
SslOptions.Builder	truststore(java.io.File truststore, char[] truststorePassword) Sets the Truststore file to load trusted certificates.
SslOptions.Builder	truststore(SslOptions.Resource resource, char[] truststorePassword) Sets the Truststore resource to load trusted certificates.
SslOptions.Builder	truststore(java.net.URL truststore) Sets the Truststore resource to load trusted certificates.
SslOptions.Builder	truststore(java.net.URL truststore, char[] truststorePassword) Sets the Truststore resource to load trusted certificates.
SslOptions.Builder	trustStoreType(java.lang.String trustStoreType) Sets the KeyStore type.

Methods inherited from class java.lang.Object

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

Method Detail

keyStoreType

public SslOptions.Builder keyStoreType(java.lang.String keyStoreType)

Sets the KeyStore type. Defaults to KeyStore.getDefaultType() if not set.

Parameters:

keyStoreType - the keystore type to use, must not be null.

Returns:

this

trustStoreType

public SslOptions.Builder trustStoreType(java.lang.String trustStoreType)

Sets the KeyStore type. Defaults to KeyStore.getDefaultType() if not set.

Parameters:

trustStoreType - the keystore type to use, must not be null.

Returns:

this

keystore

public SslOptions.Builder keystore(java.io.File keystore)

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

Parameters:

keystore - the keystore file, must not be null.

Returns:

this

keystore

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

Sets the Keystore file to load client certificates. The keystore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The keystore is 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

keystore

public SslOptions.Builder keystore(java.net.URL keystore)

Sets the Keystore resource to load client certificates. The keystore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The keystore is reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore URL, must not be null.

Returns:

this

keystore

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

Sets the Keystore resource to load client certificates. The keystore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The keystore is reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

keystore - the keystore file, must not be null.

keystorePassword -

Returns:

this

keystore

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

Sets the Java Keystore resource to load client certificates. The keystore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The keystore is reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

resource - the provider that opens a InputStream to the keystore file, must not be null.

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

Returns:

this

truststore

public SslOptions.Builder truststore(java.io.File truststore)

Sets the Truststore file to load trusted certificates. The truststore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The truststore is 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(java.io.File truststore,
                                     char[] truststorePassword)

Sets the Truststore file to load trusted certificates. The truststore file must be supported by KeyStore which is KeyStore.getDefaultType() by default. The truststore is 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(java.net.URL truststore)

Sets the Truststore resource to load trusted certificates. The truststore resource must be supported by KeyStore which is KeyStore.getDefaultType() by default. The truststore is 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(java.net.URL truststore,
                                     char[] truststorePassword)

Sets the Truststore resource to load trusted certificates. The truststore resource must be supported by KeyStore which is KeyStore.getDefaultType() by default. The truststore is 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(SslOptions.Resource resource,
                                     char[] truststorePassword)

Sets the Truststore resource to load trusted certificates. The truststore resource must be supported by KeyStore which is KeyStore.getDefaultType() by default. The truststore is reloaded on each connection attempt that allows to replace certificates during runtime.

Parameters:

resource - the provider that opens a InputStream to the keystore file, must not be null.

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

Returns:

this

sslParameters

public SslOptions.Builder sslParameters(javax.net.ssl.SSLParameters sslParameters)

Sets a configured SSLParameters.

Parameters:

sslParameters - a SSLParameters object.

Returns:

this

sslVerifyMode

public SslOptions.Builder sslVerifyMode(SslVerifyMode sslVerifyMode)

Sets the SslVerifyMode.

Parameters:

sslVerifyMode - the SslVerifyMode.

Returns:

this

sslProtocol

public SslOptions.Builder sslProtocol(java.lang.String protocol)

The SSL/TLS protocol to be used to initialize SSLContext.

Parameters:

protocol - the ssl/tls protocol

Returns:

this

build

public SslOptions build()

Create a new instance of SslOptions

Returns:

new instance of SslOptions