Package org.apereo.cas.authentication

Interface AuthenticationPostProcessor

All Superinterfaces:
org.springframework.beans.factory.DisposableBean, 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 AuthenticationPostProcessor extends org.springframework.core.Ordered, org.springframework.beans.factory.DisposableBean
This is AuthenticationPostProcessor. Authentication post processors run as the very last step in CAS authentication where authentication event is internally processed, validated, principal resolved and all attributes for principal and authentication are collected.
Since:
5.2.0

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    destroy()
     
    default int
    getOrder()
     
    static AuthenticationPostProcessor
    none()
    No authentication post processor.
    void
    process(AuthenticationBuilder builder, AuthenticationTransaction transaction)
    Process the authentication event.
    default boolean
    supports(Credential credential)
    Determines whether the processor has the capability to perform tasks on the given credential.

  • Method Details

    • getOrder

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

    • process

      void process(AuthenticationBuilder builder, AuthenticationTransaction transaction) throws Throwable
      Process the authentication event.
      Parameters:
      builder - Builder object that temporarily holds authentication metadata.
      transaction - The authentication transaction.
      Throws:
      Throwable - the authn security exception

    • supports

      default boolean supports(Credential credential) throws Throwable
      Determines whether the processor has the capability to perform tasks on the given credential.
      Parameters:
      credential - The credential to check.
      Returns:
      True if processor supports the Credential, false otherwise.
      Throws:
      Throwable - the throwable

    • destroy

      default void destroy()
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean

    • none

      static AuthenticationPostProcessor none()
      No authentication post processor.
      Returns:
      the authentication post processor