org.springframework.security.authentication.jaas.LoginExceptionResolver Maven / Gradle / Ivy
/*
* Copyright 2004, 2005, 2006 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
*
* https://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.springframework.security.authentication.jaas;
import javax.security.auth.login.LoginException;
import org.springframework.security.core.AuthenticationException;
/**
* The JaasAuthenticationProvider takes an instance of LoginExceptionResolver to resolve
* LoginModule specific exceptions to Spring Security AuthenticationExceptions.
* For instance, a configured login module could throw a ScrewedUpPasswordException that
* extends LoginException, in this instance the LoginExceptionResolver implementation
* would return a
* {@link org.springframework.security.authentication.BadCredentialsException}.
*
* @author Ray Krueger
*/
public interface LoginExceptionResolver {
/**
* Translates a Jaas LoginException to an SpringSecurityException.
* @param ex The LoginException thrown by the configured LoginModule.
* @return The AuthenticationException that the JaasAuthenticationProvider should
* throw.
*/
AuthenticationException resolveException(LoginException ex);
}