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
|
// --- 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.cms.selftests;
///////////////////////
// import statements //
///////////////////////
import com.netscape.certsrv.apps.*;
import com.netscape.certsrv.base.*;
import com.netscape.certsrv.logging.*;
import com.netscape.certsrv.selftests.*;
import java.util.*;
//////////////////////
// class definition //
//////////////////////
/**
* This class implements an individual self test.
* <P>
*
* @author mharmsen
* @author thomask
* @version $Revision$, $Date$
*/
public abstract class ASelfTest
implements ISelfTest {
////////////////////////
// default parameters //
////////////////////////
//////////////////////////
// ISelfTest parameters //
//////////////////////////
// parameter information
private static final String SELF_TEST_NAME = "ASelfTest";
// variables associated with this specific object
protected ISelfTestSubsystem mSelfTestSubsystem = null;
protected String mInstanceName = null;
protected IConfigStore mConfig = null;
protected String mPrefix = null;
/////////////////////
// default methods //
/////////////////////
///////////////////////
// ISelfTest methods //
///////////////////////
/**
* Initializes this subsystem with the configuration store
* associated with this instance name.
* <P>
*
* @param subsystem the associated subsystem
* @param instanceName the name of this self test instance
* @param parameters configuration store (self test parameters)
* @exception EDuplicateSelfTestException subsystem has duplicate name/value
* @exception EInvalidSelfTestException subsystem has invalid name/value
* @exception EMissingSelfTestException subsystem has missing name/value
*/
public void initSelfTest(ISelfTestSubsystem subsystem,
String instanceName,
IConfigStore parameters)
throws EDuplicateSelfTestException,
EInvalidSelfTestException,
EMissingSelfTestException {
// store individual self test class values for this instance
mSelfTestSubsystem = (ISelfTestSubsystem) subsystem;
// strip preceding/trailing whitespace
// from passed-in String parameters
if (instanceName != null) {
instanceName = instanceName.trim();
} else {
mSelfTestSubsystem.log(mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage(
"SELFTESTS_PARAMETER_WAS_NULL",
SELF_TEST_NAME));
throw new EMissingSelfTestException();
}
// store additional individual self test class values for this instance
mInstanceName = instanceName;
// compose self test plugin parameter property prefix
String pluginPath = PROP_PLUGIN + "." + instanceName;
mConfig = parameters.getSubStore(pluginPath);
if ((mConfig != null) &&
(mConfig.getName() != null) &&
(mConfig.getName() != "")) {
mPrefix = mConfig.getName().trim();
} else {
mSelfTestSubsystem.log(mSelfTestSubsystem.getSelfTestLogger(),
CMS.getLogMessage(
"SELFTESTS_PARAMETER_WAS_NULL",
SELF_TEST_NAME));
throw new EMissingSelfTestException();
}
return;
}
/**
* Notifies this subsystem if it is in execution mode.
* <P>
*
* @exception ESelfTestException failed to start
*/
public abstract void startupSelfTest()
throws ESelfTestException;
/**
* Stops this subsystem. The subsystem may call shutdownSelfTest
* anytime after initialization.
* <P>
*/
public abstract void shutdownSelfTest();
/**
* Returns the name associated with this self test. This method may
* return null if the self test has not been intialized.
* <P>
*
* @return instanceName of this self test
*/
public String getSelfTestName() {
return mInstanceName;
}
/**
* Returns the root configuration storage (self test parameters)
* associated with this subsystem.
* <P>
*
* @return configuration store (self test parameters) of this subsystem
*/
public IConfigStore getSelfTestConfigStore() {
return mConfig;
}
/**
* Retrieves description associated with an individual self test.
* This method may return null.
* <P>
*
* @param locale locale of the client that requests the description
* @return description of self test
*/
public abstract String getSelfTestDescription(Locale locale);
/**
* Execute an individual self test.
* <P>
*
* @param logger specifies logging subsystem
* @exception ESelfTestException self test exception
*/
public abstract void runSelfTest(ILogEventListener logger)
throws ESelfTestException;
}
|
