org.infinispan.client.hotrod.configuration

Class AuthenticationConfigurationBuilder

java.lang.Object

org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

org.infinispan.client.hotrod.configuration.AbstractSecurityConfigurationChildBuilder

org.infinispan.client.hotrod.configuration.AuthenticationConfigurationBuilder

All Implemented Interfaces:

ConfigurationChildBuilder, Builder<AuthenticationConfiguration>

public class AuthenticationConfigurationBuilder
extends AbstractSecurityConfigurationChildBuilder
implements Builder<AuthenticationConfiguration>

AuthenticationConfigurationBuilder.

Since:

7.0

Author:

Tristan Tarrant

Constructor Summary

Constructors

Constructor and Description
AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
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.
AuthenticationConfiguration	create() Create the configuration bean
AuthenticationConfigurationBuilder	disable() Disables authentication
AuthenticationConfigurationBuilder	enable() Enables authentication
AuthenticationConfigurationBuilder	enabled(boolean enabled) Configures whether authentication should be enabled or not
AuthenticationConfigurationBuilder	password(char[] password) Specifies the password to be used for authentication.
AuthenticationConfigurationBuilder	password(String password) Specifies the password to be used for authentication.
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
AuthenticationConfigurationBuilder	saslQop(SaslQop... qop) Sets the SASL QOP property.
AuthenticationConfigurationBuilder	saslStrength(SaslStrength... strength) Sets the SASL strength property.
AuthenticationConfigurationBuilder	serverName(String serverName) Sets the name of the server as expected by the SASL protocol
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
ConfigurationBuilder	withProperties(Properties properties) Configures this builder using the specified properties

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractSecurityConfigurationChildBuilder

authentication, ssl

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

addCluster, addJavaSerialWhiteList, addServer, addServers, asyncExecutorFactory, balancingStrategy, balancingStrategy, balancingStrategy, batchSize, build, classLoader, clientIntelligence, connectionPool, connectionTimeout, consistentHashImpl, consistentHashImpl, forceReturnValues, keySizeEstimate, marshaller, marshaller, marshaller, maxRetries, protocolVersion, security, socketTimeout, tcpKeepAlive, tcpNoDelay, transportFactory, transportFactory, valueSizeEstimate, version

Methods inherited from class java.lang.Object

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

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

saslQop

public AuthenticationConfigurationBuilder saslQop(SaslQop... qop)

Sets the SASL QOP property. If multiple values are specified they will determine preference order

saslStrength

public AuthenticationConfigurationBuilder saslStrength(SaslStrength... strength)

Sets the SASL strength property. If multiple values are specified they will determine preference order

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>

withProperties

public ConfigurationBuilder withProperties(Properties properties)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified properties

Specified by:

withProperties in interface ConfigurationChildBuilder

Overrides:

withProperties in class AbstractConfigurationChildBuilder