Package com.netscape.certsrv.selftests
Interface ISelfTestSubsystem
- All Superinterfaces:
ISubsystem
- All Known Implementing Classes:
SelfTestSubsystem
This class defines the interface of a container for self tests.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetSelfTest
(String instanceName) Retrieve an individual self test from the instances list given its instance name.Returns the ILogEventListener of this subsystem.boolean
isSelfTestCriticalAtStartup
(String instanceName) Determine if failure of the specified self test is fatal to server startup.boolean
isSelfTestCriticalOnDemand
(String instanceName) Determine if failure of the specified self test is fatal when it is executed on demand.boolean
isSelfTestEnabledAtStartup
(String instanceName) Determine if the specified self test is executed automatically at server startup.boolean
isSelfTestEnabledOnDemand
(String instanceName) Determine if the specified self test is enabled to be executed on demand.String[]
List the instance names of all the self tests enabled to run at server startup (in execution order); may return null.String[]
List the instance names of all the self tests enabled to run on demand (in execution order); may return null.void
log
(ILogEventListener logger, String msg) This method represents the log interface for the self test subsystem.void
runSelfTest
(String instanceName) Execute a self test.void
Execute all self tests specified to be run at server startup.void
Execute all self tests specified to be run on demand.Methods inherited from interface com.netscape.certsrv.base.ISubsystem
getConfigStore, getId, init, setId, shutdown, startup
-
Field Details
-
ID
- See Also:
-
PROP_CONTAINER
- See Also:
-
PROP_INSTANCE
- See Also:
-
PROP_LOGGER
- See Also:
-
PROP_LOGGER_CLASS
- See Also:
-
PROP_ORDER
- See Also:
-
PROP_ON_DEMAND
- See Also:
-
PROP_STARTUP
- See Also:
-
-
Method Details
-
getSelfTestNames
Collection<String> getSelfTestNames() -
listSelfTestsEnabledOnDemand
String[] listSelfTestsEnabledOnDemand()List the instance names of all the self tests enabled to run on demand (in execution order); may return null.- Returns:
- list of self test instance names run on demand
-
isSelfTestEnabledOnDemand
Determine if the specified self test is enabled to be executed on demand.- Parameters:
instanceName
- instance name of self test- Returns:
- true if the specified self test is enabled on demand
- Throws:
EMissingSelfTestException
- subsystem has missing name
-
isSelfTestCriticalOnDemand
Determine if failure of the specified self test is fatal when it is executed on demand.- Parameters:
instanceName
- instance name of self test- Returns:
- true if failure of the specified self test is fatal when it is executed on demand
- Throws:
EMissingSelfTestException
- subsystem has missing name
-
runSelfTestsOnDemand
Execute all self tests specified to be run on demand.- Throws:
EMissingSelfTestException
- subsystem has missing nameESelfTestException
- self test exception
-
runSelfTest
Execute a self test.- Throws:
Exception
- self test exception
-
listSelfTestsEnabledAtStartup
String[] listSelfTestsEnabledAtStartup()List the instance names of all the self tests enabled to run at server startup (in execution order); may return null.- Returns:
- list of self test instance names run at server startup
-
isSelfTestEnabledAtStartup
Determine if the specified self test is executed automatically at server startup.- Parameters:
instanceName
- instance name of self test- Returns:
- true if the specified self test is executed at server startup
- Throws:
EMissingSelfTestException
- subsystem has missing name
-
isSelfTestCriticalAtStartup
Determine if failure of the specified self test is fatal to server startup.- Parameters:
instanceName
- instance name of self test- Returns:
- true if failure of the specified self test is fatal to server startup
- Throws:
EMissingSelfTestException
- subsystem has missing name
-
runSelfTestsAtStartup
Execute all self tests specified to be run at server startup.- Throws:
EMissingSelfTestException
- subsystem has missing nameException
- self test exception
-
getSelfTest
Retrieve an individual self test from the instances list given its instance name.- Parameters:
instanceName
- instance name of self test- Returns:
- individual self test
-
getSelfTestLogger
ILogEventListener getSelfTestLogger()Returns the ILogEventListener of this subsystem. This method may return null.- Returns:
- ILogEventListener of this subsystem
-
log
This method represents the log interface for the self test subsystem.- Parameters:
logger
- log event listenermsg
- self test log message
-