org.jasig.cas.authentication
Interface AuthenticationMetaDataPopulator

All Known Implementing Classes:

RememberMeAuthenticationMetaDataPopulator, SamlAuthenticationMetaDataPopulator

public interface AuthenticationMetaDataPopulator

An extension point to the Authentication process that allows CAS to provide additional attributes related to the overall Authentication (such as authentication type) that are specific to the Authentication request versus the Principal itself. AuthenticationAttributePopulators are a new feature in CAS3. In order for an installation to be CAS2 compliant, deployers do not need an AuthenticationMetaDataPopulator.

Since:

3.0

This is a published and supported CAS Server 3 API.

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Method Summary

Authentication

populateAttributes(Authentication authentication, Credentials credentials) Provided with an Authentication object and the original credentials presented, provide any additional attributes to the Authentication object.

Method Detail

populateAttributes

Authentication populateAttributes(Authentication authentication,
                                  Credentials credentials)

Provided with an Authentication object and the original credentials presented, provide any additional attributes to the Authentication object. Implementations have the option of returning the same Authentication object, or a new one.

Parameters:

authentication - The Authentication to potentially augment with additional attributes.

Returns:

the original Authentication object or a new Authentication object.