Package org.apereo.cas.authentication

Interface AuthenticationManager

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 AuthenticationManager
Authenticates one or more credentials.
Since:
3.0.0

  • Field Details

    • BEAN_NAME

      static final String BEAN_NAME
      Default bean name.
      See Also:

    • AUTHENTICATION_METHOD_ATTRIBUTE

      static final String AUTHENTICATION_METHOD_ATTRIBUTE
      Authentication method attribute name.
      See Also:

    • AUTHENTICATION_SESSION_TIMEOUT_ATTRIBUTE

      static final String AUTHENTICATION_SESSION_TIMEOUT_ATTRIBUTE
      Authentication session timeout attribute whose value in seconds would control the session timeout for this authentication event.
      See Also:

    • AUTHENTICATION_DATE_ATTRIBUTE

      static final String AUTHENTICATION_DATE_ATTRIBUTE
      Authentication date attribute name.
      See Also:

  • Method Details

    • authenticate

      Authentication authenticate(AuthenticationTransaction authenticationTransaction) throws Throwable
      Authenticates the provided credentials. On success, an Authentication object is returned containing metadata about the result of each authenticated credential. Note that a particular implementation may require some or all credentials to be successfully authenticated. Failure to authenticate is considered an exceptional case, and an AuthenticationException is thrown.
      Parameters:
      authenticationTransaction - Process a single authentication transaction
      Returns:
      Authentication object on success that contains metadata about credentials that were authenticated.
      Throws:
      Throwable - the throwable