Package org.infinispan.client.hotrod.configuration

Class SslConfigurationBuilder

java.lang.Object

org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

org.infinispan.client.hotrod.configuration.AbstractSecurityConfigurationChildBuilder

org.infinispan.client.hotrod.configuration.SslConfigurationBuilder

All Implemented Interfaces:

ConfigurationChildBuilder, Builder<SslConfiguration>

public class SslConfigurationBuilder
extends AbstractSecurityConfigurationChildBuilder
implements Builder<SslConfiguration>

SSLConfigurationBuilder.

Since:

5.3

Author:

Tristan Tarrant

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SslConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
SslConfigurationBuilder	ciphers(String... ciphers)	Configures the ciphers Setting this property also implicitly enables SSL/TLS (see enable()
SslConfiguration	create()	Create the configuration bean
SslConfigurationBuilder	disable()	Disables the SSL support
SslConfigurationBuilder	enable()	Enables the SSL support
SslConfigurationBuilder	enabled(boolean enabled)	Enables or disables the SSL support
SslConfigurationBuilder	hostnameValidation(boolean hostnameValidation)	Configures whether to enable hostname validation according to RFC 2818.
SslConfigurationBuilder	keyAlias(String keyAlias)	Sets the alias of the key to use, in case the keyStore contains multiple certificates.
SslConfigurationBuilder	keyStoreCertificatePassword(char[] keyStoreCertificatePassword)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3
SslConfigurationBuilder	keyStoreFileName(String keyStoreFileName)	Specifies the filename of a keystore to use to create the SSLContext You also need to specify a keyStorePassword(char[]).
SslConfigurationBuilder	keyStorePassword(char[] keyStorePassword)	Specifies the password needed to open the keystore You also need to specify a keyStoreFileName(String).
SslConfigurationBuilder	keyStoreType(String keyStoreType)	Specifies the type of the keystore, such as JKS or JCEKS.
SslConfigurationBuilder	protocol(String protocol)	Configures the secure socket protocol.
SslConfigurationBuilder	provider(String provider)	Configures the SSL provider.
SslConfigurationBuilder	read(SslConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
SslConfigurationBuilder	sniHostName(String sniHostName)	Specifies the TLS SNI hostname for the connection
SslConfigurationBuilder	sslContext(SSLContext sslContext)	Specifies a pre-built SSLContext
SslConfigurationBuilder	trustStoreFileName(String trustStoreFileName)	Specifies the filename of a truststore to use to create the SSLContext You also need to specify a trustStorePassword(char[]).
SslConfigurationBuilder	trustStorePassword(char[] trustStorePassword)	Specifies the password needed to open the truststore You also need to specify a trustStoreFileName(String).
SslConfigurationBuilder	trustStorePath(String trustStorePath)	Deprecated, for removal: This API element is subject to removal in a future version. since 12.0 to be removed in 15.0.
SslConfigurationBuilder	trustStoreType(String trustStoreType)	Specifies the type of the truststore, such as JKS or JCEKS.
void	validate()	Validate the data in this builder before building the configuration bean
ConfigurationBuilder	withProperties(Properties properties)	Configures this builder using the specified properties.

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractSecurityConfigurationChildBuilder

authentication, ssl

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

addCluster, addContextInitializer, addContextInitializer, addContextInitializers, addJavaSerialAllowList, addJavaSerialWhiteList, addServer, addServers, asyncExecutorFactory, balancingStrategy, balancingStrategy, balancingStrategy, batchSize, build, classLoader, clientIntelligence, connectionPool, connectionTimeout, consistentHashImpl, consistentHashImpl, dnsResolverMaxTTL, dnsResolverMinTTL, dnsResolverNegativeTTL, forceReturnValues, keySizeEstimate, marshaller, marshaller, marshaller, maxRetries, protocolVersion, remoteCache, security, socketTimeout, statistics, tcpKeepAlive, tcpNoDelay, transaction, transactionTimeout, transportFactory, uri, uri, valueSizeEstimate, version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset

Constructor Details

SslConfigurationBuilder

protected SslConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<SslConfiguration>

disable

public SslConfigurationBuilder disable()

Disables the SSL support

enable

public SslConfigurationBuilder enable()

Enables the SSL support

enabled

public SslConfigurationBuilder enabled(boolean enabled)

Enables or disables the SSL support

keyStoreFileName

public SslConfigurationBuilder keyStoreFileName(String keyStoreFileName)

Specifies the filename of a keystore to use to create the SSLContext You also need to specify a keyStorePassword(char[]). Alternatively specify an initialized sslContext(SSLContext). Setting this property also implicitly enables SSL/TLS (see enable()

keyStoreType

public SslConfigurationBuilder keyStoreType(String keyStoreType)

Specifies the type of the keystore, such as JKS or JCEKS. Defaults to JKS. Setting this property also implicitly enables SSL/TLS (see enable()

keyStorePassword

public SslConfigurationBuilder keyStorePassword(char[] keyStorePassword)

Specifies the password needed to open the keystore You also need to specify a keyStoreFileName(String). Alternatively specify an initialized sslContext(SSLContext). Setting this property also implicitly enables SSL/TLS (see enable()

keyStoreCertificatePassword

@Deprecated(forRemoval=true)
public SslConfigurationBuilder keyStoreCertificatePassword(char[] keyStoreCertificatePassword)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3

Specifies the password needed to access private key associated with certificate stored in specified keyStoreFileName(String). If password is not specified, password provided in keyStorePassword(char[]) will be used. Setting this property also implicitly enables SSL/TLS (see enable()
Note: this only works with some keystore types

keyAlias

public SslConfigurationBuilder keyAlias(String keyAlias)

Sets the alias of the key to use, in case the keyStore contains multiple certificates. Setting this property also implicitly enables SSL/TLS (see enable()

sslContext

public SslConfigurationBuilder sslContext(SSLContext sslContext)

Specifies a pre-built SSLContext

trustStoreFileName

public SslConfigurationBuilder trustStoreFileName(String trustStoreFileName)

Specifies the filename of a truststore to use to create the SSLContext You also need to specify a trustStorePassword(char[]). Alternatively specify an initialized sslContext(SSLContext). Setting this property also implicitly enables SSL/TLS (see enable()

trustStorePath

@Deprecated(forRemoval=true)
public SslConfigurationBuilder trustStorePath(String trustStorePath)

Deprecated, for removal: This API element is subject to removal in a future version.

since 12.0 to be removed in 15.0. Use trustStoreFileName(String) and pass pem to trustStoreType(String).

Specifies a path containing certificates in PEM format. An in-memory KeyStore will be built with all the certificates found undert that path. This is mutually exclusive with trustStoreFileName Setting this property also implicitly enables SSL/TLS (see enable()

trustStoreType

public SslConfigurationBuilder trustStoreType(String trustStoreType)

Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS. Setting this property also implicitly enables SSL/TLS (see enable()

trustStorePassword

public SslConfigurationBuilder trustStorePassword(char[] trustStorePassword)

Specifies the password needed to open the truststore You also need to specify a trustStoreFileName(String). Alternatively specify an initialized sslContext(SSLContext). Setting this property also implicitly enables SSL/TLS (see enable()

sniHostName

public SslConfigurationBuilder sniHostName(String sniHostName)

Specifies the TLS SNI hostname for the connection

provider

public SslConfigurationBuilder provider(String provider)

Configures the SSL provider. Setting this property also implicitly enables SSL/TLS (see enable()

Parameters:

provider - The name of the provider to use when obtaining an SSLContext.

See Also:

• SSLContext.getInstance(String)

protocol

public SslConfigurationBuilder protocol(String protocol)

Configures the secure socket protocol. Setting this property also implicitly enables SSL/TLS (see enable()

Parameters:

protocol - The standard name of the requested protocol, e.g TLSv1.2

See Also:

• SSLContext.getInstance(String)

ciphers

public SslConfigurationBuilder ciphers(String... ciphers)

Configures the ciphers Setting this property also implicitly enables SSL/TLS (see enable()

Parameters:

ciphers - one or more cipher names

See Also:

• SSLContext.getInstance(String)

hostnameValidation

public SslConfigurationBuilder hostnameValidation(boolean hostnameValidation)

Configures whether to enable hostname validation according to RFC 2818. This is enabled by default and requires that the server certificate includes a subjectAltName extension of type dNSName or iPAddress.

Parameters:

hostnameValidation - whether to enable hostname validation

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<SslConfiguration>

create

public SslConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<SslConfiguration>

Returns:

read

public SslConfigurationBuilder read(SslConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<SslConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

withProperties

public ConfigurationBuilder withProperties(Properties properties)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified properties. See ConfigurationBuilder for a list.

Specified by:

withProperties in interface ConfigurationChildBuilder

Overrides:

withProperties in class AbstractConfigurationChildBuilder