org.jasig.cas.authentication

Interface AuthenticationManager

All Known Implementing Classes:

AbstractAuthenticationManager, AuthenticationManagerImpl, DirectMappingAuthenticationManagerImpl, LinkedAuthenticationHandlerAndCredentialsToPrincipalResolverAuthenticationManager

public interface AuthenticationManager

The AuthenticationManager class is the entity that determines the authenticity of the credentials provided. It (or a class it delegates to) is the sole authority on whether credentials are valid or not.

Since:

3.0

This is a published and supported CAS Server 3 API.

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_METHOD_ATTRIBUTE

Method Summary

Methods

Modifier and Type	Method and Description
Authentication	authenticate(Credentials credentials) Method to validate the credentials provided.

Field Detail

AUTHENTICATION_METHOD_ATTRIBUTE

static final String AUTHENTICATION_METHOD_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

authenticate

Authentication authenticate(Credentials credentials)
                            throws AuthenticationException

Method to validate the credentials provided. On successful validation, a fully populated Authentication object will be returned. Typically this will involve resolving a principal and providing any additional attributes, but specifics are left to the individual implementations to determine. Failure to authenticate is considered an exceptional case, and an AuthenticationException is thrown.

Parameters:

credentials - The credentials provided for authentication.

Returns:

fully populated Authentication object.

Throws:

AuthenticationException - if unable to determine validity of credentials or there is an extenuating circumstance related to credentials (i.e. Account locked).