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