org.jasig.cas.authentication

Class ImmutableAuthentication

java.lang.Object

org.jasig.cas.authentication.ImmutableAuthentication

All Implemented Interfaces:

Serializable, Authentication

public final class ImmutableAuthentication
extends Object
implements Authentication, Serializable

Immutable authentication event whose attributes may not change after creation. This class is designed for serialization and is suitable for long-term storage.

Since:

3.0

Author:

Dmitriy Kopylenko, Scott Battaglia, Marvin S. Addison

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableAuthentication(Date date, List<CredentialMetaData> credentials, Principal principal, Map<String,Object> attributes, Map<String,HandlerResult> successes, Map<String,Class<? extends Exception>> failures) Creates a new instance with the given data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,Object>	getAttributes() Attributes of the authentication (not the Principal).
Date	getAuthenticatedDate() Method to retrieve the timestamp of when this Authentication object was created.
List<CredentialMetaData>	getCredentials() Gets a list of metadata about the credentials supplied at authentication time.
Map<String,Class<? extends Exception>>	getFailures() Gets a map describing failed authentications.
Principal	getPrincipal() Method to obtain the Principal.
Map<String,HandlerResult>	getSuccesses() Gets a map describing successful authentications produced by AuthenticationHandler components.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableAuthentication

public ImmutableAuthentication(Date date,
                       List<CredentialMetaData> credentials,
                       Principal principal,
                       Map<String,Object> attributes,
                       Map<String,HandlerResult> successes,
                       Map<String,Class<? extends Exception>> failures)

Creates a new instance with the given data.

Parameters:

date - Non-null authentication date.

credentials - Non-null list of credential metadata containing at least one entry.

principal - Non-null authenticated principal.

attributes - Nullable map of authentication metadata.

successes - Non-null map of authentication successes containing at least one entry.

failures - Nullable map of authentication failures.

Method Detail

getPrincipal

public Principal getPrincipal()

Description copied from interface: Authentication

Method to obtain the Principal.

Specified by:

getPrincipal in interface Authentication

Returns:

a Principal implementation

getAuthenticatedDate

public Date getAuthenticatedDate()

Description copied from interface: Authentication

Method to retrieve the timestamp of when this Authentication object was created.

Specified by:

getAuthenticatedDate in interface Authentication

Returns:

the date/time the authentication occurred.

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: Authentication

Attributes of the authentication (not the Principal).

Specified by:

getAttributes in interface Authentication

Returns:

the map of attributes.

getCredentials

public List<CredentialMetaData> getCredentials()

Description copied from interface: Authentication

Gets a list of metadata about the credentials supplied at authentication time.

Specified by:

getCredentials in interface Authentication

Returns:

Non-null list of supplied credentials represented as metadata that should be considered safe for long-term storage (e.g. serializable and secure with respect to credential disclosure). The order of items in the returned list SHOULD be the same as the order in which the source credentials were presented and subsequently processed.

getSuccesses

public Map<String,HandlerResult> getSuccesses()

Description copied from interface: Authentication

Gets a map describing successful authentications produced by AuthenticationHandler components.

Specified by:

getSuccesses in interface Authentication

Returns:

Map of handler names to successful authentication result produced by that handler.

getFailures

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

Description copied from interface: Authentication

Gets a map describing failed authentications. By definition the failures here were not sufficient to prevent authentication.

Specified by:

getFailures in interface Authentication

Returns:

Map of authentication handler names to the authentication errors produced on attempted authentication.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object