Package org.infinispan.client.rest.configuration

Class AuthenticationConfigurationBuilder

java.lang.Object

org.infinispan.client.rest.configuration.AbstractConfigurationChildBuilder

org.infinispan.client.rest.configuration.AbstractSecurityConfigurationChildBuilder

org.infinispan.client.rest.configuration.AuthenticationConfigurationBuilder

All Implemented Interfaces:

RestClientConfigurationChildBuilder, org.infinispan.commons.configuration.Builder<AuthenticationConfiguration>

public class AuthenticationConfigurationBuilder
extends AbstractSecurityConfigurationChildBuilder
implements org.infinispan.commons.configuration.Builder<AuthenticationConfiguration>

AuthenticationConfigurationBuilder.

Since:

10.0

Author:

Tristan Tarrant

Constructor Summary

Constructors

Constructor	Description
AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
AuthenticationConfigurationBuilder	clientSubject(Subject clientSubject)	Sets the client subject, necessary for those mechanisms which require it to access client credentials (i.e.
AuthenticationConfiguration	create()
AuthenticationConfigurationBuilder	disable()	Disables authentication
AuthenticationConfigurationBuilder	enable()	Enables authentication
AuthenticationConfigurationBuilder	enabled(boolean enabled)	Configures whether authentication should be enabled or not
AuthenticationConfigurationBuilder	mechanism(String mechanism)	Selects the authentication mechanism to use for the connection to the server.
AuthenticationConfigurationBuilder	password(char[] password)	Specifies the password to be used for authentication.
AuthenticationConfigurationBuilder	password(String password)	Specifies the password to be used for authentication.
org.infinispan.commons.configuration.Builder<?>	read(AuthenticationConfiguration template)
AuthenticationConfigurationBuilder	realm(String realm)	Specifies the realm to be used for authentication.
AuthenticationConfigurationBuilder	username(String username)	Specifies the username to be used for authentication.
RestClientConfigurationBuilder	withProperties(Properties properties)	Configures this builder using the specified properties.

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

authentication, ssl

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

addServer, addServers, build, connectionTimeout, followRedirects, priorKnowledge, protocol, security, socketTimeout, tcpKeepAlive, tcpNoDelay

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.Builder

validate

Constructor Details

AuthenticationConfigurationBuilder

public AuthenticationConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Details

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface org.infinispan.commons.configuration.Builder<AuthenticationConfiguration>

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

mechanism

public AuthenticationConfigurationBuilder mechanism(String mechanism)

Selects the authentication mechanism to use for the connection to the server. Setting this property also implicitly enables authentication (see enable()

clientSubject

public AuthenticationConfigurationBuilder clientSubject(Subject clientSubject)

Sets the client subject, necessary for those mechanisms which require it to access client credentials (i.e. SPNEGO). Setting this property also implicitly enables authentication (see enable()

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. Setting this property also implicitly enables authentication (see enable()

password

public AuthenticationConfigurationBuilder password(String password)

Specifies the password to be used for authentication. A username is also required. Setting this property also implicitly enables authentication (see enable()

password

public AuthenticationConfigurationBuilder password(char[] password)

Specifies the password to be used for authentication. A username is also required. Setting this property also implicitly enables authentication (see enable()

realm

public AuthenticationConfigurationBuilder realm(String realm)

Specifies the realm to be used for authentication. Username and password also need to be supplied. If none is specified, this defaults to 'ApplicationRealm'. Setting this property also implicitly enables authentication (see enable()

create

public AuthenticationConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<AuthenticationConfiguration>

read

public org.infinispan.commons.configuration.Builder<?> read(AuthenticationConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<AuthenticationConfiguration>

withProperties

public RestClientConfigurationBuilder withProperties(Properties properties)

Description copied from interface: RestClientConfigurationChildBuilder

Configures this builder using the specified properties. See RestClientConfigurationBuilder for a list.

Specified by:

withProperties in interface RestClientConfigurationChildBuilder

Overrides:

withProperties in class AbstractConfigurationChildBuilder