Package 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

  • Field Details

  • Method Details

    • registerAuthenticationHandler

      boolean registerAuthenticationHandler(AuthenticationHandler handler)
      Register authentication handler.
      Parameters:
      handler - the handler
      Returns:
      true/false

    • registerAuthenticationHandlers

      default void registerAuthenticationHandlers(List<? extends AuthenticationHandler> handlers)
      Register authentication handlers.
      Parameters:
      handlers - the handlers

    • registerAuthenticationMetadataPopulator

      void registerAuthenticationMetadataPopulator(AuthenticationMetaDataPopulator populator)
      Register metadata populator.
      Parameters:
      populator - the populator

    • registerAuthenticationPostProcessor

      void registerAuthenticationPostProcessor(AuthenticationPostProcessor processor)
      Register authentication post processor.
      Parameters:
      processor - the populator

    • registerAuthenticationPreProcessor

      void registerAuthenticationPreProcessor(AuthenticationPreProcessor processor)
      Register authentication pre processor.
      Parameters:
      processor - the populator

    • registerAuthenticationMetadataPopulators

      void registerAuthenticationMetadataPopulators(Collection<AuthenticationMetaDataPopulator> populator)
      Register metadata populators.
      Parameters:
      populator - the populator

    • registerAuthenticationPolicy

      void registerAuthenticationPolicy(AuthenticationPolicy authenticationPolicy)
      Register authentication policy.
      Parameters:
      authenticationPolicy - the authentication policy

    • registerAuthenticationPolicies

      void registerAuthenticationPolicies(Collection<AuthenticationPolicy> authenticationPolicy)
      Register authentication policies.
      Parameters:
      authenticationPolicy - the authentication policy

    • registerAuthenticationHandlerResolver

      void registerAuthenticationHandlerResolver(AuthenticationHandlerResolver handlerResolver)
      Register authentication handler resolver.
      Parameters:
      handlerResolver - the handler resolver

    • registerAuthenticationPolicyResolver

      void registerAuthenticationPolicyResolver(AuthenticationPolicyResolver policyResolver)
      Register authentication policy resolver.
      Parameters:
      policyResolver - the policy resolver

    • registerAuthenticationHandlerWithPrincipalResolver

      void registerAuthenticationHandlerWithPrincipalResolver(Map<AuthenticationHandler,PrincipalResolver> plan)
      Register authentication handler with principal resolver.
      Parameters:
      plan - the plan

    • registerAuthenticationHandlerWithPrincipalResolver

      boolean registerAuthenticationHandlerWithPrincipalResolver(AuthenticationHandler handler, PrincipalResolver principalResolver)
      Register authentication handler with principal resolver.
      Parameters:
      handler - the handler
      principalResolver - the principal resolver
      Returns:
      true if handler was able to successfully register itself, otherwise false.

    • registerAuthenticationHandlersWithPrincipalResolver

      void registerAuthenticationHandlersWithPrincipalResolver(Collection<AuthenticationHandler> handlers, PrincipalResolver principalResolver)
      Register authentication handlers with principal resolver.
      Parameters:
      handlers - the handlers
      principalResolver - the principal resolver

    • registerAuthenticationHandlersWithPrincipalResolver

      void registerAuthenticationHandlersWithPrincipalResolver(List<AuthenticationHandler> handlers, List<PrincipalResolver> principalResolver)
      Register authentication handler with principal resolvers.
      Parameters:
      handlers - the handlers
      principalResolver - the principal resolver

    • getAuthenticationHandlers

      Set<AuthenticationHandler> getAuthenticationHandlers(AuthenticationTransaction transaction) throws Throwable
      Gets authentication handlers for transaction.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication handlers for transaction
      Throws:
      Throwable - the throwable

    • getAuthenticationHandlers

      Set<AuthenticationHandler> getAuthenticationHandlers()
      Gets authentication handlers.
      Returns:
      the authentication handlers

    • getAuthenticationHandlersBy

      default Set<AuthenticationHandler> getAuthenticationHandlersBy(Predicate<AuthenticationHandler> filter)
      Gets authentication handlers by a filter.
      Parameters:
      filter - the filter
      Returns:
      the authentication handlers by

    • getAuthenticationMetadataPopulators

      Collection<AuthenticationMetaDataPopulator> getAuthenticationMetadataPopulators(AuthenticationTransaction transaction)
      Gets authentication metadata populators.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication metadata populators

    • getAuthenticationPostProcessors

      Collection<AuthenticationPostProcessor> getAuthenticationPostProcessors(AuthenticationTransaction transaction)
      Gets authentication post processors.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication metadata populators

    • getAuthenticationPreProcessors

      Collection<AuthenticationPreProcessor> getAuthenticationPreProcessors(AuthenticationTransaction transaction)
      Gets authentication pre processors.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication metadata populators

    • getPrincipalResolver

      PrincipalResolver getPrincipalResolver(AuthenticationHandler handler, AuthenticationTransaction transaction)
      Gets principal resolver for authentication transaction.
      Parameters:
      handler - the handler
      transaction - the transaction
      Returns:
      the principal resolver for authentication transaction

    • getAuthenticationPolicies

      Collection<AuthenticationPolicy> getAuthenticationPolicies(AuthenticationTransaction transaction)
      Gets authentication policies.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication policies

    • getAuthenticationPolicies

      Collection<AuthenticationPolicy> getAuthenticationPolicies(Authentication authentication)
      Gets authentication policies.
      Parameters:
      authentication - the authentication
      Returns:
      the authentication policies

    • getAuthenticationPolicies

      Collection<AuthenticationPolicy> getAuthenticationPolicies()
      Gets authentication policies.
      Returns:
      the authentication policies

    • getAuthenticationHandlerResolvers

      Collection<AuthenticationHandlerResolver> getAuthenticationHandlerResolvers(AuthenticationTransaction transaction)
      Gets authentication handler resolvers.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication handler resolvers

    • getAuthenticationPolicyResolvers

      Collection<AuthenticationPolicyResolver> getAuthenticationPolicyResolvers(AuthenticationTransaction transaction)
      Gets authentication policy resolvers.
      Parameters:
      transaction - the transaction
      Returns:
      the authentication handler resolvers