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 Details

  • 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

      boolean isSelfTestEnabledOnDemand(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(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 name
      ESelfTestException - self test exception
    • runSelfTest

      void runSelfTest(String instanceName) throws Exception
      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

      boolean isSelfTestEnabledAtStartup(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(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 Exception
      Execute all self tests specified to be run at server startup.

      Throws:
      EMissingSelfTestException - subsystem has missing name
      Exception - self test exception
    • getSelfTest

      ISelfTest getSelfTest(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, String msg)
      This method represents the log interface for the self test subsystem.

      Parameters:
      logger - log event listener
      msg - self test log message