Interface ISubsystem

All Known Subinterfaces:
IAuthority, ICertificateAuthority, ICrossCertPairSubsystem, IKeyRecoveryAuthority, ILogSubsystem, IOCSPAuthority, ISelfTestSubsystem, IStatsSubsystem, ITKSAuthority
All Known Implementing Classes:
AuthSubsystem, AuthzSubsystem, BaseSubsystem, JobsScheduler, LogSubsystem, OidLoaderSubsystem, ProfileSubsystem, SelfTestSubsystem, StatsSubsystem, X500NameSubsystem

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$, $Date$
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the root configuration storage of this system.
    Retrieves the name of this subsystem.
    void
    init(ConfigStore config)
    Initializes this subsystem with the given configuration store.
    void
    Sets specific to this subsystem.
    void
    Stops this system.
    void
    Notifies this subsystem if owner is in running mode.
  • Method Details

    • getId

      String getId()
      Retrieves the name of this subsystem.
      Returns:
      subsystem identifier
    • setId

      void setId(String id) throws EBaseException
      Sets specific to this subsystem.
      Parameters:
      id - subsystem identifier
      Throws:
      EBaseException - failed to set id
    • init

      void init(ConfigStore config) throws Exception
      Initializes this subsystem with the given configuration store.

      Parameters:
      config - configuration store
      Throws:
      Exception - 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

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

      Returns:
      configuration store of this subsystem