summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/selftests/EMissingSelfTestException.java
blob: 8c2353287c6e38c895f5bff0bed0b98a844d4bbb (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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// --- 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 statement //
///////////////////////

package com.netscape.certsrv.selftests;


///////////////////////
// import statements //
///////////////////////

import com.netscape.certsrv.base.*;


//////////////////////
// class definition //
//////////////////////

/**
 * This class implements a missing self test exception.
 * EMissingSelfTestExceptions are derived from ESelfTestExceptions
 * in order to allow users to easily do self tests without try-catch clauses.
 *
 * EMissingSelfTestExceptions should be caught by SelfTestSubsystem managers.
 * <P>
 * 
 * @version $Revision$, $Date$
 */
public class EMissingSelfTestException
    extends ESelfTestException {
    ////////////////////////
    // default parameters //
    ////////////////////////



    ///////////////////////
    // helper parameters //
    ///////////////////////

    private String mInstanceName = null;
    private String mInstanceStore = null;
    private String mInstanceParameter = null;
    private String mInstanceValue = null;

    //////////////////////////////////////////
    // EMissingSelfTestException parameters //
    //////////////////////////////////////////



    ///////////////////////////////////////////////
    // ESelfTestException parameters (inherited) //
    ///////////////////////////////////////////////



    /////////////////////
    // default methods //
    /////////////////////

    /**
     * Constructs a "missing" self test exception where the name is null
     * <P>
     *
     */
    public EMissingSelfTestException() {
        super("The self test plugin property name is null.");
    }

    /**
     * Constructs a "missing" self test exception where the name is always
     * missing from a name/value pair.
     * <P>
     *
     * @param instanceName missing "instanceName" exception details
     */
    public EMissingSelfTestException(String instanceName) {
        super("The self test plugin property named "
            + instanceName
            + " does not exist.");

        // strip preceding/trailing whitespace
        // from passed-in String parameters
        if (instanceName != null) {
            instanceName = instanceName.trim();
        }

        // store passed-in parameters for use by helper methods
        mInstanceName = instanceName;
    }

    /**
     * Constructs a "missing" self test exception where the value is always
     * missing from a name/value pair; (the value passed in is always null).
     * <P>
     *
     * @param instanceName missing "instanceName" exception details
     * @param instanceValue missing "instanceValue" exception details
     * (always null)
     */
    public EMissingSelfTestException(String instanceName,
        String instanceValue) {
        super("The self test plugin property named "
            + instanceName
            + " contains no values.");

        // strip preceding/trailing whitespace
        // from passed-in String parameters
        if (instanceName != null) {
            instanceName = instanceName.trim();
        }
        if (instanceValue != null) {
            instanceValue = instanceValue.trim();
        }

        // store passed-in parameters for use by helper methods
        mInstanceName = instanceName;
        mInstanceValue = instanceValue;
    }

    /**
     * Constructs a "missing" self test exception where the parameter is always
     * missing from a substore.parameter/value pair; (the value passed in may
     * be null).
     * <P>
     *
     * @param instanceStore missing "instanceStore" exception details
     * @param instanceParameter missing "instanceParameter" exception details
     * @param instanceValue missing "instanceValue" exception details
     * (may be null)
     */
    public EMissingSelfTestException(String instanceStore,
        String instanceParameter,
        String instanceValue) {
        super("The self test plugin property named "
            + instanceStore + "." + instanceParameter
            + " is missing.");

        // strip preceding/trailing whitespace
        // from passed-in String parameters
        if (instanceStore != null) {
            instanceStore = instanceStore.trim();
        }
        if (instanceParameter != null) {
            instanceParameter = instanceParameter.trim();
        }
        if (instanceValue != null) {
            instanceValue = instanceValue.trim();
        }

        // store passed-in parameters for use by helper methods
        mInstanceStore = instanceStore;
        mInstanceParameter = instanceParameter;
        mInstanceValue = instanceValue;
    }

    ////////////////////
    // helper methods //
    ////////////////////

    /**
     * Returns the instance name associated with this self test.
     * <P>
     *
     * @return name portion of the name/value pair
     */
    public String getInstanceName() {
        return mInstanceName;
    }

    /**
     * Returns the store associated with this self test.
     * <P>
     *
     * @return substore portion of the substore.parameter/value pair
     */
    public String getInstanceStore() {
        return mInstanceStore;
    }

    /**
     * Returns the parameter associated with this self test.
     * <P>
     *
     * @return parameter portion of the substore.parameter/value pair
     */
    public String getInstanceParameter() {
        return mInstanceParameter;
    }

    /**
     * Returns the value associated with this self test.
     * <P>
     *
     * @return value portion of the name/value pair
     */
    public String getInstanceValue() {
        return mInstanceValue;
    }

    ///////////////////////////////////////
    // EMissingSelfTestException methods //
    ///////////////////////////////////////



    ////////////////////////////////////////////
    // ESelfTestException methods (inherited) //
    ////////////////////////////////////////////

    /* Note that all of the following ESelfTestException methods
     * are inherited from the ESelfTestException class:
     *
     * public ESelfTestException( String msg );
     */
}