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

    • Method Detail

      • registerAuthenticationHandler

        void registerAuthenticationHandler​(AuthenticationHandler handler)
        Register authentication handler.
        Parameters:
        handler - the handler

      • 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​(java.util.Collection<AuthenticationMetaDataPopulator> populator)
        Register metadata populators.
        Parameters:
        populator - the populator

      • registerAuthenticationPolicy

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

      • registerAuthenticationHandlerResolver

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

      • registerAuthenticationHandlerWithPrincipalResolver

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

      • registerAuthenticationHandlerWithPrincipalResolver

        void registerAuthenticationHandlerWithPrincipalResolver​(AuthenticationHandler handler,
                                                        PrincipalResolver principalResolver)
        Register authentication handler with principal resolver.
        Parameters:
        handler - the handler
        principalResolver - the principal resolver

      • registerAuthenticationHandlerWithPrincipalResolvers

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

      • registerAuthenticationHandlerWithPrincipalResolvers

        void registerAuthenticationHandlerWithPrincipalResolvers​(java.util.List<AuthenticationHandler> handlers,
                                                         java.util.List<PrincipalResolver> principalResolver)
        Register authentication handler with principal resolvers.
        Parameters:
        handlers - the handlers
        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

      • getAuthenticationHandlers

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

      • getAuthenticationMetadataPopulators

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

      • getAuthenticationPostProcessors

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

      • getAuthenticationPreProcessors

        java.util.Collection<AuthenticationPreProcessor> getAuthenticationPreProcessors​(AuthenticationTransaction transaction)
        Gets authentication pre processors.
        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

      • getAuthenticationPolicies

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

      • getAuthenticationHandlerResolvers

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