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
143
144
145
146
147
148
149
150
|
// --- 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.certsrv.base;
import java.io.*;
import java.util.*;
import java.text.*;
import java.lang.reflect.*;
/**
* An exception with localizable error messages. It is the
* base class for all exceptions in certificate server.
* <P>
*
* @version $Revision$, $Date$
* @see java.text.MessageFormat
* @see com.netscape.certsrv.base.BaseResources
*/
public class EBaseException extends Exception {
/**
* The resource bundle to use for error messages.
* Subclasses can override to use its own resource bundle.
*/
private static final String BASE_RESOURCES = BaseResources.class.getName();
/**
* Parameters to the exception error message.
*/
public Object mParams[] = null;
/**
* Constructs an instance of this exception with the given resource key.
* If resource key is not found in the resource bundle, the resource key
* specified is used as the error message.
* <pre>
* new EBaseException(BaseResources.PERMISSION_DENIED);
* new EBaseException("An plain error message");
* <P>
* @param msgFormat The error message resource key.
*/
public EBaseException(String msgFormat) {
super(msgFormat);
mParams = null;
}
/**
* Constructs an instance of this exception with the given resource key
* and a parameter as a string.
* <PRE>
* new EBaseException(BaseResource.NO_CONFIG_FILE, fileName);
* </PRE>
* <P>
* @param msgFormat exception details in message string format
* @param param message string parameter
*/
public EBaseException(String msgFormat, String param) {
super(msgFormat);
mParams = new String[1];
mParams[0] = param;
}
/**
* Constructs an instance of the exception given the resource key and
* a exception parameter.
* <PRE>
* try {
* ...
* } catch (IOExeption e) {
* throw new EBaseException(BaseResources.INTERNAL_ERROR_1, e);
* }
* </PRE>
* <P>
* @param msgFormat The resource key
* @param param The parameter as an exception
*/
public EBaseException(String msgFormat, Exception param) {
super(msgFormat);
mParams = new Exception[1];
mParams[0] = param;
}
/**
* Constructs an instance of this exception given the resource key and
* an array of parameters.
* <P>
* @param msgFormat The resource key
* @param params Array of params
*/
public EBaseException(String msgFormat, Object params[]) {
super(msgFormat);
mParams = params;
}
/**
* Returns the list of parameters.
* <P>
*
* @return List of parameters.
*/
public Object[] getParameters() {
return mParams;
}
/**
* Returns the exception string in the default locale.
* <P>
* @return The exception string in the default locale.
*/
public String toString() {
return toString(Locale.getDefault());
}
/**
* Returns the exception string in the given locale.
* <P>
* @param locale The locale
* @return The exception string in the given locale.
*/
public String toString(Locale locale) {
return MessageFormatter.getLocalizedString(locale, getBundleName(),
super.getMessage(), mParams);
}
/**
* Returns the given resource bundle name.
* @return the name of the resource bundle for this class.
*/
protected String getBundleName() {
return BASE_RESOURCES;
}
}
|
