org.apereo.cas.authentication

Class DefaultAuthenticationEventExecutionPlan

java.lang.Object

org.apereo.cas.authentication.DefaultAuthenticationEventExecutionPlan

All Implemented Interfaces:

AuthenticationEventExecutionPlan

public class DefaultAuthenticationEventExecutionPlan
extends java.lang.Object
implements AuthenticationEventExecutionPlan

This is DefaultAuthenticationEventExecutionPlan.

Since:

5.1.0

Constructor Summary

Constructors

Constructor and Description
DefaultAuthenticationEventExecutionPlan()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<AuthenticationHandlerResolver>	getAuthenticationHandlerResolvers(AuthenticationTransaction transaction) Gets authentication handler resolvers.
java.util.Set<AuthenticationHandler>	getAuthenticationHandlersForTransaction(AuthenticationTransaction transaction) Gets authentication handlers for transaction.
java.util.Collection<AuthenticationMetaDataPopulator>	getAuthenticationMetadataPopulators(AuthenticationTransaction transaction) Gets authentication metadata populators.
java.util.Collection<AuthenticationPolicy>	getAuthenticationPolicies(AuthenticationTransaction transaction) Gets authentication policies.
java.util.Collection<AuthenticationPostProcessor>	getAuthenticationPostProcessors(AuthenticationTransaction transaction) Gets authentication post processors.
java.util.Collection<AuthenticationPreProcessor>	getAuthenticationPreProcessors(AuthenticationTransaction transaction) Gets authentication pre processors.
PrincipalResolver	getPrincipalResolverForAuthenticationTransaction(AuthenticationHandler handler, AuthenticationTransaction transaction) Gets principal resolver for authentication transaction.
void	registerAuthenticationHandler(AuthenticationHandler handler) Register authentication handler.
void	registerAuthenticationHandlerResolver(AuthenticationHandlerResolver handlerResolver) Register authentication handler resolver.
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	registerAuthenticationHandlerWithPrincipalResolvers(java.util.List<AuthenticationHandler> handlers, java.util.List<PrincipalResolver> principalResolver) Register authentication handler with principal resolvers.
void	registerAuthenticationPolicy(AuthenticationPolicy authenticationPolicy) Register authentication policy.
void	registerAuthenticationPostProcessor(AuthenticationPostProcessor processor) Register authentication post processor.
void	registerAuthenticationPreProcessor(AuthenticationPreProcessor processor) Register authentication pre processor.
void	registerMetadataPopulator(AuthenticationMetaDataPopulator populator) Register metadata populator.
void	registerMetadataPopulators(java.util.Collection<AuthenticationMetaDataPopulator> populators) Register metadata populators.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthenticationEventExecutionPlan

public DefaultAuthenticationEventExecutionPlan()

Method Detail

registerAuthenticationHandler

public void registerAuthenticationHandler(AuthenticationHandler handler)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handler.

Specified by:

registerAuthenticationHandler in interface AuthenticationEventExecutionPlan

Parameters:

handler - the handler

registerAuthenticationHandlerWithPrincipalResolver

public void registerAuthenticationHandlerWithPrincipalResolver(AuthenticationHandler handler,
                                                               PrincipalResolver principalResolver)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handler with principal resolver.

Specified by:

registerAuthenticationHandlerWithPrincipalResolver in interface AuthenticationEventExecutionPlan

Parameters:

handler - the handler

principalResolver - the principal resolver

registerAuthenticationHandlerWithPrincipalResolver

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

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handler with principal resolver.

Specified by:

registerAuthenticationHandlerWithPrincipalResolver in interface AuthenticationEventExecutionPlan

Parameters:

plan - the plan

registerAuthenticationHandlerWithPrincipalResolvers

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

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handlers with principal resolver.

Specified by:

registerAuthenticationHandlerWithPrincipalResolvers in interface AuthenticationEventExecutionPlan

Parameters:

handlers - the handlers

principalResolver - the principal resolver

registerAuthenticationHandlerWithPrincipalResolvers

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

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handler with principal resolvers.

Specified by:

registerAuthenticationHandlerWithPrincipalResolvers in interface AuthenticationEventExecutionPlan

Parameters:

handlers - the handlers

principalResolver - the principal resolver

registerMetadataPopulator

public void registerMetadataPopulator(AuthenticationMetaDataPopulator populator)

Description copied from interface: AuthenticationEventExecutionPlan

Register metadata populator.

Specified by:

registerMetadataPopulator in interface AuthenticationEventExecutionPlan

Parameters:

populator - the populator

registerMetadataPopulators

public void registerMetadataPopulators(java.util.Collection<AuthenticationMetaDataPopulator> populators)

Description copied from interface: AuthenticationEventExecutionPlan

Register metadata populators.

Specified by:

registerMetadataPopulators in interface AuthenticationEventExecutionPlan

Parameters:

populators - the populator

getAuthenticationMetadataPopulators

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

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication metadata populators.

Specified by:

getAuthenticationMetadataPopulators in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication metadata populators

getAuthenticationHandlersForTransaction

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

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication handlers for transaction.

Specified by:

getAuthenticationHandlersForTransaction in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication handlers for transaction

getPrincipalResolverForAuthenticationTransaction

public PrincipalResolver getPrincipalResolverForAuthenticationTransaction(AuthenticationHandler handler,
                                                                          AuthenticationTransaction transaction)

Description copied from interface: AuthenticationEventExecutionPlan

Gets principal resolver for authentication transaction.

Specified by:

getPrincipalResolverForAuthenticationTransaction in interface AuthenticationEventExecutionPlan

Parameters:

handler - the handler

transaction - the transaction

Returns:

the principal resolver for authentication transaction

registerAuthenticationPostProcessor

public void registerAuthenticationPostProcessor(AuthenticationPostProcessor processor)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication post processor.

Specified by:

registerAuthenticationPostProcessor in interface AuthenticationEventExecutionPlan

Parameters:

processor - the populator

getAuthenticationPostProcessors

public java.util.Collection<AuthenticationPostProcessor> getAuthenticationPostProcessors(AuthenticationTransaction transaction)

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication post processors.

Specified by:

getAuthenticationPostProcessors in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication metadata populators

registerAuthenticationPreProcessor

public void registerAuthenticationPreProcessor(AuthenticationPreProcessor processor)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication pre processor.

Specified by:

registerAuthenticationPreProcessor in interface AuthenticationEventExecutionPlan

Parameters:

processor - the populator

getAuthenticationPreProcessors

public java.util.Collection<AuthenticationPreProcessor> getAuthenticationPreProcessors(AuthenticationTransaction transaction)

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication pre processors.

Specified by:

getAuthenticationPreProcessors in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication metadata populators

registerAuthenticationPolicy

public void registerAuthenticationPolicy(AuthenticationPolicy authenticationPolicy)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication policy.

Specified by:

registerAuthenticationPolicy in interface AuthenticationEventExecutionPlan

Parameters:

authenticationPolicy - the authentication policy

registerAuthenticationHandlerResolver

public void registerAuthenticationHandlerResolver(AuthenticationHandlerResolver handlerResolver)

Description copied from interface: AuthenticationEventExecutionPlan

Register authentication handler resolver.

Specified by:

registerAuthenticationHandlerResolver in interface AuthenticationEventExecutionPlan

Parameters:

handlerResolver - the handler resolver

getAuthenticationPolicies

public java.util.Collection<AuthenticationPolicy> getAuthenticationPolicies(AuthenticationTransaction transaction)

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication policies.

Specified by:

getAuthenticationPolicies in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication policies

getAuthenticationHandlerResolvers

public java.util.Collection<AuthenticationHandlerResolver> getAuthenticationHandlerResolvers(AuthenticationTransaction transaction)

Description copied from interface: AuthenticationEventExecutionPlan

Gets authentication handler resolvers.

Specified by:

getAuthenticationHandlerResolvers in interface AuthenticationEventExecutionPlan

Parameters:

transaction - the transaction

Returns:

the authentication handler resolvers