Interface ILogSubsystem

  • All Superinterfaces:
    ISubsystem
    All Known Implementing Classes:
    LogSubsystem

    public interface ILogSubsystem
    extends ISubsystem
    An interface that represents a logging component. The logging component is a framework that handles different types of log types, each represented by an ILogEventListener, 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.

    Version:
    $Revision$, $Date$
    • Method Detail

      • getLogPluginName

        java.lang.String getLogPluginName​(ILogEventListener 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

        ILogEventListener getLogInstance​(java.lang.String insName)
        Retrieve the log event listener by instance name
        Parameters:
        insName - the log instance name in String
        Returns:
        the log instance in ILogEventListener
      • getLogPlugins

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

        java.util.Hashtable<java.lang.String,​ILogEventListener> 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/ILogEventListener
        See Also:
        LogPlugin
      • getLogDefaultParams

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

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