8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: IdRepoFatalException.java,v 1.3 2008/06/25 05:43:28 qcheng Exp $
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * Portions Copyrighted 2015 ForgeRock AS.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The exception class whose instance is thrown if there is any error during the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * operation of objects of the <code>com.sun.identity.sms</code> package. This
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * class maps the exception that occurred at a lower level to a high level
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * error. Using the exception status code <code>getExceptionCode()</code> the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * errors are categorized as a <code>ABORT</code>, <code>RETRY</code>,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>CONFIG_PROBLEM</code> or <code>LDAP_OP_FAILED</code> (typically a
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.all.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic class IdRepoFatalException extends IdRepoException {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param msg
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The message provided by the object which is throwing the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public IdRepoFatalException(String msg, String errorCode) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This constructor is used to pass the localized error message At this
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * level, the locale of the caller is not known and it is not possible to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * throw localized error message at this level. Instead this constructor
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * provides Resource Bundle name and error code for correctly locating the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * error message. The default <code>getMessage()</code> will always return
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * English messages only. This is in consistent with current JRE.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param rbName
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Resource bundle Name to be used for getting localized error
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param errorCode
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Key to resource bundle. You can use <code>ResourceBundle rb =
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * ResourceBunde.getBundle(rbName,locale);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * String localizedStr = rb.getString(errorCode)</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param args
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * arguments to message. If it is not present pass the as null.
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL public IdRepoFatalException(String rbName, String errorCode, Object[] args) {
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * This constructor is used to pass the localized error message At this
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * level, the locale of the caller is not known and it is not possible to
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * throw localized error message at this level. Instead this constructor
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * provides Resource Bundle name ,error code and LDAP Result Code ( in case
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * of LDAP related exception for correctly locating the
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * error message. The default <code>getMessage()</code> will always return
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * English messages only. This is in consistent with current JRE.
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * @param rbName
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * Resource bundle Name to be used for getting localized error
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * @param errorCode
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * Key to resource bundle. You can use <code>ResourceBundle rb =
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * ResourceBunde.getBundle(rbName,locale);
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * String localizedStr = rb.getString(errorCode)</code>.
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * @param ldapResultCode
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * ldap result code
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * @param args
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL * arguments to message. If it is not present pass the as null.
60e9e896a1a7a9e62db162e1e9fb6b3c2df50c33Quentin CASTEL public IdRepoFatalException(String rbName, String errorCode, ResultCode ldapResultCode, Object[] args) {