Package org.apereo.cas.authentication

Interface AuthenticationMetaDataPopulator

All Superinterfaces:

org.springframework.core.Ordered

public interface AuthenticationMetaDataPopulator
extends org.springframework.core.Ordered

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.

Since:

3.0.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default int	getOrder()
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.

Method Detail

populateAttributes

void populateAttributes(AuthenticationBuilder builder,
                        AuthenticationTransaction transaction)

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

boolean supports(Credential credential)

Determines whether the populator has the capability to perform tasks on the given credential. In practice, the 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.

Since:

4.1.0

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered