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 Summary
Fields Modifier and Type Field Description static java.lang.String
AUTHENTICATION_METHOD_ATTRIBUTE
Authentication method attribute name.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Authentication
authenticate(AuthenticationTransaction authenticationTransaction)
Authenticates the provided credentials.
-
-
-
Field Detail
-
AUTHENTICATION_METHOD_ATTRIBUTE
static final java.lang.String AUTHENTICATION_METHOD_ATTRIBUTE
Authentication method attribute name.- See Also:
- Constant Field Values
-
-
Method Detail
-
authenticate
Authentication authenticate(AuthenticationTransaction authenticationTransaction) throws AuthenticationException
Authenticates the provided credentials. On success, anAuthentication
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:
AuthenticationException
- On authentication failure. The exception contains details on each of the credentials that failed to authenticate.
-
-