Class LogSubsystem

java.lang.Object
com.netscape.certsrv.base.Subsystem
com.netscape.cmscore.logging.LogSubsystem
public class LogSubsystem extends Subsystem
A class representing a log subsystem. The logging component is a framework that handles different types of log types, each represented by an LogFile, and each implements a log plugin. CMS comes with three standard log types: "signedAudit", "system", and "transaction". Each log plugin can be instantiated into log instances. Each log instance can be individually configured and is associated with its own configuration entries in the configuration file.
Author:
thomask, mzhao

  • Field Details

  • Constructor Details

    • LogSubsystem

      public LogSubsystem()

  • Method Details

    • getId

      public String getId()
      Description copied from class: Subsystem
      Retrieves the subsystem identifier.
      Overrides:
      getId in class Subsystem
      Returns:
      subsystem identifier

    • setId

      public void setId(String id) throws EBaseException
      Description copied from class: Subsystem
      Sets the identifier of this subsystem.
      Overrides:
      setId in class Subsystem
      Parameters:
      id - subsystem identifier
      Throws:
      EBaseException - failed to set id

    • init

      public void init(ConfigStore config) throws Exception
      Initializes the log subsystem.
      Overrides:
      init in class Subsystem
      Parameters:
      config - Subsystem configuration
      Throws:
      Exception - Unable to initialize subsystem

    • getAuditEvents

      public Collection<String> getAuditEvents()

    • startup

      public void startup() throws EBaseException
      Description copied from class: Subsystem
      Notifies this subsystem if owner is in running mode.
      Overrides:
      startup in class Subsystem
      Throws:
      EBaseException - failed to start up

    • shutdown

      public void shutdown()
      Stops this subsystem.

      Overrides:
      shutdown in class Subsystem

    • getConfigStore

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

      Overrides:
      getConfigStore in class Subsystem
      Returns:
      configuration store of this subsystem

    • getLogPluginName

      public String getLogPluginName(LogEventListener log)
      Retrieve plugin name (implementation name) of the log event listener. If no plug name found, an empty string is returned
      Parameters:
      log - the log event listener
      Returns:
      the log event listener's plugin name

    • getLogInstance

      public LogEventListener getLogInstance(String insName)
      Retrieve the log event listener by instance name
      Parameters:
      insName - the log instance name in String
      Returns:
      the log instance in LogEventListener

    • getLogPlugins

      public Hashtable<String, LogPlugin> getLogPlugins()
      get the list of log plugins that are available
      Returns:
      log plugins in a Hashtable. Each entry in the Hashtable contains the name/value pair of pluginName/LogPlugin
      See Also:

    • getLogInsts

      public Hashtable<String, LogEventListener> getLogInsts()
      get the list of log instances that are available
      Returns:
      log instances in a Hashtable. Each entry in the Hashtable contains the name/value pair of instName/LogEventListener
      See Also:

    • getLogDefaultParams

      public Vector<String> getLogDefaultParams(String implName) throws ELogException
      Get the default configuration parameter names associated with a plugin. It is used by administration servlet to handle log configuration when a new log instance is added.
      Parameters:
      implName - The implementation name for which the configuration parameters are to be configured
      Returns:
      a Vector of default configuration paramter names associated with this log plugin
      Throws:
      ELogException - when instantiation of the plugin implementation fails.

    • getLogInstanceParams

      public Vector<String> getLogInstanceParams(String insName) throws ELogException
      Get the default configuration parameter names associated with a log instance. It is used by administration servlet to handle log instance configuration.
      Parameters:
      insName - The instance name for which the configuration parameters are to be configured
      Returns:
      a Vector of default configuration paramter names associated with this log instance.
      Throws:
      ELogException