Package com.netscape.cmscore.logging
Class LogSubsystem
java.lang.Object
com.netscape.cmscore.logging.LogSubsystem
- All Implemented Interfaces:
ISubsystem
,ILogSubsystem
A class represents a log subsystem.
- Version:
- $Revision$, $Date$
- Author:
- thomask, mzhao
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the root configuration storage of this system.getId()
Retrieves the name of this subsystem.static LogSubsystem
Retrieves singleton: the LogSubsystem.getLogDefaultParams
(String implName) Get the default configuration parameter names associated with a plugin.getLogInstance
(String insName) Retrieve log instance by it's namegetLogInstanceParams
(String insName) Get the default configuration parameter names associated with a log instance.get the list of log instances that are availableRetrieve plugin name (implementation name) of the log event listener.get the list of log plugins that are availablevoid
init
(ConfigStore config) Initializes the log subsystem.void
Sets specific to this subsystem.void
shutdown()
Stops this subsystem.void
startup()
Notifies this subsystem if owner is in running mode.
-
Field Details
-
logger
public static org.slf4j.Logger logger -
PROP_LOGGING
- See Also:
-
ID
- See Also:
-
PROP_CLASS
- See Also:
-
PROP_IMPL
- See Also:
-
PROP_PLUGIN
- See Also:
-
PROP_INSTANCE
- See Also:
-
mLogPlugins
-
mLogInsts
-
auditEvents
-
-
Method Details
-
getId
Description copied from interface:ISubsystem
Retrieves the name of this subsystem.- Specified by:
getId
in interfaceISubsystem
- Returns:
- subsystem identifier
-
setId
Description copied from interface:ISubsystem
Sets specific to this subsystem.- Specified by:
setId
in interfaceISubsystem
- Parameters:
id
- subsystem identifier- Throws:
EBaseException
- failed to set id
-
init
Initializes the log subsystem.- Specified by:
init
in interfaceISubsystem
- Parameters:
config
- configuration store- Throws:
EBaseException
-
getAuditEvents
-
startup
Description copied from interface:ISubsystem
Notifies this subsystem if owner is in running mode.- Specified by:
startup
in interfaceISubsystem
- Throws:
EBaseException
- failed to start up
-
shutdown
public void shutdown()Stops this subsystem.- Specified by:
shutdown
in interfaceISubsystem
-
getConfigStore
Returns the root configuration storage of this system.- Specified by:
getConfigStore
in interfaceISubsystem
- Returns:
- configuration store of this subsystem
-
getInstance
Retrieves singleton: the LogSubsystem. -
getLogPluginName
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 interfaceILogSubsystem
- Parameters:
log
- the log event listener- Returns:
- the log event listener's plugin name
-
getLogInstance
Retrieve log instance by it's name- Specified by:
getLogInstance
in interfaceILogSubsystem
- Parameters:
insName
- the log instance name in String- Returns:
- the log instance in ILogEventListener
-
getLogPlugins
Description copied from interface:ILogSubsystem
get the list of log plugins that are available- Specified by:
getLogPlugins
in interfaceILogSubsystem
- Returns:
- log plugins in a Hashtable. Each entry in the Hashtable contains the name/value pair of pluginName/LogPlugin
- See Also:
-
getLogInsts
Description copied from interface:ILogSubsystem
get the list of log instances that are available- Specified by:
getLogInsts
in interfaceILogSubsystem
- Returns:
- log instances in a Hashtable. Each entry in the Hashtable contains the name/value pair of instName/ILogEventListener
- See Also:
-
getLogDefaultParams
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 interfaceILogSubsystem
- 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
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 interfaceILogSubsystem
- 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
-