Interface ISelfTest

  • All Known Implementing Classes:
    ASelfTest, SystemCertsVerification

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

    Version:
    $Revision$, $Date$
    • Method Detail

      • shutdownSelfTest

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

      • getSelfTestName

        java.lang.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

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

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

        java.lang.String getSelfTestDescription​(java.util.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 java.lang.Exception
        Execute an individual self test.

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