Interface ISelfTest

All Known Implementing Classes:
ASelfTest, SystemCertsVerification

public interface ISelfTest
This class defines the interface of an individual self test.

Version:
$Revision$, $Date$
  • Field Details

  • Method Details

    • initSelfTest

      Initializes this subsystem with the configuration store associated with this instance name.

      Parameters:
      subsystem - the associated subsystem
      instanceName - the name of this self test instance
      parameters - configuration store (self test parameters)
      Throws:
      EDuplicateSelfTestException - subsystem has duplicate name/value
      EInvalidSelfTestException - subsystem has invalid name/value
      EMissingSelfTestException - subsystem has missing name/value
    • startupSelfTest

      void startupSelfTest() throws ESelfTestException
      Notifies this subsystem if it is in execution mode.

      Throws:
      ESelfTestException - failed to start
    • shutdownSelfTest

      void shutdownSelfTest()
      Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization.

    • getSelfTestName

      String getSelfTestName()
      Returns the name associated with this self test. This method may return null if the self test has not been intialized.

      Returns:
      instanceName of this self test
    • getSelfTestConfigStore

      ConfigStore getSelfTestConfigStore()
      Returns the root configuration storage (self test parameters) associated with this subsystem.

      Returns:
      configuration store (self test parameters) of this subsystem
    • getSelfTestDescription

      String getSelfTestDescription(Locale locale)
      Retrieves description associated with an individual self test. This method may return null.

      Parameters:
      locale - locale of the client that requests the description
      Returns:
      description of self test
    • runSelfTest

      void runSelfTest(ILogEventListener logger) throws Exception
      Execute an individual self test.

      Parameters:
      logger - specifies logging subsystem
      Throws:
      Exception - self test exception