Package com.netscape.cms.selftests
Class ASelfTest
- java.lang.Object
-
- com.netscape.cms.selftests.ASelfTest
-
- All Implemented Interfaces:
ISelfTest
- Direct Known Subclasses:
CAPresence
,CAValidity
,KRAPresence
,SystemCertsVerification
public abstract class ASelfTest extends java.lang.Object implements ISelfTest
This class implements an individual self test.- Version:
- $Revision$, $Date$
- Author:
- mharmsen, thomask
-
-
Field Summary
Fields Modifier and Type Field Description protected IConfigStore
mConfig
protected java.lang.String
mInstanceName
protected java.lang.String
mPrefix
protected ISelfTestSubsystem
mSelfTestSubsystem
-
Fields inherited from interface com.netscape.certsrv.selftests.ISelfTest
PROP_PLUGIN
-
-
Constructor Summary
Constructors Constructor Description ASelfTest()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description IConfigStore
getSelfTestConfigStore()
Returns the root configuration storage (self test parameters) associated with this subsystem.abstract java.lang.String
getSelfTestDescription(java.util.Locale locale)
Retrieves description associated with an individual self test.java.lang.String
getSelfTestName()
Returns the name associated with this self test.void
initSelfTest(ISelfTestSubsystem subsystem, java.lang.String instanceName, IConfigStore 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
shutdownSelfTest()
Stops this subsystem.abstract void
startupSelfTest()
Notifies this subsystem if it is in execution mode.
-
-
-
Field Detail
-
mSelfTestSubsystem
protected ISelfTestSubsystem mSelfTestSubsystem
-
mInstanceName
protected java.lang.String mInstanceName
-
mConfig
protected IConfigStore mConfig
-
mPrefix
protected java.lang.String mPrefix
-
-
Method Detail
-
initSelfTest
public void initSelfTest(ISelfTestSubsystem subsystem, java.lang.String instanceName, IConfigStore 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
public abstract void startupSelfTest() throws ESelfTestException
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
public java.lang.String 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
public IConfigStore 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
public abstract java.lang.String getSelfTestDescription(java.util.Locale locale)
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
public abstract void runSelfTest(ILogEventListener logger) throws java.lang.Exception
Execute an individual self test.- Specified by:
runSelfTest
in interfaceISelfTest
- Parameters:
logger
- specifies logging subsystem- Throws:
java.lang.Exception
- self test exception
-
-