SslConfigurationBuilder (Infinispan JavaDoc All 9.0.3.Final API)

java.lang.Object
- 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 Object
implements Builder<SslConfiguration>, ProtocolServerConfigurationChildBuilder<T,S>

SSLConfigurationBuilder.

Since:: 5.3
Author:: Tristan Tarrant, Sebastian Łaskawiec

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()` Builds a configuration object
`SslConfiguration`	`create()` Create the configuration bean
`S`	`defaultCacheName(String defaultCacheName)` Specifies the cache to use as a default cache for the protocol
`SslConfigurationBuilder`	`disable()` Disables the SSL support
`SslConfigurationBuilder`	`enable()` Enables the SSL support
`SslConfigurationBuilder`	`enabled(boolean enabled)` Enables or disables the SSL support
`S`	`host(String host)` Specifies the host or IP address on which this server will listen
`S`	`idleTimeout(int idleTimeout)` Specifies the maximum time that connections from client will be kept open without activity
`S`	`ignoredCaches(Set<String> ignoredCaches)` Sets the caches to be ignored
`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(String)`.
`SslConfigurationBuilder`	`keyStorePassword(char[] keyStorePassword)` Specifies the password needed to open the keystore You also need to specify a `keyStoreFileName(String)` Alternatively specify an array of `#keyManagers(KeyManager[])`
`S`	`name(String name)` Specifies a custom name for this server in order to easily distinguish it from other servers, e.g.
`S`	`port(int port)` Specifies the port on which this server will listen
`SslConfigurationBuilder`	`read(SslConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`S`	`recvBufSize(int recvBufSize)` Sets the size of the receive buffer
`SslConfigurationBuilder`	`requireClientAuth(boolean requireClientAuth)` Enables client certificate authentication
`S`	`self()`
`S`	`sendBufSize(int sendBufSize)` Sets the size of the send buffer
`SslEngineConfigurationBuilder`	`sniHostName(String domain)` Returns SNI domain configuration.
`SslConfigurationBuilder`	`ssl()` Configures SSL
`SslConfigurationBuilder`	`sslContext(SSLContext sslContext)` Sets the `SSLContext` to use for setting up SSL connections.
`S`	`startTransport(boolean startTransport)` Indicates whether transport implementation should or should not be started.
`S`	`tcpNoDelay(boolean tcpNoDelay)` Affects TCP NODELAY on the TCP stack.
`SslConfigurationBuilder`	`trustStoreFileName(String trustStoreFileName)` Specifies the filename of a truststore to use to create the `SSLContext` You also need to specify a `#trustStorePassword(String)`.
`SslConfigurationBuilder`	`trustStorePassword(char[] trustStorePassword)` Specifies the password needed to open the truststore You also need to specify a `trustStoreFileName(String)` Alternatively specify an array of `#trustManagers(TrustManager[])`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`S`	`workerThreads(int workerThreads)` Sets the number of worker threads

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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(String). Alternatively specify an array of #keyManagers(KeyManager[])
  - 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 array of #keyManagers(KeyManager[])
  - 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, password provided in #keyStorePassword(String) will be used.
  - 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(String). Alternatively specify an array of #trustManagers(TrustManager[])
  - 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 array of #trustManagers(TrustManager[])
  - 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.
  - defaultCacheName
```
public S defaultCacheName(String defaultCacheName)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies the cache to use as a default cache for the protocol
    
    Specified by:
    
    defaultCacheName in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - name
```
public S name(String name)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies a custom name for this server in order to easily distinguish it from other servers, e.g. via JMX. Defaults to the empty string.
    
    Specified by:
    
    name in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - host
```
public S host(String host)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies the host or IP address on which this server will listen
    
    Specified by:
    
    host in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - port
```
public S port(int port)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies the port on which this server will listen
    
    Specified by:
    
    port in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - idleTimeout
```
public S idleTimeout(int idleTimeout)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies the maximum time that connections from client will be kept open without activity
    
    Specified by:
    
    idleTimeout in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - tcpNoDelay
```
public S tcpNoDelay(boolean tcpNoDelay)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Affects TCP NODELAY on the TCP stack. Defaults to enabled
    
    Specified by:
    
    tcpNoDelay in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - recvBufSize
```
public S recvBufSize(int recvBufSize)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the size of the receive buffer
    
    Specified by:
    
    recvBufSize in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - sendBufSize
```
public S sendBufSize(int sendBufSize)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the size of the send buffer
    
    Specified by:
    
    sendBufSize in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - ssl
```
public SslConfigurationBuilder ssl()
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Configures SSL
    
    Specified by:
    
    ssl in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - workerThreads
```
public S workerThreads(int workerThreads)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the number of worker threads
    
    Specified by:
    
    workerThreads in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - ignoredCaches
```
public S ignoredCaches(Set<String> ignoredCaches)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the caches to be ignored
    
    Specified by:
    
    ignoredCaches in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - startTransport
```
public S startTransport(boolean startTransport)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Indicates whether transport implementation should or should not be started.
    
    Specified by:
    
    startTransport in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - build
```
public T build()
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Builds a configuration object
    
    Specified by:
    
    build in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - self
```
public S self()
```
    Specified by:
    
    self in interface Self<S extends ProtocolServerConfigurationChildBuilder<T,S>>

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

disable

enable

enabled

requireClientAuth

sniHostName

sslContext

keyStoreFileName

keyStorePassword

keyStoreCertificatePassword

trustStoreFileName

trustStorePassword

validate

create

read

defaultCacheName

name

host

port

idleTimeout

tcpNoDelay

recvBufSize

sendBufSize

ssl

workerThreads

ignoredCaches

startTransport

build

self