org.apereo.cas.authentication

Interface AuthenticationEventExecutionPlan

public interface AuthenticationEventExecutionPlan

This is AuthenticationEventExecutionPlan. A higher-level abstraction to encapsulate the registration of authentication handlers, etc. Each module would interact with this interface that controls the registration and positioning of the handlers, etc. The authentication manager contains this interface, and may dynamically for each transaction ask for a candidate list of handlers/resolvers, etc.

Since:

5.1.0

Method Summary

Modifier and Type	Method and Description
java.util.Set<AuthenticationHandler>	getAuthenticationHandlersForTransaction(AuthenticationTransaction transaction) Gets authentication handlers for transaction.
java.util.Collection<AuthenticationMetaDataPopulator>	getAuthenticationMetadataPopulators(AuthenticationTransaction transaction) Gets authentication metadata populators.
PrincipalResolver	getPrincipalResolverForAuthenticationTransaction(AuthenticationHandler handler, AuthenticationTransaction transaction) Gets principal resolver for authentication transaction.
void	registerAuthenticationHandler(AuthenticationHandler handler) Register authentication handler.
void	registerAuthenticationHandlerWithPrincipalResolver(AuthenticationHandler handler, PrincipalResolver principalResolver) Register authentication handler with principal resolver.
void	registerAuthenticationHandlerWithPrincipalResolver(java.util.Map<AuthenticationHandler,PrincipalResolver> plan) Register authentication handler with principal resolver.
void	registerAuthenticationHandlerWithPrincipalResolvers(java.util.Collection<AuthenticationHandler> handlers, PrincipalResolver principalResolver) Register authentication handlers with principal resolver.
void	registerMetadataPopulator(AuthenticationMetaDataPopulator populator) Register metadata populator.
void	registerMetadataPopulators(java.util.Collection<AuthenticationMetaDataPopulator> populator) Register metadata populators.

Method Detail

registerAuthenticationHandler

void registerAuthenticationHandler(AuthenticationHandler handler)

Register authentication handler.

Parameters:

handler - the handler

registerMetadataPopulator

void registerMetadataPopulator(AuthenticationMetaDataPopulator populator)

Register metadata populator.

Parameters:

populator - the populator

registerMetadataPopulators

void registerMetadataPopulators(java.util.Collection<AuthenticationMetaDataPopulator> populator)

Register metadata populators.

Parameters:

populator - the populator

registerAuthenticationHandlerWithPrincipalResolver

void registerAuthenticationHandlerWithPrincipalResolver(java.util.Map<AuthenticationHandler,PrincipalResolver> plan)

Register authentication handler with principal resolver.

Parameters:

plan - the plan

registerAuthenticationHandlerWithPrincipalResolvers

void registerAuthenticationHandlerWithPrincipalResolvers(java.util.Collection<AuthenticationHandler> handlers,
                                                         PrincipalResolver principalResolver)

Register authentication handlers with principal resolver.

Parameters:

handlers - the handlers

principalResolver - the principal resolver

registerAuthenticationHandlerWithPrincipalResolver

void registerAuthenticationHandlerWithPrincipalResolver(AuthenticationHandler handler,
                                                        PrincipalResolver principalResolver)

Register authentication handler with principal resolver.

Parameters:

handler - the handler

principalResolver - the principal resolver

getAuthenticationHandlersForTransaction

java.util.Set<AuthenticationHandler> getAuthenticationHandlersForTransaction(AuthenticationTransaction transaction)

Gets authentication handlers for transaction.

Parameters:

transaction - the transaction

Returns:

the authentication handlers for transaction

getAuthenticationMetadataPopulators

java.util.Collection<AuthenticationMetaDataPopulator> getAuthenticationMetadataPopulators(AuthenticationTransaction transaction)

Gets authentication metadata populators.

Parameters:

transaction - the transaction

Returns:

the authentication metadata populators

getPrincipalResolverForAuthenticationTransaction

PrincipalResolver getPrincipalResolverForAuthenticationTransaction(AuthenticationHandler handler,
                                                                   AuthenticationTransaction transaction)

Gets principal resolver for authentication transaction.

Parameters:

handler - the handler

transaction - the transaction

Returns:

the principal resolver for authentication transaction