Package com.netscape.cms.selftests
Class ASelfTest
java.lang.Object
com.netscape.cms.selftests.ASelfTest
- All Implemented Interfaces:
ISelfTest
- Direct Known Subclasses:
SystemCertsVerification
This class implements an individual self test.
- Version:
- $Revision$, $Date$
- Author:
- mharmsen, thomask
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ConfigStore
protected String
protected String
protected ISelfTestSubsystem
Fields inherited from interface com.netscape.certsrv.selftests.ISelfTest
PROP_PLUGIN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the root configuration storage (self test parameters) associated with this subsystem.abstract String
getSelfTestDescription
(Locale locale) Retrieves description associated with an individual self test.Returns the name associated with this self test.void
initSelfTest
(ISelfTestSubsystem subsystem, String instanceName, ConfigStore parameters) Initializes this subsystem with the configuration store associated with this instance name.abstract void
runSelfTest
(ILogEventListener logger) Execute an individual self test.abstract void
Stops this subsystem.abstract void
Notifies this subsystem if it is in execution mode.
-
Field Details
-
mSelfTestSubsystem
-
mInstanceName
-
mConfig
-
mPrefix
-
-
Constructor Details
-
ASelfTest
public ASelfTest()
-
-
Method Details
-
initSelfTest
public void initSelfTest(ISelfTestSubsystem subsystem, String instanceName, ConfigStore parameters) throws EDuplicateSelfTestException, EInvalidSelfTestException, EMissingSelfTestException Initializes this subsystem with the configuration store associated with this instance name.- Specified by:
initSelfTest
in interfaceISelfTest
- Parameters:
subsystem
- the associated subsysteminstanceName
- the name of this self test instanceparameters
- configuration store (self test parameters)- Throws:
EDuplicateSelfTestException
- subsystem has duplicate name/valueEInvalidSelfTestException
- subsystem has invalid name/valueEMissingSelfTestException
- subsystem has missing name/value
-
startupSelfTest
Notifies this subsystem if it is in execution mode.- Specified by:
startupSelfTest
in interfaceISelfTest
- Throws:
ESelfTestException
- failed to start
-
shutdownSelfTest
public abstract void shutdownSelfTest()Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization.- Specified by:
shutdownSelfTest
in interfaceISelfTest
-
getSelfTestName
Returns the name associated with this self test. This method may return null if the self test has not been intialized.- Specified by:
getSelfTestName
in interfaceISelfTest
- Returns:
- instanceName of this self test
-
getSelfTestConfigStore
Returns the root configuration storage (self test parameters) associated with this subsystem.- Specified by:
getSelfTestConfigStore
in interfaceISelfTest
- Returns:
- configuration store (self test parameters) of this subsystem
-
getSelfTestDescription
Retrieves description associated with an individual self test. This method may return null.- Specified by:
getSelfTestDescription
in interfaceISelfTest
- Parameters:
locale
- locale of the client that requests the description- Returns:
- description of self test
-
runSelfTest
Execute an individual self test.- Specified by:
runSelfTest
in interfaceISelfTest
- Parameters:
logger
- specifies logging subsystem- Throws:
Exception
- self test exception
-