org.apereo.cas.authentication.metadata

Class CacheCredentialsMetaDataPopulator

java.lang.Object

org.apereo.cas.authentication.metadata.BaseAuthenticationMetaDataPopulator

org.apereo.cas.authentication.metadata.CacheCredentialsMetaDataPopulator

All Implemented Interfaces:

AuthenticationMetaDataPopulator, org.springframework.core.Ordered

public class CacheCredentialsMetaDataPopulator
extends BaseAuthenticationMetaDataPopulator

We utilize the AuthenticationMetaDataPopulator to retrieve and store the password as an authentication attribute under the key UsernamePasswordCredential.AUTHENTICATION_ATTRIBUTE_PASSWORD.

Since:

4.1

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CacheCredentialsMetaDataPopulator()

Method Summary

Modifier and Type	Method and Description
void	populateAttributes(AuthenticationBuilder builder, AuthenticationTransaction transaction) Adds authentication metadata attributes on successful authentication of the given credential.
boolean	supports(Credential credential) Determines whether the populator has the capability to perform tasks on the given credential.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.authentication.AuthenticationMetaDataPopulator

getOrder

Constructor Detail

CacheCredentialsMetaDataPopulator

public CacheCredentialsMetaDataPopulator()

Method Detail

populateAttributes

public void populateAttributes(AuthenticationBuilder builder,
                               AuthenticationTransaction transaction)

Description copied from interface: AuthenticationMetaDataPopulator

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

Parameters:

builder - Builder object that temporarily holds authentication metadata.

transaction - The authentication transaction.

supports

public boolean supports(Credential credential)

Description copied from interface: AuthenticationMetaDataPopulator

Determines whether the populator has the capability to perform tasks on the given credential. In practice, the AuthenticationMetaDataPopulator.populateAttributes(AuthenticationBuilder, AuthenticationTransaction) needs to be able to operate on said credentials only if the return result here is true.

Parameters:

credential - The credential to check.

Returns:

True if populator supports the Credential, false otherwise.