com.sun.identity.saml2.meta.SAML2MetaException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openam-federation-library Show documentation
OpenAM Federation Library Components
There is a newer version: 14.8.4
Show newest version
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: SAML2MetaException.java,v 1.2 2008/06/25 05:47:49 qcheng Exp $
 *
 */


package com.sun.identity.saml2.meta;

import com.sun.identity.saml2.common.SAML2Exception;


/**
 * This class is an extension point for all SAML2 Meta related exceptions.
 * This class also handles message localization in SAML2 Meta exceptions.
 */
public class SAML2MetaException extends SAML2Exception {
    
    /**
     * Constructs a new SAML2MetaException without a nested
     * Throwable using default resource bundle.
     * @param errorCode Key to resource bundle. You can use
     *      * ResourceBundle rb = ResourceBunde.getBundle (rbName,locale);
     * String localizedStr = rb.getString(errorCode);
     * 
     * @param args arguments to message. If it is not present pass them
     * as null
     * 
     */
    public SAML2MetaException(String errorCode, Object[] args) {
        super(SAML2MetaUtils.RESOURCE_BUNDLE_NAME, errorCode, args);
    }

    /**
     * Constructs a new SAML2MetaException without a nested
     * Throwable.
     * @param rbName Resource Bundle Name to be used for getting
     * localized error message.
     * @param errorCode Key to resource bundle. You can use
     *      * ResourceBundle rb = ResourceBunde.getBundle (rbName,locale);
     * String localizedStr = rb.getString(errorCode);
     * 
     * @param args arguments to message. If it is not present pass them
     * as null
     * 
     */
    public SAML2MetaException(String rbName, String errorCode, Object[] args) {
        super(rbName, errorCode, args);
    }
    
    /**
     * Constructs a new SAML2MetaException with the given
     * message.
     *
     * @param message message for this exception. This message can be later
     * retrieved by getMessage() method.
     * 
     */
    public SAML2MetaException(String message) {
        super(message);
    }
    
    /**
     * Constructs an SAML2MetaException with given
     * Throwable.
     *
     * @param t Exception nested in the new exception.
     * 
     */
    public SAML2MetaException(Throwable t) {
        super(t);
    }
    
}