org.infinispan.server.core.configuration

Class SslConfigurationBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>

java.lang.Object

org.infinispan.server.core.configuration.AbstractProtocolServerConfigurationChildBuilder<T,S>

org.infinispan.server.core.configuration.SslConfigurationBuilder<T,S>

All Implemented Interfaces:

Builder<SslConfiguration>, Self<S>, ProtocolServerConfigurationChildBuilder<T,S>

public class SslConfigurationBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
extends AbstractProtocolServerConfigurationChildBuilder<T,S>
implements Builder<SslConfiguration>

SSLConfigurationBuilder.

Since:

5.3

Author:

Tristan Tarrant, Sebastian Łaskawiec

Field Summary

Fields inherited from class org.infinispan.server.core.configuration.AbstractProtocolServerConfigurationChildBuilder

builder

Constructor Summary

Constructors

Constructor and Description
SslConfigurationBuilder(ProtocolServerConfigurationChildBuilder<T,S> builder)

Method Summary

Modifier and Type	Method and Description
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	keyAlias(String keyAlias) Selects a specific key to choose from the keystore
SslConfigurationBuilder	keyStoreCertificatePassword(char[] keyStoreCertificatePassword) Specifies the password needed to access private key associated with certificate stored in specified keyStoreFileName(String).
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	read(SslConfiguration template) Reads the configuration from an already created configuration bean into this builder.
SslConfigurationBuilder	requireClientAuth(boolean requireClientAuth) Enables client certificate authentication
S	self()
SslEngineConfigurationBuilder	sniHostName(String domain) Returns SNI domain configuration.
SslConfigurationBuilder	sslContext(SSLContext sslContext) Sets the SSLContext to use for setting up SSL connections.
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	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

Methods inherited from class org.infinispan.server.core.configuration.AbstractProtocolServerConfigurationChildBuilder

adminOperationsHandler, build, defaultCacheName, host, idleTimeout, ignoredCaches, ioThreads, name, port, recvBufSize, sendBufSize, ssl, startTransport, tcpKeepAlive, tcpNoDelay, workerThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

SslConfigurationBuilder

public SslConfigurationBuilder(ProtocolServerConfigurationChildBuilder<T,S> builder)

Method Detail

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

requireClientAuth

public SslConfigurationBuilder requireClientAuth(boolean requireClientAuth)

Enables client certificate authentication

sniHostName

public SslEngineConfigurationBuilder sniHostName(String domain)

Returns SNI domain configuration.

Parameters:

domain - A domain which will hold configuration details. It is also possible to specify * for all domains.

Returns:

SslConfigurationBuilder instance associated with specified domain.

sslContext

public SslConfigurationBuilder sslContext(SSLContext sslContext)

Sets the SSLContext to use for setting up SSL connections.

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 prebuilt SSLContext through sslContext(SSLContext).

keyStoreType

public SslConfigurationBuilder keyStoreType(String keyStoreType)

Specifies the type of the keystore, such as JKS or JCEKS. Defaults to JKS

keyStorePassword

public SslConfigurationBuilder keyStorePassword(char[] keyStorePassword)

Specifies the password needed to open the keystore You also need to specify a keyStoreFileName(String). Alternatively specify prebuilt SSLContext through sslContext(SSLContext).

keyStoreCertificatePassword

public SslConfigurationBuilder keyStoreCertificatePassword(char[] keyStoreCertificatePassword)

Specifies the password needed to access private key associated with certificate stored in specified keyStoreFileName(String). If password is not specified, the password provided in keyStorePassword(char[]) will be used.

keyAlias

public SslConfigurationBuilder keyAlias(String keyAlias)

Selects a specific key to choose from the keystore

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 prebuilt SSLContext through sslContext(SSLContext).

trustStoreType

public SslConfigurationBuilder trustStoreType(String trustStoreType)

Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS

trustStorePassword

public SslConfigurationBuilder trustStorePassword(char[] trustStorePassword)

Specifies the password needed to open the truststore You also need to specify a trustStoreFileName(String). Alternatively specify prebuilt SSLContext through sslContext(SSLContext).

protocol

public SslConfigurationBuilder protocol(String protocol)

Configures the secure socket protocol.

Parameters:

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

See Also:

SSLContext.getInstance(String)

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)

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.

self

public S self()

Specified by:

self in interface Self<S extends ProtocolServerConfigurationChildBuilder<T,S>>