Package com.netscape.certsrv.selftests
Interface ISelfTest
- All Known Implementing Classes:
ASelfTest
,SystemCertsVerification
public interface ISelfTest
This class defines the interface of an individual self test.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the root configuration storage (self test parameters) associated with this subsystem.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.void
runSelfTest
(ILogEventListener logger) Execute an individual self test.void
Stops this subsystem.void
Notifies this subsystem if it is in execution mode.
-
Field Details
-
PROP_PLUGIN
- See Also:
-
-
Method Details
-
initSelfTest
void initSelfTest(ISelfTestSubsystem 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
void shutdownSelfTest()Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization. -
getSelfTestName
String getSelfTestName()Returns the name associated with this self test. This method may return null if the self test has not been intialized.- Returns:
- instanceName of this self test
-
getSelfTestConfigStore
ConfigStore 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
-