SslConfigurationBuilder (Red Hat Data Grid 7.2.0 API)

java.lang.Object
- org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
- - org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder<S>
  - - org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder
    - - org.infinispan.persistence.remote.configuration.AbstractSecurityConfigurationChildBuilder
      - org.infinispan.persistence.remote.configuration.SslConfigurationBuilder

All Implemented Interfaces:

Builder<SslConfiguration>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationChildBuilder, RemoteStoreConfigurationChildBuilder
```
public class SslConfigurationBuilder
extends AbstractSecurityConfigurationChildBuilder
implements Builder<SslConfiguration>
```
SSLConfigurationBuilder.

Since:

9.1

Author:

Tristan Tarrant

Field Summary
- Fields inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder
  attributes

Constructor Summary

Constructors
Modifier Constructor and Description

protected SslConfigurationBuilder(SecurityConfigurationBuilder builder)

Constructors
Modifier	Constructor and Description
`protected`	`SslConfigurationBuilder(SecurityConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`SslConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`SslConfigurationBuilder`	`disable()` Disables the SSL support
`SslConfigurationBuilder`	`enable()` Enables the SSL support
`SslConfigurationBuilder`	`enabled(boolean enabled)` Enables or disables the SSL support
`EncodingConfigurationBuilder`	`encoding()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`SslConfigurationBuilder`	`keyAlias(String keyAlias)`
`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.
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`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.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`SslConfigurationBuilder`	`sniHostName(String sniHostName)` Specifies the TLS SNI hostname for the connection
`SslConfigurationBuilder`	`sslContext(SSLContext sslContext)`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()` Deprecated.
`ConfigurationChildBuilder`	`template(boolean template)`
`TransactionConfigurationBuilder`	`transaction()`
`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.
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`VersioningConfigurationBuilder`	`versioning()`

Methods inherited from class org.infinispan.persistence.remote.configuration.AbstractSecurityConfigurationChildBuilder
authentication, ssl

Methods inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder
addServer, asyncExecutorFactory, balancingStrategy, connectionPool, connectionTimeout, forceReturnValues, getRemoteStoreBuilder, hotRodWrapping, keySizeEstimate, marshaller, marshaller, protocolVersion, protocolVersion, rawValues, remoteCacheName, remoteSecurity, socketTimeout, tcpNoDelay, transportFactory, transportFactory, validate, valueSizeEstimate

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder
addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, shared, singleton, transactional, withProperties

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

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder
addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, shared, singleton, transactional, withProperties

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, encoding, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, versioning

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence

- Constructor Detail
  - SslConfigurationBuilder
```
protected SslConfigurationBuilder(SecurityConfigurationBuilder 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
  - 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)
  - 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 an initialized 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, password provided in keyStorePassword(char[]) will be used.
  - keyAlias
```
public SslConfigurationBuilder keyAlias(String keyAlias)
```
  - sslContext
```
public SslConfigurationBuilder sslContext(SSLContext 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)
  - 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 an initialized sslContext(SSLContext)
  - sniHostName
```
public SslConfigurationBuilder sniHostName(String sniHostName)
```
    Specifies the TLS SNI hostname for the connection
    
    See Also:
    
    SSLParameters.setServerNames(List)
  - 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.
  - template
```
public ConfigurationChildBuilder template(boolean template)
```
    Specified by:
    
    template in interface ConfigurationChildBuilder
  - simpleCache
```
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - simpleCache
```
public boolean simpleCache()
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - dataContainer
```
public DataContainerConfigurationBuilder dataContainer()
```
    Specified by:
    
    dataContainer in interface ConfigurationChildBuilder
  - deadlockDetection
```
public DeadlockDetectionConfigurationBuilder deadlockDetection()
```
    Specified by:
    
    deadlockDetection in interface ConfigurationChildBuilder
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding in interface ConfigurationChildBuilder
  - eviction
```
public EvictionConfigurationBuilder eviction()
```
    Specified by:
    
    eviction in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - jmxStatistics
```
public JMXStatisticsConfigurationBuilder jmxStatistics()
```
    Specified by:
    
    jmxStatistics in interface ConfigurationChildBuilder
  - persistence
```
public PersistenceConfigurationBuilder persistence()
```
    Specified by:
    
    persistence in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - security
```
public SecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface ConfigurationChildBuilder
  - storeAsBinary
```
@Deprecated
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Deprecated.
    
    Specified by:
    
    storeAsBinary in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - versioning
```
public VersioningConfigurationBuilder versioning()
```
    Specified by:
    
    versioning in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - memory
```
public MemoryConfigurationBuilder memory()
```
    Specified by:
    
    memory in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class SslConfigurationBuilder

Field Summary

Fields inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder

Constructor Summary

Method Summary

Methods inherited from class org.infinispan.persistence.remote.configuration.AbstractSecurityConfigurationChildBuilder

Methods inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder

Constructor Detail

SslConfigurationBuilder

Method Detail

disable

enable

enabled

keyStoreFileName

keyStoreType

keyStorePassword

keyStoreCertificatePassword

keyAlias

sslContext

trustStoreFileName

trustStoreType

trustStorePassword

sniHostName

protocol

validate

create

read

template

simpleCache

simpleCache

clustering

customInterceptors

dataContainer

deadlockDetection

encoding

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

memory

getBuilder

build