com.netscape.certsrv.base
Interface ISubsystem

All Known Subinterfaces:
IAuthority, IAuthSubsystem, IAuthzSubsystem, ICertAuthority, ICertificateAuthority, ICMSEngine, ICrossCertPairSubsystem, ICryptoSubsystem, IDBRegistry, IDBSubsystem, IDefStore, IJobsScheduler, IKeyRecoveryAuthority, ILogSubsystem, IOCSPAuthority, IOCSPStore, IPluginRegistry, IPolicyProcessor, IProfileSubsystem, IPublisherProcessor, IRegistrationAuthority, ISelfTestSubsystem, IStatsSubsystem, ITKSAuthority, IUGSubsystem, IXcertPublisherProcessor
All Known Implementing Classes:
ASubsystem, DefStore, LDAPStore

public interface ISubsystem

An interface represents a CMS subsystem. CMS is made up of a list subsystems. Each subsystem is responsible for a set of speciailized functions.

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

Method Summary
 IConfigStore getConfigStore()
          Returns the root configuration storage of this system.
 java.lang.String getId()
          Retrieves the name of this subsystem.
 void init(ISubsystem owner, IConfigStore config)
          Initializes this subsystem with the given configuration store.
 void setId(java.lang.String id)
          Sets specific to this subsystem.
 void shutdown()
          Stops this system.
 void startup()
          Notifies this subsystem if owner is in running mode.
 

Method Detail

getId

java.lang.String getId()
Retrieves the name of this subsystem.

Returns:
subsystem identifier

setId

void setId(java.lang.String id)
           throws EBaseException
Sets specific to this subsystem.

Parameters:
id - subsystem identifier
Throws:
EBaseException - failed to set id

init

void init(ISubsystem owner,
          IConfigStore config)
          throws EBaseException
Initializes this subsystem with the given configuration store.

Parameters:
owner - owner of this subsystem
config - configuration store
Throws:
EBaseException - failed to initialize

startup

void startup()
             throws EBaseException
Notifies this subsystem if owner is in running mode.

Throws:
EBaseException - failed to start up

shutdown

void shutdown()
Stops this system. The owner may call shutdown anytime after initialization.


getConfigStore

IConfigStore getConfigStore()
Returns the root configuration storage of this system.

Returns:
configuration store of this subsystem