Package com.netscape.cms.selftests
Class SelfTest
java.lang.Object
com.netscape.cms.selftests.SelfTest
- Direct Known Subclasses:
SystemCertsVerification
This class implements an individual self test.
- Author:
- mharmsen, thomask
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CMSEngine
protected SelfTestPluginConfig
protected String
protected String
protected SelfTestSubsystem
static final String
-
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
(SelfTestSubsystem subsystem, String instanceName, ConfigStore parameters) Initializes this subsystem with the configuration store associated with this instance name.abstract void
runSelfTest
(LogEventListener logger) Execute an individual self test.void
setCMSEngine
(CMSEngine engine) abstract void
Stops this subsystem.abstract void
Notifies this subsystem if it is in execution mode.
-
Field Details
-
PROP_PLUGIN
- See Also:
-
engine
-
mSelfTestSubsystem
-
mInstanceName
-
mConfig
-
mPrefix
-
-
Constructor Details
-
SelfTest
public SelfTest()
-
-
Method Details
-
getCMSEngine
-
setCMSEngine
-
initSelfTest
public void initSelfTest(SelfTestSubsystem subsystem, String instanceName, ConfigStore parameters) throws EDuplicateSelfTestException, EInvalidSelfTestException, EMissingSelfTestException Initializes this subsystem with the configuration store associated with this instance name.- 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.- Throws:
ESelfTestException
- failed to start
-
shutdownSelfTest
public abstract void shutdownSelfTest()Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization. -
getSelfTestName
Returns the name associated with this self test. This method may return null if the self test has not been initialized.- Returns:
- instanceName of this self test
-
getSelfTestConfigStore
Returns the root configuration storage (self test parameters) associated with this subsystem.- Returns:
- configuration store (self test parameters) of this subsystem
-
getSelfTestDescription
Retrieves description associated with an individual self test. This method may return null.- Parameters:
locale
- locale of the client that requests the description- Returns:
- description of self test
-
runSelfTest
Execute an individual self test.- Parameters:
logger
- specifies logging subsystem- Throws:
Exception
- self test exception
-