summaryrefslogtreecommitdiffstats
path: root/pki/base/console/src/com/netscape/admin/certsrv/EAdminException.java
blob: acb5ab6ce8bba44aba15db4e61d98cc773a7566d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.admin.certsrv;

import java.io.*;
import java.util.*;

/**
 * A class represents an administartive exception. By
 * using this exception, the locale conversion can be
 * delayed until it is necessary. THIS CLASS DOES NOT
 * SUPPORT MESSAGE FORMAT.
 * <P>
 *
 * @author jpanchen
 * @version $Revision$, $Date$
 * @see com.netscape.admin.certsrv
 */
public class EAdminException extends Exception {

    /*==========================================================
     * variables
     *==========================================================*/
	public static final String RESOURCES = CMSAdminResources.class.getName();
	private boolean mIsLocalized = false;
	private ResourceBundle mResource;

	/*==========================================================
     * constructors
     *==========================================================*/

	/**
	 * Constructs an exception.
	 * <P>
	 *
	 * @param msgFormat exception details
	 * @param isLocalized true if the string is localized already
	 */
	public EAdminException(String msgFormat, boolean isLocalized) {
		super(msgFormat);
		mResource = ResourceBundle.getBundle(RESOURCES);
		mIsLocalized = isLocalized;
	}

    /*==========================================================
	 * public methods
     *==========================================================*/

    /**
     * Check if the original message is localized already
     *
     * @return true if the message is localized
     */
    public boolean isLocalized() {
        return mIsLocalized;
    }

	/**
	 * Returns localized exception string. This method should
	 * only be called if a localized string is necessary.
	 * <P>
	 *
	 * @return details message
	 */
	public String toString() {
		return getMessage();
	}

	/**
	 * Returns the string based on the given locale.
	 * This is costly since resource boundle is created each time. Use
	 * this only when it is necessary.
	 *
	 * @param locale locale
	 * @return details message
	 */
	public String toString(Locale locale) {
        ResourceBundle resource = ResourceBundle.getBundle(RESOURCES, locale);
        try {
            return resource.getString(super.getMessage());
        } catch (MissingResourceException e) {
            return super.getMessage()+"-"+e.toString();
        } catch (Exception ex) {
            return super.getMessage();
        }
	}

	/**
	 * Returns the message based on the given locale.If the original message
	 * is mark localized, the orginal message will be returned without
	 * converstion. This is costly since resource boundle is created each time.Use
	 * this only when it is necessary.<P>
	 *
	 * @param locale user specify local
	 * @return string representation in specified local
	 */
    public String getMessage(Locale locale){
        return toString(locale);
    }

    /**
	 * Returns the message in default locale. If the original message
	 * is mark localized, the orginal message will be returned without
	 * converstion.<P>
	 *
	 * @return localized detial exception string
	 */
    public String getMessage(){
        if (mIsLocalized)
            return super.getMessage();
        try {
            return mResource.getString(super.getMessage());
        } catch (MissingResourceException e) {
            return super.getMessage()+"-"+e.toString();
        } catch (Exception ex) {
            return super.getMessage();
        }
    }
    
    /**
     * Returns the message or message tag unconvrted
     */
    public String getMessageString() {
        return super.getMessage();
    }

}