001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: AuthenticationException.java,v 1.3 2008/06/25 05:42:06 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.authentication.spi;
031
032import com.sun.identity.shared.locale.L10NMessageImpl;
033
034/**
035 * <code>AuthenticationException</code> class is for handling Exception that 
036 * is thrown when the user-entered tokens cause the authentication module to 
037 * be authenticated to <b>fail</b>.
038 *
039 * @supported.all.api
040 */
041public class AuthenticationException extends L10NMessageImpl {
042    /**
043     * Creates <code>AuthenticationException</code> object with given message.
044     *
045     * @param msg English message of this exception.
046     */
047    public AuthenticationException(String msg) {
048        super(msg);
049    }
050    
051    /**
052     * Creates <code>AuthenticationException</code> with the message from 
053     * the given resource bundle, for a given error message key
054     * <code>errorCode</code> and using arguments to the message.
055     *
056     * @param rbName Resource bundle name for the message
057     * @param errorCode Key to the message in resource bundle.
058     * @param args Arguments to the message.
059     */
060    public AuthenticationException(
061        String rbName,
062        String errorCode,
063        Object[] args) {
064        super(rbName, errorCode, args);
065    }
066}