com.netscape.certsrv.selftests
Interface ISelfTest

All Known Implementing Classes:
ASelfTest, CAPresence, CAValidity, KRAPresence, OCSPPresence, OCSPValidity, RAPresence, SystemCertsVerification, TKSKnownSessionKey

public interface ISelfTest

This class defines the interface of an individual self test.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String PROP_PLUGIN
           
 
Method Summary
 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(ISelfTestSubsystem subsystem, java.lang.String instanceName, IConfigStore parameters)
          Initializes this subsystem with the configuration store associated with this instance name.
 void runSelfTest(ILogEventListener logger)
          Execute an individual self test.
 void shutdownSelfTest()
          Stops this subsystem.
 void startupSelfTest()
          Notifies this subsystem if it is in execution mode.
 

Field Detail

PROP_PLUGIN

static final java.lang.String PROP_PLUGIN
See Also:
Constant Field Values
Method Detail

initSelfTest

void initSelfTest(ISelfTestSubsystem subsystem,
                  java.lang.String instanceName,
                  IConfigStore parameters)
                  throws EDuplicateSelfTestException,
                         EInvalidSelfTestException,
                         EMissingSelfTestException
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

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 ESelfTestException
Execute an individual self test.

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