org.jasig.cas.authentication

Class AuthenticationBuilder

java.lang.Object

org.jasig.cas.authentication.AuthenticationBuilder

public class AuthenticationBuilder
extends Object

Constructs immutable Authentication objects using the builder pattern.

Since:

4.0

Author:

Marvin S. Addison

Constructor Summary

Constructors

Constructor and Description
AuthenticationBuilder() Creates a new instance using the current date for the authentication date.
AuthenticationBuilder(Principal p) Creates a new instance using the current date for the authentication date and the given principal for the authenticated principal.

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationBuilder	addAttribute(String key, Object value) Adds an authentication metadata attribute key-value pair.
AuthenticationBuilder	addCredential(CredentialMetaData credential) Adds metadata about a credential presented for authentication.
AuthenticationBuilder	addFailure(String key, Class<? extends Exception> value) Adds an authentication failure to the map of handler names to the authentication handler failures.
AuthenticationBuilder	addSuccess(String key, HandlerResult value) Adds an authentication success to the map of handler names to successful authentication handler results.
Authentication	build() Creates an immutable authentication instance from builder data.
Map<String,Object>	getAttributes() Gets the authentication attribute map.
Date	getAuthenticationDate() Gets the authentication date.
List<CredentialMetaData>	getCredentials() Gets the list of credentials that were attempted to be authenticated.
Map<String,Class<? extends Exception>>	getFailures() Gets the authentication failure map.
Principal	getPrincipal() Gets the authenticated principal.
Map<String,HandlerResult>	getSuccesses() Gets the authentication success map.
static AuthenticationBuilder	newInstance(Authentication source) Creates a new builder initialized with data from the given authentication source.
AuthenticationBuilder	setAttributes(Map<String,Object> attributes) Sets the authentication metadata attributes.
AuthenticationBuilder	setAuthenticationDate(Date d) Sets the authentication date and returns this instance.
AuthenticationBuilder	setCredentials(List<CredentialMetaData> credentials) Sets the list of metadata about credentials presented for authentication.
AuthenticationBuilder	setFailures(Map<String,Class<? extends Exception>> failures) Sets the authentication handler failure map.
AuthenticationBuilder	setPrincipal(Principal p) Sets the principal returns this instance.
AuthenticationBuilder	setSuccesses(Map<String,HandlerResult> successes) Sets the authentication handler success map.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationBuilder

public AuthenticationBuilder()

Creates a new instance using the current date for the authentication date.

AuthenticationBuilder

public AuthenticationBuilder(Principal p)

Creates a new instance using the current date for the authentication date and the given principal for the authenticated principal.

Parameters:

p - Authenticated principal.

Method Detail

getAuthenticationDate

public Date getAuthenticationDate()

Gets the authentication date.

Returns:

Authentication date.

setAuthenticationDate

public AuthenticationBuilder setAuthenticationDate(Date d)

Sets the authentication date and returns this instance.

Parameters:

d - Authentication date.

Returns:

This builder instance.

getPrincipal

public Principal getPrincipal()

Gets the authenticated principal.

Returns:

Principal.

setPrincipal

public AuthenticationBuilder setPrincipal(Principal p)

Sets the principal returns this instance.

Parameters:

p - Authenticated principal.

Returns:

This builder instance.

getCredentials

public List<CredentialMetaData> getCredentials()

Gets the list of credentials that were attempted to be authenticated.

Returns:

Non-null list of credentials that attempted authentication.

setCredentials

public AuthenticationBuilder setCredentials(List<CredentialMetaData> credentials)

Sets the list of metadata about credentials presented for authentication.

Parameters:

credentials - Non-null list of credential metadata.

Returns:

This builder instance.

addCredential

public AuthenticationBuilder addCredential(CredentialMetaData credential)

Adds metadata about a credential presented for authentication.

Parameters:

credential - Credential metadata.

Returns:

This builder instance.

getAttributes

public Map<String,Object> getAttributes()

Gets the authentication attribute map.

Returns:

Non-null authentication attribute map.

setAttributes

public AuthenticationBuilder setAttributes(Map<String,Object> attributes)

Sets the authentication metadata attributes.

Parameters:

attributes - Non-null map of authentication metadata attributes.

Returns:

This builder instance.

addAttribute

public AuthenticationBuilder addAttribute(String key,
                                 Object value)

Adds an authentication metadata attribute key-value pair.

Parameters:

key - Authentication attribute key.

value - Authentication attribute value.

Returns:

This builder instance.

getSuccesses

public Map<String,HandlerResult> getSuccesses()

Gets the authentication success map.

Returns:

Non-null map of handler names to successful handler authentication results.

setSuccesses

public AuthenticationBuilder setSuccesses(Map<String,HandlerResult> successes)

Sets the authentication handler success map.

Parameters:

successes - Non-null map of handler names to successful handler authentication results.

Returns:

This builder instance.

addSuccess

public AuthenticationBuilder addSuccess(String key,
                               HandlerResult value)

Adds an authentication success to the map of handler names to successful authentication handler results.

Parameters:

key - Authentication handler name.

value - Successful authentication handler result produced by handler of given name.

Returns:

This builder instance.

getFailures

public Map<String,Class<? extends Exception>> getFailures()

Gets the authentication failure map.

Returns:

Non-null authentication failure map.

setFailures

public AuthenticationBuilder setFailures(Map<String,Class<? extends Exception>> failures)

Sets the authentication handler failure map.

Parameters:

failures - Non-null map of handler name to authentication failures.

Returns:

This builder instance.

addFailure

public AuthenticationBuilder addFailure(String key,
                               Class<? extends Exception> value)

Adds an authentication failure to the map of handler names to the authentication handler failures.

Parameters:

key - Authentication handler name.

value - Exception raised on handler failure to authenticate credential.

Returns:

This builder instance.

build

public Authentication build()

Creates an immutable authentication instance from builder data.

Returns:

Immutable authentication.

newInstance

public static AuthenticationBuilder newInstance(Authentication source)

Creates a new builder initialized with data from the given authentication source.

Parameters:

source - Authentication source.

Returns:

New builder instance initialized with all fields in the given authentication source.