org.acegisecurity.AuthenticationManager Maven / Gradle / Ivy
/* Copyright 2004 Acegi Technology Pty Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.acegisecurity;
/**
* Processes an {@link Authentication} request.
*
* @author Ben Alex
* @version $Id: AuthenticationManager.java,v 1.3 2005/11/17 00:55:49 benalex Exp $
*/
public interface AuthenticationManager {
//~ Methods ================================================================
/**
* Attempts to authenticate the passed {@link Authentication} object,
* returning a fully populated Authentication object
* (including granted authorities) if successful.
*
*
* An AuthenticationManager must honour the following contract
* concerning exceptions:
*
*
*
* A {@link DisabledException} must be thrown if an account is disabled and
* the AuthenticationManager can test for this state.
*
*
*
* A {@link LockedException} must be thrown if an account is locked and the
* AuthenticationManager can test for account locking.
*
*
*
* A {@link BadCredentialsException} must be thrown if incorrect
* credentials are presented. Whilst the above exceptions are optional, an
* AuthenticationManager must always test credentials.
*
*
*
* Exceptions should be tested for and if applicable thrown in the order
* expressed above (ie if an account is disabled or locked, the
* authentication request is immediately rejected and the credentials
* testing process is not performed). This prevents credentials being
* tested against disabled or locked accounts.
*
*
* @param authentication the authentication request object
*
* @return a fully authenticated object including credentials
*
* @throws AuthenticationException if authentication fails
*/
public Authentication authenticate(Authentication authentication)
throws AuthenticationException;
}