Class AuthenticationConfigurationBuilder
- 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:
BaseConfigurationInfo
,Builder<AuthenticationConfiguration>
,ConfigurationBuilderInfo
,ConfigurationChildBuilder
,PersistenceConfigurationChildBuilder
,StoreConfigurationChildBuilder
,RemoteStoreConfigurationChildBuilder
public class AuthenticationConfigurationBuilder extends AbstractSecurityConfigurationChildBuilder implements Builder<AuthenticationConfiguration>, ConfigurationBuilderInfo
AuthenticationConfigurationBuilder.- Since:
- 9.1
- Author:
- Tristan Tarrant
-
-
Field Summary
-
Fields inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder
attributes
-
-
Constructor Summary
Constructors Constructor Description AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)
-
Method Summary
-
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, 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, segmented, shared, transactional, withProperties
-
Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo
getNewBuilderInfo
-
Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe
-
Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence
-
Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder
addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, withProperties
-
-
-
-
Constructor Detail
-
AuthenticationConfigurationBuilder
public AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)
-
-
Method Detail
-
attributes
public org.infinispan.commons.configuration.attributes.AttributeSet attributes()
- Specified by:
attributes
in interfaceBaseConfigurationInfo
- Returns:
- the
AttributeSet
declared by the configuration.
-
getElementDefinition
public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()
- Specified by:
getElementDefinition
in interfaceBaseConfigurationInfo
- Returns:
- the
ElementDefinition
of the configuration.
-
getChildrenInfo
public Collection<ConfigurationBuilderInfo> getChildrenInfo()
- Specified by:
getChildrenInfo
in interfaceConfigurationBuilderInfo
- Returns:
- a collection of
ConfigurationBuilderInfo
for the sub-elements of the builder.
-
getBuilderInfo
public ConfigurationBuilderInfo getBuilderInfo(String name, String qualifier)
- Specified by:
getBuilderInfo
in interfaceConfigurationBuilderInfo
- Returns:
- the
ConfigurationBuilderInfo
associated with a certain serialized element name.
-
callbackHandler
public AuthenticationConfigurationBuilder callbackHandler(CallbackHandler callbackHandler)
Specifies aCallbackHandler
to be used during the authentication handshake. TheCallback
s 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 interfaceBuilder<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 interfaceBuilder<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 interfaceBuilder<AuthenticationConfiguration>
-
template
public ConfigurationChildBuilder template(boolean template)
- Specified by:
template
in interfaceConfigurationChildBuilder
-
simpleCache
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
- Specified by:
simpleCache
in interfaceConfigurationChildBuilder
-
simpleCache
public boolean simpleCache()
- Specified by:
simpleCache
in interfaceConfigurationChildBuilder
-
clustering
public ClusteringConfigurationBuilder clustering()
- Specified by:
clustering
in interfaceConfigurationChildBuilder
-
customInterceptors
@Deprecated public CustomInterceptorsConfigurationBuilder customInterceptors()
Deprecated.Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors- Specified by:
customInterceptors
in interfaceConfigurationChildBuilder
-
encoding
public EncodingConfigurationBuilder encoding()
- Specified by:
encoding
in interfaceConfigurationChildBuilder
-
expiration
public ExpirationConfigurationBuilder expiration()
- Specified by:
expiration
in interfaceConfigurationChildBuilder
-
indexing
public IndexingConfigurationBuilder indexing()
- Specified by:
indexing
in interfaceConfigurationChildBuilder
-
invocationBatching
public InvocationBatchingConfigurationBuilder invocationBatching()
- Specified by:
invocationBatching
in interfaceConfigurationChildBuilder
-
statistics
public StatisticsConfigurationBuilder statistics()
- Specified by:
statistics
in interfaceConfigurationChildBuilder
-
persistence
public PersistenceConfigurationBuilder persistence()
- Specified by:
persistence
in interfaceConfigurationChildBuilder
-
locking
public LockingConfigurationBuilder locking()
- Specified by:
locking
in interfaceConfigurationChildBuilder
-
security
public SecurityConfigurationBuilder security()
- Specified by:
security
in interfaceConfigurationChildBuilder
-
transaction
public TransactionConfigurationBuilder transaction()
- Specified by:
transaction
in interfaceConfigurationChildBuilder
-
unsafe
public UnsafeConfigurationBuilder unsafe()
- Specified by:
unsafe
in interfaceConfigurationChildBuilder
-
sites
public SitesConfigurationBuilder sites()
- Specified by:
sites
in interfaceConfigurationChildBuilder
-
memory
public MemoryConfigurationBuilder memory()
- Specified by:
memory
in interfaceConfigurationChildBuilder
-
getBuilder
protected ConfigurationBuilder getBuilder()
-
build
public Configuration build()
- Specified by:
build
in interfaceConfigurationChildBuilder
-
-