ISubsystem (pki-javadoc)

All Known Subinterfaces:

IAuthority, ICertAuthority, ICertificateAuthority, ICrossCertPairSubsystem, IDBRegistry, IKeyRecoveryAuthority, ILogSubsystem, IOCSPAuthority, IRegistrationAuthority, ISelfTestSubsystem, IStatsSubsystem, ITKSAuthority

All Known Implementing Classes:

AbstractProfileSubsystem, AuthSubsystem, AuthzSubsystem, BaseSubsystem, CMSExtensionsMap, DBRegistry, DBSubsystem, JobsScheduler, LDAPProfileSubsystem, LogSubsystem, OidLoaderSubsystem, ProfileSubsystem, ProfileSubsystem, RequestSubsystem, 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IConfigStore`	`getConfigStore()`	Returns the root configuration storage of this system.
`java.lang.String`	`getId()`	Retrieves the name of this subsystem.
`void`	`init(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(IConfigStore config)
   throws EBaseException
```
    Initializes this subsystem with the given configuration store.
    
    Parameters:
    
    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