Package org.apereo.cas.authentication

Interface AuthenticationPreProcessor

All Superinterfaces:
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 AuthenticationPreProcessor extends org.springframework.core.Ordered
This is AuthenticationPreProcessor. Authentication pre processors run as the very first step in CAS authentication where credentials are about to be authenticated.
Since:
5.3.0

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    default int
    getOrder()
     
    boolean
    process(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

      boolean process(AuthenticationTransaction transaction) throws Throwable
      Process the authentication event.
      Parameters:
      transaction - The authentication transaction.
      Returns:
      true /false
      Throws:
      Throwable - the throwable

    • 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