/* 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 net.sf.acegisecurity;

/**
 * Abstract superclass for all exceptions related to the {@link
 * AuthenticationManager} being unable to authenticate an {@link
 * Authentication} object.
 *
 * @author Ben Alex
 * @version $Id: AuthenticationException.java,v 1.2 2004/03/23 04:44:45 benalex Exp $
 */
public abstract class AuthenticationException extends AcegiSecurityException {

    /** The authentication that related to this exception*/
    private Authentication authentication;

    //~ Constructors ===========================================================

    /**
     * Constructs an <code>AuthenticationException</code> with the specified
     * message and root cause.
     *
     * @param msg the detail message
     * @param t the root cause
     */
    public AuthenticationException(String msg, Throwable t) {
        super(msg, t);
    }

    /**
     * Constructs an <code>AuthenticationException</code> with the specified
     * message and no root cause.
     *
     * @param msg the detail message
     */
    public AuthenticationException(String msg) {
        super(msg);
    }

    /**
     * @return the <code>Authentication</code> that is related to this <code>AuthenticationException</code>
     */
    public Authentication getAuthentication() {
        return authentication;
    }

    /**
     * @param authentication the <code>Authentication</code> that is related to this <code>AuthenticationException</code>
     */
    public void setAuthentication(Authentication authentication) {
        this.authentication = authentication;
    }
}