authenticationmanager.java

来自「CAS在Tomcat中实现单点登录项目,单点登录（Single Sign On 」· Java 代码 · 共 42 行

/*
 * Copyright 2007 The JA-SIG Collaborative. All rights reserved. See license
 * distributed with this file and available online at
 * http://www.ja-sig.org/products/cas/overview/license/
 */
package org.jasig.cas.authentication;

import org.jasig.cas.authentication.handler.AuthenticationException;
import org.jasig.cas.authentication.principal.Credentials;

/**
 * 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.
 * 
 * @author Scott Battaglia
 * @version $Revision: 42053 $ $Date: 2007-06-10 09:17:55 -0400 (Sun, 10 Jun 2007) $
 * @since 3.0
 * <p>
 * This is a published and supported CAS Server 3 API.
 * </p>
 */
public interface AuthenticationManager {

    /**
     * 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.
     * 
     * @param credentials The credentials provided for authentication.
     * @return 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).
     */
    Authentication authenticate(final Credentials credentials)
        throws AuthenticationException;
}