AuthenticationConfigurationBuilder (Infinispan JavaDoc All 9.3.9.Final 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.AuthenticationConfigurationBuilder

All Implemented Interfaces:

Builder<AuthenticationConfiguration>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationChildBuilder, RemoteStoreConfigurationChildBuilder
```
public class AuthenticationConfigurationBuilder
extends AbstractSecurityConfigurationChildBuilder
implements Builder<AuthenticationConfiguration>
```
AuthenticationConfigurationBuilder.

Since:

9.1

Author:

Tristan Tarrant

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

Constructor Summary

Constructors
Constructor and Description

AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)

Constructors
Constructor and Description
`AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Configuration`	`build()`
`AuthenticationConfigurationBuilder`	`callbackHandler(CallbackHandler callbackHandler)` Specifies a `CallbackHandler` to be used during the authentication handshake.
`AuthenticationConfigurationBuilder`	`clientSubject(Subject clientSubject)` Sets the client subject, necessary for those SASL mechanisms which require it to access client credentials (i.e.
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`AuthenticationConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`AuthenticationConfigurationBuilder`	`disable()` Disables authentication
`AuthenticationConfigurationBuilder`	`enable()` Enables authentication
`AuthenticationConfigurationBuilder`	`enabled(boolean enabled)` Configures whether authentication should be enabled or not
`EncodingConfigurationBuilder`	`encoding()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`AuthenticationConfigurationBuilder`	`password(char[] password)` Specifies the password to be used for authentication.
`AuthenticationConfigurationBuilder`	`password(String password)` Specifies the password to be used for authentication.
`PersistenceConfigurationBuilder`	`persistence()`
`Builder<?>`	`read(AuthenticationConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`AuthenticationConfigurationBuilder`	`realm(String realm)` Specifies the realm to be used for authentication.
`AuthenticationConfigurationBuilder`	`saslMechanism(String saslMechanism)` Selects the SASL mechanism to use for the connection to the server
`AuthenticationConfigurationBuilder`	`saslProperties(Map<String,String> saslProperties)` Sets the SASL properties
`SecurityConfigurationBuilder`	`security()`
`AuthenticationConfigurationBuilder`	`serverName(String serverName)` Sets the name of the server as expected by the SASL protocol
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()` Deprecated.
`ConfigurationChildBuilder`	`template(boolean template)`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`AuthenticationConfigurationBuilder`	`username(String username)` Specifies the username to be used for authentication.
`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
  - AuthenticationConfigurationBuilder
```
public AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)
```
- Method Detail
  - callbackHandler
```
public AuthenticationConfigurationBuilder callbackHandler(CallbackHandler callbackHandler)
```
    Specifies a CallbackHandler to be used during the authentication handshake. The Callbacks that need to be handled are specific to the chosen SASL mechanism.
  - enabled
```
public AuthenticationConfigurationBuilder enabled(boolean enabled)
```
    Configures whether authentication should be enabled or not
  - enable
```
public AuthenticationConfigurationBuilder enable()
```
    Enables authentication
  - disable
```
public AuthenticationConfigurationBuilder disable()
```
    Disables authentication
  - saslMechanism
```
public AuthenticationConfigurationBuilder saslMechanism(String saslMechanism)
```
    Selects the SASL mechanism to use for the connection to the server
  - saslProperties
```
public AuthenticationConfigurationBuilder saslProperties(Map<String,String> saslProperties)
```
    Sets the SASL properties
  - serverName
```
public AuthenticationConfigurationBuilder serverName(String serverName)
```
    Sets the name of the server as expected by the SASL protocol
  - clientSubject
```
public AuthenticationConfigurationBuilder clientSubject(Subject clientSubject)
```
    Sets the client subject, necessary for those SASL mechanisms which require it to access client credentials (i.e. GSSAPI)
  - username
```
public AuthenticationConfigurationBuilder username(String username)
```
    Specifies the username to be used for authentication. This will use a simple CallbackHandler. This is mutually exclusive with explicitly providing the CallbackHandler
  - password
```
public AuthenticationConfigurationBuilder password(String password)
```
    Specifies the password to be used for authentication. A username is also required
  - password
```
public AuthenticationConfigurationBuilder password(char[] password)
```
    Specifies the password to be used for authentication. A username is also required
  - realm
```
public AuthenticationConfigurationBuilder realm(String realm)
```
    Specifies the realm to be used for authentication. Username and password also need to be supplied.
  - create
```
public AuthenticationConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<AuthenticationConfiguration>
    
    Returns:
  - read
```
public Builder<?> read(AuthenticationConfiguration 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<AuthenticationConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - 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<AuthenticationConfiguration>
  - 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 AuthenticationConfigurationBuilder

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

AuthenticationConfigurationBuilder

Method Detail

callbackHandler

enabled

enable

disable

saslMechanism

saslProperties

serverName

clientSubject

username

password

password

realm

create

read

validate

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