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