Class KRAPresence

  • All Implemented Interfaces:
    com.netscape.certsrv.selftests.ISelfTest

    public class KRAPresence
    extends ASelfTest
    This class implements a self test to check for KRA presence.

    Version:
    $Revision$, $Date$
    Author:
    mharmsen, thomask
    • Constructor Summary

      Constructors 
      Constructor Description
      KRAPresence()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IConfigStore getSelfTestConfigStore()
      Returns the root configuration storage (self test parameters) associated with this subsystem.
      java.lang.String getSelfTestDescription​(java.util.Locale locale)
      Retrieves description associated with an individual self test.
      java.lang.String getSelfTestName()
      Returns the name associated with this self test.
      void initSelfTest​(com.netscape.certsrv.selftests.ISelfTestSubsystem subsystem, java.lang.String instanceName, IConfigStore parameters)
      Initializes this subsystem with the configuration store associated with this instance name.
      void runSelfTest​(com.netscape.certsrv.logging.ILogEventListener logger)
      Execute an individual self test.
      void shutdownSelfTest()
      Stops this subsystem.
      void startupSelfTest()
      Notifies this subsystem if it is in execution mode.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

    • Constructor Detail

      • KRAPresence

        public KRAPresence()
    • Method Detail

      • initSelfTest

        public void initSelfTest​(com.netscape.certsrv.selftests.ISelfTestSubsystem subsystem,
                                 java.lang.String instanceName,
                                 IConfigStore parameters)
                          throws com.netscape.certsrv.selftests.EDuplicateSelfTestException,
                                 com.netscape.certsrv.selftests.EInvalidSelfTestException,
                                 com.netscape.certsrv.selftests.EMissingSelfTestException
        Initializes this subsystem with the configuration store associated with this instance name.

        Specified by:
        initSelfTest in interface com.netscape.certsrv.selftests.ISelfTest
        Overrides:
        initSelfTest in class ASelfTest
        Parameters:
        subsystem - the associated subsystem
        instanceName - the name of this self test instance
        parameters - configuration store (self test parameters)
        Throws:
        com.netscape.certsrv.selftests.EDuplicateSelfTestException - subsystem has duplicate name/value
        com.netscape.certsrv.selftests.EInvalidSelfTestException - subsystem has invalid name/value
        com.netscape.certsrv.selftests.EMissingSelfTestException - subsystem has missing name/value
      • startupSelfTest

        public void startupSelfTest()
                             throws com.netscape.certsrv.selftests.ESelfTestException
        Notifies this subsystem if it is in execution mode.

        Specified by:
        startupSelfTest in interface com.netscape.certsrv.selftests.ISelfTest
        Specified by:
        startupSelfTest in class ASelfTest
        Throws:
        com.netscape.certsrv.selftests.ESelfTestException - failed to start
      • shutdownSelfTest

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

        Specified by:
        shutdownSelfTest in interface com.netscape.certsrv.selftests.ISelfTest
        Specified by:
        shutdownSelfTest in class ASelfTest
      • getSelfTestName

        public 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.

        Specified by:
        getSelfTestName in interface com.netscape.certsrv.selftests.ISelfTest
        Overrides:
        getSelfTestName in class ASelfTest
        Returns:
        instanceName of this self test
      • getSelfTestConfigStore

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

        Specified by:
        getSelfTestConfigStore in interface com.netscape.certsrv.selftests.ISelfTest
        Overrides:
        getSelfTestConfigStore in class ASelfTest
        Returns:
        configuration store (self test parameters) of this subsystem
      • getSelfTestDescription

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

        Specified by:
        getSelfTestDescription in interface com.netscape.certsrv.selftests.ISelfTest
        Specified by:
        getSelfTestDescription in class ASelfTest
        Parameters:
        locale - locale of the client that requests the description
        Returns:
        description of self test
      • runSelfTest

        public void runSelfTest​(com.netscape.certsrv.logging.ILogEventListener logger)
                         throws java.lang.Exception
        Execute an individual self test.

        Specified by:
        runSelfTest in interface com.netscape.certsrv.selftests.ISelfTest
        Specified by:
        runSelfTest in class ASelfTest
        Parameters:
        logger - specifies logging subsystem
        Throws:
        java.lang.Exception - self test exception