Package com.netscape.cmscore.logging

Class LogSubsystem

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

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

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

      • mLogPlugins

        public java.util.Hashtable<java.lang.String,​LogPlugin> mLogPlugins

      • mLogInsts

        public java.util.Hashtable<java.lang.String,​ILogEventListener> mLogInsts

      • auditEvents

        public java.util.Set<java.lang.String> auditEvents

    • Method Detail

      • getId

        public java.lang.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​(java.lang.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

      • getAuditEvents

        public java.util.Collection<java.lang.String> getAuditEvents()

      • 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 java.lang.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​(java.lang.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 java.util.Hashtable<java.lang.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:
        LogPlugin

      • getLogInsts

        public java.util.Hashtable<java.lang.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:
        LogPlugin

      • getLogDefaultParams

        public java.util.Vector<java.lang.String> getLogDefaultParams​(java.lang.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 java.util.Vector<java.lang.String> getLogInstanceParams​(java.lang.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