Class LogSubsystem

java.lang.Object
com.netscape.cmscore.logging.LogSubsystem
All Implemented Interfaces:
ISubsystem, ILogSubsystem
public class LogSubsystem extends Object implements ILogSubsystem
A class represents a log subsystem.

Version:
$Revision$, $Date$
Author:
thomask, mzhao

  • Field Details

  • Method Details

    • getId

      public String getId()
      Description copied from interface: ISubsystem
      Retrieves the name of this subsystem.
      Specified by:
      getId in interface ISubsystem
      Returns:
      subsystem identifier

    • setId

      public void setId(String id) throws EBaseException
      Description copied from interface: ISubsystem
      Sets specific to this subsystem.
      Specified by:
      setId in interface ISubsystem
      Parameters:
      id - subsystem identifier
      Throws:
      EBaseException - failed to set id

    • init

      public void init(IConfigStore config) throws EBaseException
      Initializes the log subsystem.

      Specified by:
      init in interface ISubsystem
      Parameters:
      config - configuration store
      Throws:
      EBaseException - failed to initialize

    • getAuditEvents

      public Collection<String> getAuditEvents()

    • startup

      public void startup() throws EBaseException
      Description copied from interface: ISubsystem
      Notifies this subsystem if owner is in running mode.
      Specified by:
      startup in interface ISubsystem
      Throws:
      EBaseException - failed to start up

    • shutdown

      public void shutdown()
      Stops this subsystem.

      Specified by:
      shutdown in interface ISubsystem

    • getConfigStore

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

      Specified by:
      getConfigStore in interface ISubsystem
      Returns:
      configuration store of this subsystem

    • getInstance

      public static LogSubsystem getInstance()
      Retrieves singleton: the LogSubsystem.

    • getLogPluginName

      public String getLogPluginName(ILogEventListener log)
      Description copied from interface: ILogSubsystem
      Retrieve plugin name (implementation name) of the log event listener. If no plug name found, an empty string is returned
      Specified by:
      getLogPluginName in interface ILogSubsystem
      Parameters:
      log - the log event listener
      Returns:
      the log event listener's plugin name

    • getLogInstance

      public ILogEventListener getLogInstance(String insName)
      Retrieve log instance by it's name
      Specified by:
      getLogInstance in interface ILogSubsystem
      Parameters:
      insName - the log instance name in String
      Returns:
      the log instance in ILogEventListener

    • getLogPlugins

      public Hashtable<String,LogPlugin> getLogPlugins()
      Description copied from interface: ILogSubsystem
      get the list of log plugins that are available
      Specified by:
      getLogPlugins in interface ILogSubsystem
      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,ILogEventListener> getLogInsts()
      Description copied from interface: ILogSubsystem
      get the list of log instances that are available
      Specified by:
      getLogInsts in interface ILogSubsystem
      Returns:
      log instances in a Hashtable. Each entry in the Hashtable contains the name/value pair of instName/ILogEventListener
      See Also:

    • getLogDefaultParams

      public Vector<String> getLogDefaultParams(String implName) throws ELogException
      Description copied from interface: ILogSubsystem
      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.
      Specified by:
      getLogDefaultParams in interface ILogSubsystem
      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
      Description copied from interface: ILogSubsystem
      Get the default configuration parameter names associated with a log instance. It is used by administration servlet to handle log instance configuration.
      Specified by:
      getLogInstanceParams in interface ILogSubsystem
      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