Package org.apereo.cas.authentication

Interface AuthenticationEventExecutionPlanConfigurer

All Superinterfaces:
org.apereo.cas.util.NamedObject, org.springframework.core.Ordered
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface AuthenticationEventExecutionPlanConfigurer extends org.springframework.core.Ordered, org.apereo.cas.util.NamedObject
This is AuthenticationEventExecutionPlanConfigurer. Passes on an authentication execution plan to implementors to register authentication handlers, etc.

Since this interface conforms to a functional interface requirement, typical implementors are @Conditional beans expressed as compact lambda expressions inside of various CAS modules that contribute to the overall CAS authentication subsystem.

Note: Existing configuration classes that are injected authentication-related functionality such as the transaction manager or the authentication support components need to be refactored to isolate those changes into the configurer. Otherwise, circular dependency issues may appear.

Since:
5.1.0

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configureAuthenticationExecutionPlan(AuthenticationEventExecutionPlan plan)
    configure the plan.
    default int
    getOrder()
     

    Methods inherited from interface org.apereo.cas.util.NamedObject

    getName

  • Method Details

    • configureAuthenticationExecutionPlan

      void configureAuthenticationExecutionPlan(AuthenticationEventExecutionPlan plan) throws Exception
      configure the plan.
      Parameters:
      plan - the plan
      Throws:
      Exception

    • getOrder

      default int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered