From 7c7b9d023cd466c1771068badc020dab36beb553 Mon Sep 17 00:00:00 2001 From: Endi Sukma Dewata Date: Thu, 5 Apr 2012 14:49:11 -0500 Subject: Removed whitespaces from Java code. Whitespaces in Java code have been removed with the following command: find . -not -path .git -name *.java -exec sed -i 's/[[:blank:]]\+$//' {} \; Ticket #134 --- .../com/netscape/certsrv/logging/AuditEvent.java | 52 ++++++++++----------- .../com/netscape/certsrv/logging/AuditFormat.java | 2 +- .../com/netscape/certsrv/logging/ConsoleError.java | 4 +- .../com/netscape/certsrv/logging/ConsoleLog.java | 10 ++-- .../netscape/certsrv/logging/ELogException.java | 22 ++++----- .../com/netscape/certsrv/logging/ELogNotFound.java | 4 +- .../certsrv/logging/ELogPluginNotFound.java | 4 +- .../netscape/certsrv/logging/IBundleLogEvent.java | 4 +- .../com/netscape/certsrv/logging/ILogEvent.java | 20 ++++---- .../netscape/certsrv/logging/ILogEventFactory.java | 6 +-- .../certsrv/logging/ILogEventListener.java | 20 ++++---- .../com/netscape/certsrv/logging/ILogQueue.java | 10 ++-- .../netscape/certsrv/logging/ILogSubsystem.java | 14 +++--- .../src/com/netscape/certsrv/logging/ILogger.java | 36 +++++++-------- .../com/netscape/certsrv/logging/LogPlugin.java | 2 +- .../com/netscape/certsrv/logging/LogResources.java | 6 +-- .../netscape/certsrv/logging/SignedAuditEvent.java | 54 +++++++++++----------- .../com/netscape/certsrv/logging/SystemEvent.java | 52 ++++++++++----------- 18 files changed, 161 insertions(+), 161 deletions(-) (limited to 'base/common/src/com/netscape/certsrv/logging') diff --git a/base/common/src/com/netscape/certsrv/logging/AuditEvent.java b/base/common/src/com/netscape/certsrv/logging/AuditEvent.java index aa0077b06..8ae5cd669 100644 --- a/base/common/src/com/netscape/certsrv/logging/AuditEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/AuditEvent.java @@ -28,7 +28,7 @@ import com.netscape.certsrv.base.MessageFormatter; * that goes into the Transaction log. Note that the name of this * class "AuditEvent" is legacy and has nothing to do with the signed * audit log events, whcih are represented by SignedAuditEvent. - * + * * @version $Revision$, $Date$ * @see java.text.MessageFormat * @see com.netscape.certsrv.logging.LogResources @@ -59,7 +59,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Constructs a message event *

- * + * * @param msgFormat the message string */ public AuditEvent(String msgFormat) { @@ -69,12 +69,12 @@ public class AuditEvent implements IBundleLogEvent { /** * Constructs a message with a parameter. For example, - * + * * 

      * new AuditEvent("failed to load {0}", fileName);
      *
*

- * + * * @param msgFormat details in message string format * @param param message string parameter */ @@ -88,7 +88,7 @@ public class AuditEvent implements IBundleLogEvent { * Constructs a message from an exception. It can be used to carry * a system exception that may contain information about * the context. For example, - * + * * 

      *         try {
      *          ...
@@ -97,7 +97,7 @@ public class AuditEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param msgFormat exception details in message string format * @param exception system exception */ @@ -110,7 +110,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Constructs a message from a base exception. This will use the msgFormat * from the exception itself. - * + * * 

      *         try {
      *          ...
@@ -119,7 +119,7 @@ public class AuditEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param e CMS exception */ public AuditEvent(Exception e) { @@ -136,7 +136,7 @@ public class AuditEvent implements IBundleLogEvent { * Constructs a message event with a list of parameters * that will be substituted into the message format. *

- * + * * @param msgFormat message string format * @param params list of message format parameters */ @@ -148,7 +148,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the current message format string. *

- * + * * @return details message */ public String getMessage() { @@ -158,7 +158,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns a list of parameters. *

- * + * * @return list of message format parameters */ public Object[] getParameters() { @@ -169,7 +169,7 @@ public class AuditEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. *

- * + * * @return details message */ public String toContent() { @@ -179,7 +179,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. *

- * + * * @param locale locale * @return details message */ @@ -192,7 +192,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Gets the resource bundle name for this class instance. This should * be overridden by subclasses who have their own resource bundles. - * + * * @param bundle String that represents the resource bundle name to be set */ public void setBundleName(String bundle) { @@ -201,7 +201,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * + * * @return a String that represents the resource bundle name */ protected String getBundleName() { @@ -210,7 +210,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log source. - * + * * @return an integer that indicates the component source * where this message event was triggered */ @@ -220,7 +220,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Sets log source. - * + * * @param source an integer that represents the component source * where this message event was triggered */ @@ -232,7 +232,7 @@ public class AuditEvent implements IBundleLogEvent { * Retrieves log level. * The log level of an event represents its relative importance * or severity within CMS. - * + * * @return Integer log level value. */ public int getLevel() { @@ -241,7 +241,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. - * + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -252,7 +252,7 @@ public class AuditEvent implements IBundleLogEvent { * Sets log level, NT log event type. * For certain log levels the NT log event type gets * set as well. - * + * * @param level Integer log level value. */ public void setLevel(int level) { @@ -283,7 +283,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log multiline attribute. - * + * * @return Boolean whether or not this event is multiline. * A multiline message simply consists of more than one line. */ @@ -294,7 +294,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Sets log multiline attribute. A multiline message consists of * more than one line. - * + * * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { @@ -303,7 +303,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves event time stamp. - * + * * @return Long integer of the time the event was created. */ public long getTimeStamp() { @@ -313,7 +313,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log event type. Each type of event * has an associated String type value. - * + * * @return String containing the type of event. */ public String getEventType() { @@ -323,7 +323,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Sets log event type. Each type of event * has an associated String type value. - * + * * @param eventType String containing the type of event. */ public void setEventType(String eventType) { @@ -332,7 +332,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Return string representation of log message. - * + * * @return String containing log message. */ public String toString() { diff --git a/base/common/src/com/netscape/certsrv/logging/AuditFormat.java b/base/common/src/com/netscape/certsrv/logging/AuditFormat.java index e5f8726f7..72980aa5a 100644 --- a/base/common/src/com/netscape/certsrv/logging/AuditFormat.java +++ b/base/common/src/com/netscape/certsrv/logging/AuditFormat.java @@ -21,7 +21,7 @@ package com.netscape.certsrv.logging; * Define audit log message format. Note that the name of this * class "AuditFormat" is legacy and has nothing to do with the signed * audit log events format - * + * * @version $Revision$, $Date$ */ public class AuditFormat { diff --git a/base/common/src/com/netscape/certsrv/logging/ConsoleError.java b/base/common/src/com/netscape/certsrv/logging/ConsoleError.java index 13e0f3d45..c12887628 100644 --- a/base/common/src/com/netscape/certsrv/logging/ConsoleError.java +++ b/base/common/src/com/netscape/certsrv/logging/ConsoleError.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.logging; /** * A static class to log error messages to the Console - * + * * @version $Revision$, $Date$ */ public class ConsoleError { @@ -27,7 +27,7 @@ public class ConsoleError { /** * Send the given event to the Console. - * + * * @param ev log event to be sent to the console */ public static void send(ILogEvent ev) { diff --git a/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java b/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java index 2e87fc92c..df0179c95 100644 --- a/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java +++ b/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java @@ -30,14 +30,14 @@ import com.netscape.certsrv.common.NameValuePairs; /** * A log event listener which sends all log events to the system console/tty - * + * * @version $Revision$, $Date$ */ public class ConsoleLog implements ILogEventListener { /** * Log the given event. Usually called from a log manager. - * + * * @param ev log event */ public void log(ILogEvent ev) { @@ -46,7 +46,7 @@ public class ConsoleLog implements ILogEventListener { /** * Flush the system output stream. - * + * */ public void flush() { System.err.flush(); @@ -61,7 +61,7 @@ public class ConsoleLog implements ILogEventListener { /** * get the configuration store that is associated with this * log listener - * + * * @return the configuration store that is associated with this * log listener */ @@ -80,7 +80,7 @@ public class ConsoleLog implements ILogEventListener { * Retrieve last "maxLine" number of system log with log lever >"level" * and from source "source". If the parameter is omitted. All entries * are sent back. - * + * * @param req a Hashtable containing the required information such as * log entry, log level, log source, and log name * @return the content of the log that match the criteria in req diff --git a/base/common/src/com/netscape/certsrv/logging/ELogException.java b/base/common/src/com/netscape/certsrv/logging/ELogException.java index 717dbdfe2..f049e2e12 100644 --- a/base/common/src/com/netscape/certsrv/logging/ELogException.java +++ b/base/common/src/com/netscape/certsrv/logging/ELogException.java @@ -26,7 +26,7 @@ import com.netscape.certsrv.base.MessageFormatter; * This class implements a Log exception. LogExceptions * should be caught by LogSubsystem managers. *

- * + * * @version $Revision$, $Date$ * @see java.text.MessageFormat */ @@ -44,7 +44,7 @@ public class ELogException extends EBaseException { /** * Constructs a log exception. *

- * + * * @param msgFormat Exception details. */ public ELogException(String msgFormat) { @@ -54,12 +54,12 @@ public class ELogException extends EBaseException { /** * Constructs a log exception with a parameter. For example, - * + * * 

      * new ELogException("failed to load {0}", fileName);
      *
*

- * + * * @param msgFormat Exception details in message string format. * @param param Message string parameter. */ @@ -73,7 +73,7 @@ public class ELogException extends EBaseException { * Constructs a log exception. It can be used to carry * a system exception that may contain information about * the context. For example, - * + * * 

      * 		try {
      *  		...
@@ -82,7 +82,7 @@ public class ELogException extends EBaseException {
      *      }
      *
*

- * + * * @param msgFormat Exception details in message string format. * @param param System exception. */ @@ -96,7 +96,7 @@ public class ELogException extends EBaseException { * Constructs a log exception with a list of parameters * that will be substituted into the message format. *

- * + * * @param msgFormat Exception details in message string format. * @param params List of message format parameters. */ @@ -108,7 +108,7 @@ public class ELogException extends EBaseException { /** * Returns a list of parameters. *

- * + * * @return list of message format parameters. */ public Object[] getParameters() { @@ -119,7 +119,7 @@ public class ELogException extends EBaseException { * Returns localized exception string. This method should * only be called if a localized string is necessary. *

- * + * * @return Details message. */ public String toString() { @@ -129,7 +129,7 @@ public class ELogException extends EBaseException { /** * Returns the string based on the given locale. *

- * + * * @param locale Locale. * @return Details message. */ @@ -141,7 +141,7 @@ public class ELogException extends EBaseException { /** * Retrieves resource bundle name. * Subclasses should override this as necessary - * + * * @return String containing name of resource bundle. */ diff --git a/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java b/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java index 7de84733c..5dc574e3a 100644 --- a/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java +++ b/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.logging; /** * Exception for log not found. - * + * * @version $Revision$, $Date$ */ public class ELogNotFound extends ELogException { @@ -31,7 +31,7 @@ public class ELogNotFound extends ELogException { /** * Constructs a exception for a missing required log. - * + * * @param errorString Detailed error message. */ public ELogNotFound(String errorString) { diff --git a/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java b/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java index 6c434aff9..138dd0831 100644 --- a/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java +++ b/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.logging; /** * Exception for log plugin not found. - * + * * @version $Revision$, $Date$ */ public class ELogPluginNotFound extends ELogException { @@ -31,7 +31,7 @@ public class ELogPluginNotFound extends ELogException { /** * Constructs a exception for a missing log plugin. - * + * * @param errorString Detailed error message. */ public ELogPluginNotFound(String errorString) { diff --git a/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java b/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java index 9dd8595cf..a0aa8455d 100644 --- a/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java @@ -22,7 +22,7 @@ package com.netscape.certsrv.logging; * See ILogEvent class. * This class maintains a resource bundle name for given * event type. - * + * * @version $Revision$, $Date$ */ public interface IBundleLogEvent extends ILogEvent { @@ -30,7 +30,7 @@ public interface IBundleLogEvent extends ILogEvent { /** * Sets the name of the resource bundle to be associated * with this event type. - * + * * @param bundle name of resource bundle. */ public void setBundleName(String bundle); diff --git a/base/common/src/com/netscape/certsrv/logging/ILogEvent.java b/base/common/src/com/netscape/certsrv/logging/ILogEvent.java index 423918983..865d3dc9a 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogEvent.java @@ -27,14 +27,14 @@ import java.util.Locale; * A log event represents a certain kind of log message designed for a specific purpose. * For instance, an audit type event represents messages having to do with auditable CMS * actions. The resulting message will ultimately appear into a specific log file. - * + * * @version $Revision$, $Date$ */ public interface ILogEvent extends Serializable { /** * Retrieves event time stamp. - * + * * @return Long integer of the time the event was created. */ public long getTimeStamp(); @@ -43,7 +43,7 @@ public interface ILogEvent extends Serializable { * Retrieves log source. * This is an id of the subsystem responsible * for creating the log event. - * + * * @return Integer source id. */ public int getSource(); @@ -52,14 +52,14 @@ public interface ILogEvent extends Serializable { * Retrieves log level. * The log level of an event represents its relative importance * or severity within CMS. - * + * * @return Integer log level value. */ public int getLevel(); /** * Retrieves NT specific log event type. - * + * * @return Integer NTEventType value. */ public int getNTEventType(); @@ -67,7 +67,7 @@ public interface ILogEvent extends Serializable { /** * Retrieves multiline attribute. * Does this message consiste of more than one line. - * + * * @return Boolean of multiline status. */ public boolean getMultiline(); @@ -75,7 +75,7 @@ public interface ILogEvent extends Serializable { /** * Retrieves log event type. Each type of event * has an associated String type value. - * + * * @return String containing the type of event. */ public String getEventType(); @@ -83,7 +83,7 @@ public interface ILogEvent extends Serializable { /** * Sets log event type. Each type of event * has an associated String type value. - * + * * @param eventType String containing the type of event. */ public void setEventType(String eventType); @@ -92,7 +92,7 @@ public interface ILogEvent extends Serializable { * Returns localized message string. This method should * only be called if a localized string is necessary. *

- * + * * @return Details message. */ public String toContent(); @@ -100,7 +100,7 @@ public interface ILogEvent extends Serializable { /** * Returns the string based on the given locale. *

- * + * * @param locale locale * @return Details message. */ diff --git a/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java b/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java index bfd5be930..ea61d0f2f 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java @@ -23,14 +23,14 @@ import java.util.Properties; * An interface represents a log event factory. This * factory will be responsible for creating and returning ILogEvent objects * on demand. - * + * * @version $Revision$, $Date$ */ public interface ILogEventFactory { /** * Creates an event of a particular event type/class. - * + * * @param evtClass The event type. * @param prop The resource bundle. * @param source The subsystem ID who creates the log event. @@ -45,7 +45,7 @@ public interface ILogEventFactory { /** * Releases previously created event. - * + * * @param event The log event. */ public void release(ILogEvent event); diff --git a/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java b/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java index 15ff08ad5..a2d468955 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java @@ -37,14 +37,14 @@ import com.netscape.certsrv.common.NameValuePairs; * of the logged event. The listener will then proceed to * process the event accordingly which will result in a log * message existing in some file. - * + * * @version $Revision$, $Date$ */ public interface ILogEventListener extends EventListener { /** * The event notification method: Logs event. - * + * * @param event The log event to be processed. */ public void log(ILogEvent event) throws ELogException; @@ -62,14 +62,14 @@ public interface ILogEventListener extends EventListener { /** * Get the configuration store for the log event listener. - * + * * @return The configuration store of this log event listener. */ public IConfigStore getConfigStore(); /** * Initialize this log listener - * + * * @param owner The subsystem. * @param config Configuration store for this log listener. * @exception initialization error. @@ -87,7 +87,7 @@ public interface ILogEventListener extends EventListener { * Retrieve last "maxLine" number of system logs with log level >"level" * and from source "source". If the parameter is omitted. All entries * are sent back. - * + * * @param req a Hashtable containing the required information such as * log entry, log level, log source, and log name. * @return NameValue pair list of log messages. @@ -100,35 +100,35 @@ public interface ILogEventListener extends EventListener { /** * Retrieve list of log files. - * + * */ public NameValuePairs retrieveLogList(Hashtable req) throws ServletException, IOException, EBaseException; /** * Returns implementation name. - * + * * @return String name of event listener implementation. */ public String getImplName(); /** * Returns the description of this log event listener. - * + * * @return String with listener description. */ public String getDescription(); /** * Return list of default config parameters for this log event listener. - * + * * @return Vector of default parameters. */ public Vector getDefaultParams(); /** * Return list of instance config parameters for this log event listener. - * + * * @return Vector of instance parameters. */ public Vector getInstanceParams(); diff --git a/base/common/src/com/netscape/certsrv/logging/ILogQueue.java b/base/common/src/com/netscape/certsrv/logging/ILogQueue.java index bca7a93df..9cdcb8a36 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogQueue.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogQueue.java @@ -21,14 +21,14 @@ package com.netscape.certsrv.logging; * An interface represents a log queue. A log queue * is a queue of pending log events to be dispatched * to a set of registered ILogEventListeners. - * + * * @version $Revision$, $Date$ */ public interface ILogQueue { /** * Dispatch the log event to all registered log event listeners. - * + * * @param evt the log event */ public void log(ILogEvent evt); @@ -41,7 +41,7 @@ public interface ILogQueue { /** * Registers an event listener. - * + * * @param listener The log event listener to be registered * to this queue. */ @@ -49,7 +49,7 @@ public interface ILogQueue { /** * Removes an event listener. - * + * * @param listener The log event listener to be removed from this queue. */ public void removeLogEventListener(ILogEventListener listener); @@ -57,7 +57,7 @@ public interface ILogQueue { /** * Initializes the log queue. *

- * + * */ public void init(); diff --git a/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java b/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java index ce317a5b8..313f2688e 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java @@ -32,7 +32,7 @@ import com.netscape.certsrv.base.ISubsystem; * instances. Each log instance can be individually configured and is * associated with its own configuration entries in the configuration file. *

- * + * * @version $Revision$, $Date$ */ public interface ILogSubsystem extends ISubsystem { @@ -45,7 +45,7 @@ public interface ILogSubsystem extends ISubsystem { /** * 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 */ @@ -53,7 +53,7 @@ public interface ILogSubsystem extends ISubsystem { /** * Retrieve the log event listener by instance name - * + * * @param insName the log instance name in String * @return the log instance in ILogEventListener */ @@ -61,7 +61,7 @@ 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 * @see LogPlugin @@ -70,7 +70,7 @@ public interface ILogSubsystem extends ISubsystem { /** * 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 * @see LogPlugin @@ -82,7 +82,7 @@ public interface ILogSubsystem extends ISubsystem { * 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 @@ -97,7 +97,7 @@ public interface ILogSubsystem extends ISubsystem { * 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 diff --git a/base/common/src/com/netscape/certsrv/logging/ILogger.java b/base/common/src/com/netscape/certsrv/logging/ILogger.java index 4cdb4b80f..10ec35337 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogger.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogger.java @@ -26,7 +26,7 @@ import java.util.Properties; * written to the destination log file. This object also maintains a collection of ILogFactory objects * which are used to create the supported types of ILogEvents. CMS comes out of the box with three event * types: "signedAudit", "system", and "audit". - * + * * @version $Revision$, $Date$ */ public interface ILogger { @@ -269,7 +269,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param msg The detail message to be logged. @@ -278,7 +278,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -288,7 +288,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param level The level of the log event. @@ -298,7 +298,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -309,7 +309,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param level The level of the log event. @@ -320,7 +320,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param level The level of the log event. @@ -331,7 +331,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -342,7 +342,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -355,7 +355,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param prop The resource bundle used for the detailed message. * @param source The source of the log event. @@ -370,7 +370,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param msg The detail message to be logged. @@ -380,7 +380,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -391,7 +391,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param level The level of the log event. @@ -402,7 +402,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -414,7 +414,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param source The source of the log event. * @param level The level of the log event. @@ -426,7 +426,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source TTTTsource of the log event. @@ -438,7 +438,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param props The resource bundle used for the detailed message. * @param source The source of the log event. @@ -452,7 +452,7 @@ public interface ILogger { /** * Logs an event to the log queue. - * + * * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT. * @param prop The resource bundle used for the detailed message. * @param source The source of the log event. diff --git a/base/common/src/com/netscape/certsrv/logging/LogPlugin.java b/base/common/src/com/netscape/certsrv/logging/LogPlugin.java index 9d7a5cc45..152ad4841 100644 --- a/base/common/src/com/netscape/certsrv/logging/LogPlugin.java +++ b/base/common/src/com/netscape/certsrv/logging/LogPlugin.java @@ -22,7 +22,7 @@ import com.netscape.certsrv.base.Plugin; /** * This class represents a registered logger plugin. *

- * + * * @version $Revision$, $Date$ */ public class LogPlugin extends Plugin { diff --git a/base/common/src/com/netscape/certsrv/logging/LogResources.java b/base/common/src/com/netscape/certsrv/logging/LogResources.java index 899bf1893..005428d79 100644 --- a/base/common/src/com/netscape/certsrv/logging/LogResources.java +++ b/base/common/src/com/netscape/certsrv/logging/LogResources.java @@ -25,7 +25,7 @@ import com.netscape.certsrv.base.BaseResources; /** * This is the fallback resource bundle for all log events. *

- * + * * @version $Revision$, $Date$ * @see java.util.ListResourceBundle */ @@ -35,7 +35,7 @@ public class LogResources extends ListResourceBundle { /** * Contructs a log resource bundle and sets it's parent to the base * resource bundle. - * + * * @see com.netscape.certsrv.base.BaseResources */ public LogResources() { @@ -45,7 +45,7 @@ public class LogResources extends ListResourceBundle { /** * Returns the content of this resource. - * + * * @return Array of objects making up the contents of this resource. */ public Object[][] getContents() { diff --git a/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java b/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java index 8541eda34..b5483eb9f 100644 --- a/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java @@ -27,8 +27,8 @@ import com.netscape.certsrv.base.MessageFormatter; * The log event object that carries message detail of a log event * that goes into the Signed Audit Event log. This log has the * property of being digitally signed for security considerations. - * - * + * + * * @version $Revision$, $Date$ * @see java.text.MessageFormat * @see com.netscape.certsrv.logging.LogResources @@ -61,7 +61,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a SignedAuditEvent message event. *

- * + * * @param msgFormat The message string. */ public SignedAuditEvent(String msgFormat) { @@ -71,12 +71,12 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a message with a parameter. For example, - * + * * 

      * new SignedAuditEvent("failed to load {0}", fileName);
      *
*

- * + * * @param msgFormat Details in message string format. * @param param Message string parameter. */ @@ -90,7 +90,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Constructs a message from an exception. It can be used to carry * a signed audit exception that may contain information about * the context. For example, - * + * * 

      * 		try {
      *  		...
@@ -99,7 +99,7 @@ public class SignedAuditEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param msgFormat Exception details in message string format. * @param exception System exception. */ @@ -112,7 +112,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a message from a base exception. This will use the msgFormat * from the exception itself. - * + * * 

      * 		try {
      *  		...
@@ -121,7 +121,7 @@ public class SignedAuditEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param e CMS exception. */ public SignedAuditEvent(Exception e) { @@ -138,7 +138,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Constructs a message event with a list of parameters * that will be substituted into the message format. *

- * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -150,7 +150,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the current message format string. *

- * + * * @return Details message. */ public String getMessage() { @@ -161,7 +161,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Returns a list of parameters. These parameters can be * used to assist in formatting the message. *

- * + * * @return List of message format parameters. */ public Object[] getParameters() { @@ -172,7 +172,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. *

- * + * * @return Details message. */ public String toContent() { @@ -182,7 +182,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. *

- * + * * @param locale Locale. * @return Details message. */ @@ -195,7 +195,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets the resource bundle name for this class instance. This should * be overridden by subclasses who have their own resource bundles. - * + * * @param bundle String with name of resource bundle. */ public void setBundleName(String bundle) { @@ -204,7 +204,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * + * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -215,7 +215,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Retrieves log source. * This is an id of the subsystem responsible * for creating the log event. - * + * * @return Integer source id. */ public int getSource() { @@ -224,7 +224,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets log source. - * + * * @param source Integer id of log source. */ public void setSource(int source) { @@ -235,7 +235,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Retrieves log level. * The log level of an event represents its relative importance * or severity within CMS. - * + * * @return Integer log level value. */ public int getLevel() { @@ -244,7 +244,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. - * + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -255,7 +255,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Sets log level, NT log event type. * For certain log levels the NT log event type gets * set as well. - * + * * @param level Integer log level value. */ public void setLevel(int level) { @@ -286,7 +286,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves log multiline attribute. - * + * * @return Boolean whether or not this event is multiline. * A multiline message simply consists of more than one line. */ @@ -297,7 +297,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets log multiline attribute. A multiline message consists of * more than one line. - * + * * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { @@ -306,7 +306,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves event time stamp. - * + * * @return Long integer of the time the event was created. */ public long getTimeStamp() { @@ -316,7 +316,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves log event type. Each type of event * has an associated String type value. - * + * * @return String containing the type of event. */ public String getEventType() { @@ -326,7 +326,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets log event type. Each type of event * has an associated String type value. - * + * * @param eventType String containing the type of event. */ public void setEventType(String eventType) { @@ -335,7 +335,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Return string representation of log message. - * + * * @return String containing log message. */ public String toString() { diff --git a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java index 9f625cdfd..3704e60ca 100644 --- a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java @@ -27,7 +27,7 @@ import com.netscape.certsrv.base.MessageFormatter; * The log event object that carries a log message. * This class represents System events which are CMS events * which need to be logged to a log file. - * + * * @version $Revision$, $Date$ * @see java.text.MessageFormat * @see com.netscape.certsrv.logging.LogResources @@ -59,7 +59,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Constructs a SystemEvent message event. *

- * + * * @param msgFormat The message string. */ public SystemEvent(String msgFormat) { @@ -69,12 +69,12 @@ public class SystemEvent implements IBundleLogEvent { /** * Constructs a SystemEvent message with a parameter. For example, - * + * * 

      * new SystemEvent("failed to load {0}", fileName);
      *
*

- * + * * @param msgFormat Details in message string format. * @param param Message string parameter. */ @@ -88,7 +88,7 @@ public class SystemEvent implements IBundleLogEvent { * Constructs a SystemEvent message from an exception. It can be used to carry * a system exception that may contain information about * the context. For example, - * + * * 

      * 		try {
      *  		...
@@ -97,7 +97,7 @@ public class SystemEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param msgFormat Exception details in message string format. * @param exception System exception. */ @@ -110,7 +110,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Constructs a SystemEvent message from a base exception. This will use the msgFormat * from the exception itself. - * + * * 

      * 		try {
      *  		...
@@ -119,7 +119,7 @@ public class SystemEvent implements IBundleLogEvent {
      *      }
      *
*

- * + * * @param e CMS exception. */ public SystemEvent(Exception e) { @@ -136,7 +136,7 @@ public class SystemEvent implements IBundleLogEvent { * Constructs a SystemEvent message event with a list of parameters * that will be substituted into the message format. *

- * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -148,7 +148,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the current message format string. *

- * + * * @return Details message. */ public String getMessage() { @@ -159,7 +159,7 @@ public class SystemEvent implements IBundleLogEvent { * Returns a list of parameters. These parameters can be * used to assist in formatting the message. *

- * + * * @return List of message format parameters. */ public Object[] getParameters() { @@ -170,7 +170,7 @@ public class SystemEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. *

- * + * * @return Details message. */ public String toContent() { @@ -180,7 +180,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. *

- * + * * @param locale Locale. * @return Details message. */ @@ -193,7 +193,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Sets the resource bundle name for this class instance. This should * be overridden by subclasses who have their own resource bundles. - * + * * @param bundle String with the name of resource bundle. */ public void setBundleName(String bundle) { @@ -202,7 +202,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * + * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -213,7 +213,7 @@ public class SystemEvent implements IBundleLogEvent { * Retrieves log source. * This is an id of the subsystem responsible * for creating the log event. - * + * * @return Integer source id. */ public int getSource() { @@ -223,7 +223,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Sets log source. * Sets the id of the subsystem issuing the event. - * + * * @param source Integer source id. */ public void setSource(int source) { @@ -234,7 +234,7 @@ public class SystemEvent implements IBundleLogEvent { * Retrieves log level. * The log level of an event represents its relative importance * or severity within CMS. - * + * * @return Integer log level value. */ public int getLevel() { @@ -243,7 +243,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. - * + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -254,7 +254,7 @@ public class SystemEvent implements IBundleLogEvent { * Sets log level, NT log event type. * For certain log levels the NT log event type gets * set as well. - * + * * @param level Integer log level value. */ public void setLevel(int level) { @@ -285,7 +285,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves log multiline attribute. - * + * * @return Boolean whether or not this event is multiline. * A multiline message simply consists of more than one line. */ @@ -296,7 +296,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Sets log multiline attribute. A multiline message consists of * more than one line. - * + * * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { @@ -305,7 +305,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves event time stamp. - * + * * @return Long integer of the time the event was created. */ public long getTimeStamp() { @@ -315,7 +315,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves log event type. Each type of event * has an associated String type value. - * + * * @return String containing the type of event. */ public String getEventType() { @@ -325,7 +325,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Sets log event type. Each type of event * has an associated String type value. - * + * * @param eventType String containing the type of event. */ public void setEventType(String eventType) { @@ -334,7 +334,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Return string representation of log message. - * + * * @return String containing log message. */ public String toString() { -- cgit