Package com.netscape.cmscore.logging
Class LogSubsystem
- java.lang.Object
-
- com.netscape.cmscore.logging.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 Summary
Fields Modifier and Type Field Description java.util.Set<java.lang.String>
auditEvents
static java.lang.String
ID
static org.slf4j.Logger
logger
java.util.Hashtable<java.lang.String,ILogEventListener>
mLogInsts
java.util.Hashtable<java.lang.String,LogPlugin>
mLogPlugins
static java.lang.String
PROP_CLASS
static java.lang.String
PROP_IMPL
static java.lang.String
PROP_INSTANCE
static java.lang.String
PROP_LOGGING
static java.lang.String
PROP_PLUGIN
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Collection<java.lang.String>
getAuditEvents()
IConfigStore
getConfigStore()
Returns the root configuration storage of this system.java.lang.String
getId()
Retrieves the name of this subsystem.static LogSubsystem
getInstance()
Retrieves singleton: the LogSubsystem.java.util.Vector<java.lang.String>
getLogDefaultParams(java.lang.String implName)
Get the default configuration parameter names associated with a plugin.ILogEventListener
getLogInstance(java.lang.String insName)
Retrieve log instance by it's namejava.util.Vector<java.lang.String>
getLogInstanceParams(java.lang.String insName)
Get the default configuration parameter names associated with a log instance.java.util.Hashtable<java.lang.String,ILogEventListener>
getLogInsts()
get the list of log instances that are availablejava.lang.String
getLogPluginName(ILogEventListener log)
Retrieve plugin name (implementation name) of the log event listener.java.util.Hashtable<java.lang.String,LogPlugin>
getLogPlugins()
get the list of log plugins that are availablevoid
init(IConfigStore config)
Initializes the log subsystem.void
setId(java.lang.String id)
Sets specific to this subsystem.void
shutdown()
Stops this subsystem.void
startup()
Notifies this subsystem if owner is in running mode.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
PROP_LOGGING
public static final java.lang.String PROP_LOGGING
- See Also:
- Constant Field Values
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
PROP_CLASS
public static final java.lang.String PROP_CLASS
- See Also:
- Constant Field Values
-
PROP_IMPL
public static final java.lang.String PROP_IMPL
- See Also:
- Constant Field Values
-
PROP_PLUGIN
public static final java.lang.String PROP_PLUGIN
- See Also:
- Constant Field Values
-
PROP_INSTANCE
public static final java.lang.String PROP_INSTANCE
- See Also:
- Constant Field Values
-
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 interfaceISubsystem
- 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 interfaceISubsystem
- 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 interfaceISubsystem
- Parameters:
config
- configuration store- Throws:
EBaseException
- failed to initialize
-
getAuditEvents
public java.util.Collection<java.lang.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 interfaceISubsystem
- Throws:
EBaseException
- failed to start up
-
shutdown
public void shutdown()
Stops this subsystem.- Specified by:
shutdown
in interfaceISubsystem
-
getConfigStore
public IConfigStore getConfigStore()
Returns the root configuration storage of this system.- Specified by:
getConfigStore
in interfaceISubsystem
- 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 interfaceILogSubsystem
- 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 interfaceILogSubsystem
- 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 interfaceILogSubsystem
- 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 interfaceILogSubsystem
- 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 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
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 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
-
-