Package com.netscape.certsrv.selftests
Interface ISelfTestSubsystem
-
- All Superinterfaces:
ISubsystem
- All Known Implementing Classes:
SelfTestSubsystem
public interface ISelfTestSubsystem extends ISubsystem
This class defines the interface of a container for self tests.- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ID
static java.lang.String
PROP_CONTAINER
static java.lang.String
PROP_INSTANCE
static java.lang.String
PROP_LOGGER
static java.lang.String
PROP_LOGGER_CLASS
static java.lang.String
PROP_ON_DEMAND
static java.lang.String
PROP_ORDER
static java.lang.String
PROP_STARTUP
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ISelfTest
getSelfTest(java.lang.String instanceName)
Retrieve an individual self test from the instances list given its instance name.ILogEventListener
getSelfTestLogger()
Returns the ILogEventListener of this subsystem.java.util.Collection<java.lang.String>
getSelfTestNames()
boolean
isSelfTestCriticalAtStartup(java.lang.String instanceName)
Determine if failure of the specified self test is fatal to server startup.boolean
isSelfTestCriticalOnDemand(java.lang.String instanceName)
Determine if failure of the specified self test is fatal when it is executed on demand.boolean
isSelfTestEnabledAtStartup(java.lang.String instanceName)
Determine if the specified self test is executed automatically at server startup.boolean
isSelfTestEnabledOnDemand(java.lang.String instanceName)
Determine if the specified self test is enabled to be executed on demand.java.lang.String[]
listSelfTestsEnabledAtStartup()
List the instance names of all the self tests enabled to run at server startup (in execution order); may return null.java.lang.String[]
listSelfTestsEnabledOnDemand()
List the instance names of all the self tests enabled to run on demand (in execution order); may return null.void
log(ILogEventListener logger, java.lang.String msg)
This method represents the log interface for the self test subsystem.void
runSelfTest(java.lang.String instanceName)
Execute a self test.void
runSelfTestsAtStartup()
Execute all self tests specified to be run at server startup.void
runSelfTestsOnDemand()
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 Detail
-
ID
static final java.lang.String ID
- See Also:
- Constant Field Values
-
PROP_CONTAINER
static final java.lang.String PROP_CONTAINER
- See Also:
- Constant Field Values
-
PROP_INSTANCE
static final java.lang.String PROP_INSTANCE
- See Also:
- Constant Field Values
-
PROP_LOGGER
static final java.lang.String PROP_LOGGER
- See Also:
- Constant Field Values
-
PROP_LOGGER_CLASS
static final java.lang.String PROP_LOGGER_CLASS
- See Also:
- Constant Field Values
-
PROP_ORDER
static final java.lang.String PROP_ORDER
- See Also:
- Constant Field Values
-
PROP_ON_DEMAND
static final java.lang.String PROP_ON_DEMAND
- See Also:
- Constant Field Values
-
PROP_STARTUP
static final java.lang.String PROP_STARTUP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSelfTestNames
java.util.Collection<java.lang.String> getSelfTestNames()
-
listSelfTestsEnabledOnDemand
java.lang.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
boolean isSelfTestEnabledOnDemand(java.lang.String instanceName) throws EMissingSelfTestException
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
boolean isSelfTestCriticalOnDemand(java.lang.String instanceName) throws EMissingSelfTestException
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
void runSelfTestsOnDemand() throws EMissingSelfTestException, ESelfTestException
Execute all self tests specified to be run on demand.- Throws:
EMissingSelfTestException
- subsystem has missing nameESelfTestException
- self test exception
-
runSelfTest
void runSelfTest(java.lang.String instanceName) throws java.lang.Exception
Execute a self test.- Throws:
java.lang.Exception
- self test exception
-
listSelfTestsEnabledAtStartup
java.lang.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
boolean isSelfTestEnabledAtStartup(java.lang.String instanceName) throws EMissingSelfTestException
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
boolean isSelfTestCriticalAtStartup(java.lang.String instanceName) throws EMissingSelfTestException
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
void runSelfTestsAtStartup() throws java.lang.Exception
Execute all self tests specified to be run at server startup.- Throws:
EMissingSelfTestException
- subsystem has missing namejava.lang.Exception
- self test exception
-
getSelfTest
ISelfTest getSelfTest(java.lang.String instanceName)
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
void log(ILogEventListener logger, java.lang.String msg)
This method represents the log interface for the self test subsystem.- Parameters:
logger
- log event listenermsg
- self test log message
-
-