Package org.infinispan.persistence.remote.configuration

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

Modifier and Type	Method	Description
AttributeSet	attributes()
Configuration	build()
AuthenticationConfigurationBuilder	callbackHandler(javax.security.auth.callback.CallbackHandler callbackHandler)	Specifies a CallbackHandler to be used during the authentication handshake.
AuthenticationConfigurationBuilder	clientSubject(javax.security.auth.Subject clientSubject)	Sets the client subject, necessary for those SASL mechanisms which require it to access client credentials (i.e.
ClusteringConfigurationBuilder	clustering()
AuthenticationConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
AuthenticationConfigurationBuilder	disable()	Disables authentication
AuthenticationConfigurationBuilder	enable()	Enables authentication
AuthenticationConfigurationBuilder	enabled(boolean enabled)	Configures whether authentication should be enabled or not
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
ConfigurationBuilderInfo	getBuilderInfo(java.lang.String name, java.lang.String qualifier)
java.util.Collection<ConfigurationBuilderInfo>	getChildrenInfo()
ElementDefinition	getElementDefinition()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
AuthenticationConfigurationBuilder	password(char[] password)	Specifies the password to be used for authentication.
AuthenticationConfigurationBuilder	password(java.lang.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(java.lang.String realm)	Specifies the realm to be used for authentication.
AuthenticationConfigurationBuilder	saslMechanism(java.lang.String saslMechanism)	Selects the SASL mechanism to use for the connection to the server
AuthenticationConfigurationBuilder	saslProperties(java.util.Map<java.lang.String,java.lang.String> saslProperties)	Sets the SASL properties
SecurityConfigurationBuilder	security()
AuthenticationConfigurationBuilder	serverName(java.lang.String serverName)	Sets the name of the server as expected by the SASL protocol
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
ConfigurationChildBuilder	template(boolean template)
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
AuthenticationConfigurationBuilder	username(java.lang.String username)	Specifies the username to be used for authentication.
void	validate()	Validate the data in this builder before building the configuration bean

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 class java.lang.Object

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

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, 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 AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

getElementDefinition

public ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

getChildrenInfo

public java.util.Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

getBuilderInfo

public ConfigurationBuilderInfo getBuilderInfo(java.lang.String name,
                                               java.lang.String qualifier)

Specified by:

getBuilderInfo in interface ConfigurationBuilderInfo

Returns:

the ConfigurationBuilderInfo associated with a certain serialized element name.

callbackHandler

public AuthenticationConfigurationBuilder callbackHandler(javax.security.auth.callback.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(java.lang.String saslMechanism)

Selects the SASL mechanism to use for the connection to the server

saslProperties

public AuthenticationConfigurationBuilder saslProperties(java.util.Map<java.lang.String,java.lang.String> saslProperties)

Sets the SASL properties

serverName

public AuthenticationConfigurationBuilder serverName(java.lang.String serverName)

Sets the name of the server as expected by the SASL protocol

clientSubject

public AuthenticationConfigurationBuilder clientSubject(javax.security.auth.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(java.lang.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(java.lang.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(java.lang.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

@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 interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites 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