org.jasig.cas.authentication

Class SuccessfulHandlerMetaDataPopulator

java.lang.Object

org.jasig.cas.authentication.SuccessfulHandlerMetaDataPopulator

All Implemented Interfaces:

AuthenticationMetaDataPopulator

public class SuccessfulHandlerMetaDataPopulator
extends Object
implements AuthenticationMetaDataPopulator

Sets an authentication attribute containing the collection of authentication handlers (by name) that successfully authenticated credential. The attribute name is given by SUCCESSFUL_AUTHENTICATION_HANDLERS. This component provides a simple method to inject successful handlers into the CAS ticket validation response to support level of assurance and MFA use cases.

Since:

4.0

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUCCESSFUL_AUTHENTICATION_HANDLERS Attribute name containing collection of handler names that successfully authenticated credential.

Constructor Summary

Constructors

Constructor and Description
SuccessfulHandlerMetaDataPopulator()

Method Summary

Methods

Modifier and Type	Method and Description
void	populateAttributes(AuthenticationBuilder builder, Credential credential) Adds authentication metadata attributes on successful authentication of the given credential.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESSFUL_AUTHENTICATION_HANDLERS

public static final String SUCCESSFUL_AUTHENTICATION_HANDLERS

Attribute name containing collection of handler names that successfully authenticated credential.

See Also:

Constant Field Values

Constructor Detail

SuccessfulHandlerMetaDataPopulator

public SuccessfulHandlerMetaDataPopulator()

Method Detail

populateAttributes

public void populateAttributes(AuthenticationBuilder builder,
                      Credential credential)

Description copied from interface: AuthenticationMetaDataPopulator

Adds authentication metadata attributes on successful authentication of the given credential.

Specified by:

populateAttributes in interface AuthenticationMetaDataPopulator

Parameters:

builder - Builder object that temporarily holds authentication metadata.

credential - Successfully authenticated credential.