org.jasig.cas.authentication
Interface Authentication

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractAuthentication, ImmutableAuthentication, MutableAuthentication

public interface Authentication
extends java.io.Serializable

The Authentication object represents a successful authentication request. It contains the principal that the authentication request was made for as well as the additional meta information such as the authenticated date and a map of attributes.

An Authentication object must be serializable to permit persistance and clustering.

Implementing classes must take care to ensure that the Map returned by getAttributes is serializable by using a Serializable map such as HashMap.

Since:

3.0

This is a published and supported CAS Server 3 API.

Version:

$Revision: 42053 $ $Date: 2007-06-10 09:17:55 -0400 (Sun, 10 Jun 2007) $

Author:

Dmitriy Kopylenko, Scott Battaglia

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Attributes of the authentication (not the Principal).
java.util.Date	getAuthenticatedDate() Method to retrieve the timestamp of when this Authentication object was created.
Principal	getPrincipal() Method to obtain the Principal.

Method Detail

getPrincipal

Principal getPrincipal()

Method to obtain the Principal.

Returns:

a Principal implementation

getAuthenticatedDate

java.util.Date getAuthenticatedDate()

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

Returns:

the date/time the authentication occurred.

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Attributes of the authentication (not the Principal).

Returns:

the map of attributes.