public abstract class ASelfTest extends java.lang.Object implements ISelfTest
Modifier and Type | Field and Description |
---|---|
protected IConfigStore |
mConfig |
protected java.lang.String |
mInstanceName |
protected java.lang.String |
mPrefix |
protected ISelfTestSubsystem |
mSelfTestSubsystem |
PROP_PLUGIN
Constructor and Description |
---|
ASelfTest() |
Modifier and Type | Method and 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.
|
protected ISelfTestSubsystem mSelfTestSubsystem
protected java.lang.String mInstanceName
protected IConfigStore mConfig
protected java.lang.String mPrefix
public void initSelfTest(ISelfTestSubsystem subsystem, java.lang.String instanceName, IConfigStore parameters) throws EDuplicateSelfTestException, EInvalidSelfTestException, EMissingSelfTestException
initSelfTest
in interface ISelfTest
subsystem
- the associated subsysteminstanceName
- the name of this self test instanceparameters
- configuration store (self test parameters)EDuplicateSelfTestException
- subsystem has duplicate name/valueEInvalidSelfTestException
- subsystem has invalid name/valueEMissingSelfTestException
- subsystem has missing name/valuepublic abstract void startupSelfTest() throws ESelfTestException
startupSelfTest
in interface ISelfTest
ESelfTestException
- failed to startpublic abstract void shutdownSelfTest()
shutdownSelfTest
in interface ISelfTest
public java.lang.String getSelfTestName()
getSelfTestName
in interface ISelfTest
public IConfigStore getSelfTestConfigStore()
getSelfTestConfigStore
in interface ISelfTest
public abstract java.lang.String getSelfTestDescription(java.util.Locale locale)
getSelfTestDescription
in interface ISelfTest
locale
- locale of the client that requests the descriptionpublic abstract void runSelfTest(ILogEventListener logger) throws ESelfTestException
runSelfTest
in interface ISelfTest
logger
- specifies logging subsystemESelfTestException
- self test exception