001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 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: SAMLException.java,v 1.2 2008/06/25 05:47:34 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml.common;
031
032import com.sun.identity.shared.locale.L10NMessageImpl;
033
034/**
035 * This class is an extension point for all SAML related exceptions.
036 * It also handles message localization in SAML exceptions.
037 *
038 * @supported.all.api
039 */
040public class SAMLException extends L10NMessageImpl {
041
042    /**
043     * Constructs an <code>SAMLException</code> with a message.
044     *
045     * @param s exception message.
046     */
047    public SAMLException(String s) {
048        super(s);
049    }
050
051    /**
052     * Constructs an <code>SAMLException</code> with given
053     * <code>Throwable</code>.
054     *
055     * @param t Exception nested in the new exception.
056     *
057     */
058    public SAMLException(Throwable t) {
059        super(t);
060    }
061
062    /**
063     * Constructs a new <code>SAMLException</code> without a nested
064     * <code>Throwable</code>.
065     * @param rbName Resource Bundle Name to be used for getting
066     * localized error message.
067     * @param errorCode Key to resource bundle. You can use
068     * <pre>
069     * ResourceBundle rb = ResourceBunde.getBundle (rbName,locale);
070     * String localizedStr = rb.getString(errorCode);
071     * </pre>
072     * @param args arguments to message. If it is not present pass them
073     * as null
074     *
075     */
076    public SAMLException(String rbName, String errorCode, Object[] args) {
077        super(rbName, errorCode, args);
078    }
079
080}