com.netscape.cms.selftests
Class ASelfTest

java.lang.Object
  com.netscape.cms.selftests.ASelfTest

All Implemented Interfaces:

ISelfTest

Direct Known Subclasses:

CAPresence, CAValidity, KRAPresence, OCSPPresence, OCSPValidity, RAPresence, SystemCertsVerification, TKSKnownSessionKey

public abstract class ASelfTest
extends java.lang.Object
implements ISelfTest

This class implements an individual self test.

Version:

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

Author:

mharmsen, thomask

Field Summary

protected IConfigStore	mConfig
protected java.lang.String	mInstanceName
protected java.lang.String	mPrefix
protected ISelfTestSubsystem	mSelfTestSubsystem

Fields inherited from interface com.netscape.certsrv.selftests.ISelfTest

PROP_PLUGIN

Constructor Summary

ASelfTest()

Method Summary

IConfigStore	getSelfTestConfigStore() Returns the root configuration storage (self test parameters) associated with this subsystem.
abstract 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.
abstract void	runSelfTest(ILogEventListener logger) Execute an individual self test.
abstract void	shutdownSelfTest() Stops this subsystem.
abstract 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

mSelfTestSubsystem

protected ISelfTestSubsystem mSelfTestSubsystem

mInstanceName

protected java.lang.String mInstanceName

mConfig

protected IConfigStore mConfig

mPrefix

protected java.lang.String mPrefix

Constructor Detail

ASelfTest

public ASelfTest()

Method Detail

initSelfTest

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

Specified by:

initSelfTest in interface ISelfTest

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

public abstract void startupSelfTest()
                              throws ESelfTestException

Notifies this subsystem if it is in execution mode.

Specified by:

startupSelfTest in interface ISelfTest

Throws:

ESelfTestException - failed to start

shutdownSelfTest

public abstract void shutdownSelfTest()

Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization.

Specified by:

shutdownSelfTest in interface ISelfTest

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 ISelfTest

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 ISelfTest

Returns:

configuration store (self test parameters) of this subsystem

getSelfTestDescription

public abstract 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 ISelfTest

Parameters:

locale - locale of the client that requests the description

Returns:

description of self test

runSelfTest

public abstract void runSelfTest(ILogEventListener logger)
                          throws ESelfTestException

Execute an individual self test.

Specified by:

runSelfTest in interface ISelfTest

Parameters:

logger - specifies logging subsystem

Throws:

ESelfTestException - self test exception