diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java index f18880951..438c42508 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java @@ -17,19 +17,22 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.util.Hashtable; import java.util.Vector; import com.netscape.certsrv.base.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. + * 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. * <P> * * @version $Revision$, $Date$ @@ -42,17 +45,15 @@ public interface ILogSubsystem extends ISubsystem { public static final String ID = "log"; /** - * Retrieve plugin name (implementation name) of the log event listener. If - * no plug name found, an empty string is returned - * + * Retrieve plugin name (implementation name) of the log event + * listener. If no plug name found, an empty string is returned * @param log the log event listener * @return the log event listener's plugin name - */ + */ public String getLogPluginName(ILogEventListener log); /** * Retrieve the log event listener by instance name - * * @param insName the log instance name in String * @return the log instance in ILogEventListener */ @@ -60,45 +61,44 @@ public interface ILogSubsystem extends ISubsystem { /** * get the list of log plugins that are available - * - * @return log plugins in a Hashtable. Each entry in the Hashtable contains - * the name/value pair of pluginName/LogPlugin + * @return log plugins in a Hashtable. Each entry in the + * Hashtable contains the name/value pair of pluginName/LogPlugin * @see LogPlugin */ public Hashtable getLogPlugins(); /** * get the list of log instances that are available - * - * @return log instances in a Hashtable. Each entry in the Hashtable - * contains the name/value pair of instName/ILogEventListener + * @return log instances in a Hashtable. Each entry in the + * Hashtable contains the name/value pair of instName/ILogEventListener * @see LogPlugin */ public Hashtable getLogInsts(); /** - * 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. - * - * @param implName The implementation name for which the configuration - * parameters are to be configured - * @return a Vector of default configuration paramter names associated with - * this log plugin - * @exception ELogException when instantiation of the plugin implementation - * fails. + * 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. + * @param implName The implementation name for which the + * configuration parameters are to be configured + * @return a Vector of default configuration paramter names + * associated with this log plugin + * @exception ELogException when instantiation of the plugin + * implementation fails. */ - public Vector getLogDefaultParams(String implName) throws ELogException; + public Vector getLogDefaultParams(String implName) throws + ELogException; /** - * Get the default configuration parameter names associated with a log - * instance. It is used by administration servlet to handle log instance - * configuration. - * - * @param insName The instance name for which the configuration parameters - * are to be configured - * @return a Vector of default configuration paramter names associated with - * this log instance. + * Get the default configuration parameter names associated with a + * log instance. It is used by administration servlet to handle + * log instance configuration. + * @param insName The instance name for which the configuration + * parameters are to be configured + * @return a Vector of default configuration paramter names + * associated with this log instance. */ - public Vector getLogInstanceParams(String insName) throws ELogException; + public Vector getLogInstanceParams(String insName) + throws ELogException; } |