diff options
| author | Ade Lee <alee@redhat.com> | 2011-12-08 21:15:59 -0500 |
|---|---|---|
| committer | Ade Lee <alee@redhat.com> | 2011-12-08 21:15:59 -0500 |
| commit | 171aaece4f23709d33d180cf36eb3af5e454b0c9 (patch) | |
| tree | 1485f9f0a7bd10de4ff25030db575dbb8dafae74 /pki/base/common/src/com/netscape/certsrv/logging | |
| parent | adad2fcee8a29fdb82376fbce07dedb11fccc182 (diff) | |
| download | pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.gz pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.xz pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.zip | |
Revert "Formatting"
This reverts commit 32150d3ee32f8ac27118af7c792794b538c78a2f.
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/logging')
18 files changed, 557 insertions, 577 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java index 26ce504d5..4f7e64f27 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java @@ -17,18 +17,20 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.text.MessageFormat; import java.util.Locale; import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.MessageFormatter; + /** - * The log event object that carries message detail of a log event 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. - * + * The log event object that carries message detail of a log event + * 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 @@ -54,12 +56,12 @@ public class AuditEvent implements IBundleLogEvent { * The bundle name for this event. */ private String mBundleName = LogResources.class.getName(); - private static final String INVALID_LOG_LEVEL = "log level: {0} is invalid, should be 0-6"; + private static final String INVALID_LOG_LEVEL="log level: {0} is invalid, should be 0-6"; /** * Constructs a message event * <P> - * + * * @param msgFormat the message string */ public AuditEvent(String msgFormat) { @@ -69,12 +71,11 @@ public class AuditEvent implements IBundleLogEvent { /** * Constructs a message with a parameter. For example, - * * <PRE> - * new AuditEvent("failed to load {0}", fileName); + * new AuditEvent("failed to load {0}", fileName); * </PRE> * <P> - * + * * @param msgFormat details in message string format * @param param message string parameter */ @@ -85,9 +86,9 @@ 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, - * + * Constructs a message from an exception. It can be used to carry + * a system exception that may contain information about + * the context. For example, * <PRE> * try { * ... @@ -96,7 +97,7 @@ public class AuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param msgFormat exception details in message string format * @param exception system exception */ @@ -109,7 +110,6 @@ public class AuditEvent implements IBundleLogEvent { /** * Constructs a message from a base exception. This will use the msgFormat * from the exception itself. - * * <PRE> * try { * ... @@ -118,7 +118,7 @@ public class AuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception */ public AuditEvent(Exception e) { @@ -132,10 +132,10 @@ public class AuditEvent implements IBundleLogEvent { } /** - * Constructs a message event with a list of parameters that will be - * substituted into the message format. + * Constructs a message event with a list of parameters + * that will be substituted into the message format. * <P> - * + * * @param msgFormat message string format * @param params list of message format parameters */ @@ -147,7 +147,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return details message */ public String getMessage() { @@ -157,7 +157,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns a list of parameters. * <P> - * + * * @return list of message format parameters */ public Object[] getParameters() { @@ -165,10 +165,10 @@ public class AuditEvent implements IBundleLogEvent { } /** - * Returns localized message string. This method should only be called if a - * localized string is necessary. + * Returns localized message string. This method should + * only be called if a localized string is necessary. * <P> - * + * * @return details message */ public String toContent() { @@ -178,19 +178,19 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale locale * @return details message */ public String toContent(Locale locale) { return MessageFormatter.getLocalizedString(locale, getBundleName(), - getMessage(), getParameters()); + getMessage(), + getParameters()); } /** - * Gets the resource bundle name for this class instance. This should be - * overridden by subclasses who have their own resource bundles. - * + * 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) { @@ -199,7 +199,6 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * * @return a String that represents the resource bundle name */ protected String getBundleName() { @@ -208,9 +207,8 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log source. - * - * @return an integer that indicates the component source where this message - * event was triggered + * @return an integer that indicates the component source + * where this message event was triggered */ public int getSource() { return mSource; @@ -218,18 +216,18 @@ public class AuditEvent implements IBundleLogEvent { /** * Sets log source. - * - * @param source an integer that represents the component source where this - * message event was triggered + * @param source an integer that represents the component source + * where this message event was triggered */ public void setSource(int source) { mSource = source; } + /** - * Retrieves log level. The log level of an event represents its relative - * importance or severity within CMS. - * + * 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() { @@ -238,7 +236,6 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. - * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -246,9 +243,9 @@ 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. - * + * 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) { @@ -271,26 +268,24 @@ public class AuditEvent implements IBundleLogEvent { break; default: - ConsoleError.send(new SystemEvent(INVALID_LOG_LEVEL, Integer - .toString(level))); + ConsoleError.send(new SystemEvent(INVALID_LOG_LEVEL, + Integer.toString(level))); break; } } - + /** * Retrieves log multiline attribute. - * - * @return Boolean whether or not this event is multiline. A multiline - * message simply consists of more than one line. - */ + * @return Boolean whether or not this event is multiline. + * A multiline message simply consists of more than one line. + */ public boolean getMultiline() { return mMultiline; } /** - * Sets log multiline attribute. A multiline message consists of more than - * one line. - * + * Sets log multiline attribute. A multiline message consists of + * more than one line. * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { @@ -299,27 +294,26 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves event time stamp. - * * @return Long integer of the time the event was created. */ public long getTimeStamp() { return mTimeStamp; } + /** - * Retrieves log event type. Each type of event has an associated String - * type value. - * + * Retrieves log event type. Each type of event + * has an associated String type value. * @return String containing the type of event. */ public String getEventType() { return mEventType; } + /** - * Sets log event type. Each type of event has an associated String type - * value. - * + * 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) { @@ -327,16 +321,15 @@ public class AuditEvent implements IBundleLogEvent { } /** - * Return string representation of log message. - * - * @return String containing log message. - */ + * Return string representation of log message. + * @return String containing log message. + */ public String toString() { if (getBundleName() == null) { MessageFormat detailMessage = new MessageFormat(mMessage); return detailMessage.format(mParams); - // return getMessage(); + //return getMessage(); } else return toContent(); } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java b/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java index 34d629beb..8d870ad90 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java @@ -17,11 +17,12 @@ // --- END COPYRIGHT BLOCK --- 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 - * + * 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 { @@ -39,18 +40,18 @@ public class AuditFormat { /** * initiative: the event is from agent */ - public static final String FROMAGENT = "fromAgent"; + public static final String FROMAGENT = "fromAgent"; /** * initiative: the event is from router */ - public static final String FROMROUTER = "fromRouter"; + public static final String FROMROUTER = "fromRouter"; /** * initiative: the event is from remote authority */ public static final String FROMRA = "fromRemoteAuthority"; - + /** * authentication module: no Authentication manager */ @@ -58,33 +59,54 @@ public class AuditFormat { // for ProcessCertReq.java ,kra /** - * 0: request type 1: request ID 2: initiative 3: auth module 4: status 5: - * cert dn 6: other info. eg cert serial number, violation policies + 0: request type + 1: request ID + 2: initiative + 3: auth module + 4: status + 5: cert dn + 6: other info. eg cert serial number, violation policies */ - public static final String FORMAT = "{0} reqID {1} {2} authenticated by {3} is {4} DN requested: {5} {6}"; - public static final String NODNFORMAT = "{0} reqID {1} {2} authenticated by {3} is {4}"; + public static final String FORMAT = + "{0} reqID {1} {2} authenticated by {3} is {4} DN requested: {5} {6}"; + public static final String NODNFORMAT = + "{0} reqID {1} {2} authenticated by {3} is {4}"; - public static final String ENROLLMENTFORMAT = "Enrollment request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} {5}"; - public static final String RENEWALFORMAT = "Renewal request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} old serial number: 0x{5} {6}"; - public static final String REVOCATIONFORMAT = "Revocation request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} serial number: 0x{5} revocation reason: {6} {7}"; + public static final String ENROLLMENTFORMAT = + "Enrollment request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} {5}"; + public static final String RENEWALFORMAT = + "Renewal request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} old serial number: 0x{5} {6}"; + public static final String REVOCATIONFORMAT = + "Revocation request reqID {0} {1} authenticated by {2} is {3}. DN requested: {4} serial number: 0x{5} revocation reason: {6} {7}"; // 1: fromAgent AgentID: xxx authenticated by xxx - public static final String DOREVOKEFORMAT = "Revocation request reqID {0} {1} is {2}. DN requested: {3} serial number: 0x{4} revocation reason: {5}"; + public static final String DOREVOKEFORMAT = + "Revocation request reqID {0} {1} is {2}. DN requested: {3} serial number: 0x{4} revocation reason: {5}"; // 1: fromAgent AgentID: xxx authenticated by xxx - public static final String DOUNREVOKEFORMAT = "Unrevocation request reqID {0} {1} is {2}. DN requested: {3} serial number: 0x{4}"; + public static final String DOUNREVOKEFORMAT = + "Unrevocation request reqID {0} {1} is {2}. DN requested: {3} serial number: 0x{4}"; // 0:initiative - public static final String CRLUPDATEFORMAT = "CRLUpdate request {0} authenticated by {1} is {2}. Id: {3}\ncrl Number: {4} last update time: {5} next update time: {6} number of entries in the CRL: {7}"; + public static final String CRLUPDATEFORMAT = + "CRLUpdate request {0} authenticated by {1} is {2}. Id: {3}\ncrl Number: {4} last update time: {5} next update time: {6} number of entries in the CRL: {7}"; // audit user/group - public static final String ADDUSERFORMAT = "Admin UID: {0} added User UID: {1}"; - public static final String REMOVEUSERFORMAT = "Admin UID: {0} removed User UID: {1} "; - public static final String MODIFYUSERFORMAT = "Admin UID: {0} modified User UID: {1}"; - public static final String ADDUSERCERTFORMAT = "Admin UID: {0} added cert for User UID: {1}. cert DN: {2} serial number: 0x{3}"; - public static final String REMOVEUSERCERTFORMAT = "Admin UID: {0} removed cert of User UID: {1}. cert DN: {2} serial number: 0x{3}"; - public static final String ADDUSERGROUPFORMAT = "Admin UID: {0} added User UID: {1} to group: {2}"; - public static final String REMOVEUSERGROUPFORMAT = "Admin UID: {0} removed User UID: {1} from group: {2}"; + public static final String ADDUSERFORMAT = + "Admin UID: {0} added User UID: {1}"; + public static final String REMOVEUSERFORMAT = + "Admin UID: {0} removed User UID: {1} "; + public static final String MODIFYUSERFORMAT = + "Admin UID: {0} modified User UID: {1}"; + public static final String ADDUSERCERTFORMAT = + "Admin UID: {0} added cert for User UID: {1}. cert DN: {2} serial number: 0x{3}"; + public static final String REMOVEUSERCERTFORMAT = + "Admin UID: {0} removed cert of User UID: {1}. cert DN: {2} serial number: 0x{3}"; + public static final String ADDUSERGROUPFORMAT = + "Admin UID: {0} added User UID: {1} to group: {2}"; + public static final String REMOVEUSERGROUPFORMAT = + "Admin UID: {0} removed User UID: {1} from group: {2}"; // LDAP publishing - public static final String LDAP_PUBLISHED_FORMAT = "{0} successfully published serial number: 0x{1} with DN: {2}"; + public static final String LDAP_PUBLISHED_FORMAT = + "{0} successfully published serial number: 0x{1} with DN: {2}"; } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java index 13e0f3d45..146824ac4 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java @@ -17,9 +17,12 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + + + /** * A static class to log error messages to the Console - * + * * @version $Revision$, $Date$ */ public class ConsoleError { @@ -27,8 +30,8 @@ public class ConsoleError { /** * Send the given event to the Console. - * - * @param ev log event to be sent to the console + * + * @param ev log event to be sent to the console */ public static void send(ILogEvent ev) { console.log(ev); diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java index 72ae1a79f..c18b062c2 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java @@ -17,6 +17,7 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.io.IOException; import java.util.Hashtable; import java.util.Vector; @@ -28,75 +29,76 @@ import com.netscape.certsrv.base.IConfigStore; import com.netscape.certsrv.base.ISubsystem; 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 + * Log the given event. Usually called from a log manager. + * + * @param ev log event */ public void log(ILogEvent ev) { System.err.println(Thread.currentThread().getName() + ": " + ev); } /** - * Flush the system output stream. - * + * Flush the system output stream. + * */ public void flush() { System.err.flush(); } - /** - * All operations need to be cleaned up for shutdown are done here - */ + /** + * All operations need to be cleaned up for shutdown are done here + */ public void shutdown() { } - /** - * get the configuration store that is associated with this log listener - * - * @return the configuration store that is associated with this log listener - */ + /** + * get the configuration store that is associated with this + * log listener + * @return the configuration store that is associated with this + * log listener + */ public IConfigStore getConfigStore() { return null; } - public void init(ISubsystem owner, IConfigStore config) - throws EBaseException { + public void init(ISubsystem owner, IConfigStore config) + throws EBaseException { } public void startup() throws EBaseException { } /** - * 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 - * @exception servletException - * @exception IOException - * @exception EBaseException + * 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 + * @exception servletException + * @exception IOException + * @exception EBaseException */ - public synchronized NameValuePairs retrieveLogContent(Hashtable req) - throws ServletException, IOException, EBaseException { + public synchronized NameValuePairs retrieveLogContent(Hashtable req) throws ServletException, + IOException, EBaseException { return null; } /** - * Retrieve log file list. <br> - * unimplemented + * Retrieve log file list. + * <br> unimplemented */ - public synchronized NameValuePairs retrieveLogList(Hashtable req) - throws ServletException, IOException, EBaseException { + public synchronized NameValuePairs retrieveLogList(Hashtable req) throws ServletException, + IOException, EBaseException { return null; } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java b/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java index ed36ea5fc..90a74ba4a 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java @@ -17,14 +17,16 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.util.Locale; import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.MessageFormatter; + /** - * This class implements a Log exception. LogExceptions should be caught by - * LogSubsystem managers. + * This class implements a Log exception. LogExceptions + * should be caught by LogSubsystem managers. * <P> * * @version $Revision$, $Date$ @@ -37,14 +39,14 @@ public class ELogException extends EBaseException { */ private static final long serialVersionUID = -8903703675126348145L; /** - * Resource bundle class name. - */ + * Resource bundle class name. + */ private static final String LOG_RESOURCES = LogResources.class.getName(); /** * Constructs a log exception. * <P> - * + * * @param msgFormat Exception details. */ public ELogException(String msgFormat) { @@ -54,12 +56,11 @@ public class ELogException extends EBaseException { /** * Constructs a log exception with a parameter. For example, - * * <PRE> - * new ELogException("failed to load {0}", fileName); + * new ELogException("failed to load {0}", fileName); * </PRE> * <P> - * + * * @param msgFormat Exception details in message string format. * @param param Message string parameter. */ @@ -70,9 +71,9 @@ 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, - * + * Constructs a log exception. It can be used to carry + * a system exception that may contain information about + * the context. For example, * <PRE> * try { * ... @@ -81,7 +82,7 @@ public class ELogException extends EBaseException { * } * </PRE> * <P> - * + * * @param msgFormat Exception details in message string format. * @param param System exception. */ @@ -92,10 +93,10 @@ public class ELogException extends EBaseException { } /** - * Constructs a log exception with a list of parameters that will be - * substituted into the message format. + * Constructs a log exception with a list of parameters + * that will be substituted into the message format. * <P> - * + * * @param msgFormat Exception details in message string format. * @param params List of message format parameters. */ @@ -107,7 +108,7 @@ public class ELogException extends EBaseException { /** * Returns a list of parameters. * <P> - * + * * @return list of message format parameters. */ public Object[] getParameters() { @@ -115,10 +116,10 @@ public class ELogException extends EBaseException { } /** - * Returns localized exception string. This method should only be called if - * a localized string is necessary. + * Returns localized exception string. This method should + * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toString() { @@ -128,7 +129,7 @@ public class ELogException extends EBaseException { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ @@ -138,14 +139,13 @@ public class ELogException extends EBaseException { } /** - * Retrieves resource bundle name. Subclasses should override this as - * necessary - * + * Retrieves resource bundle name. + * Subclasses should override this as necessary * @return String containing name of resource bundle. */ protected String getBundleName() { return LOG_RESOURCES; } - + } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java b/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java index 7de84733c..2dad7aece 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java @@ -17,9 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + /** * Exception for log not found. - * + * * @version $Revision$, $Date$ */ public class ELogNotFound extends ELogException { @@ -31,7 +32,6 @@ 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/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java b/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java index 6c434aff9..efac65a28 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java @@ -17,9 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + /** * Exception for log plugin not found. - * + * * @version $Revision$, $Date$ */ public class ELogPluginNotFound extends ELogException { @@ -31,10 +32,10 @@ public class ELogPluginNotFound extends ELogException { /** * Constructs a exception for a missing log plugin. - * * @param errorString Detailed error message. */ public ELogPluginNotFound(String errorString) { super(errorString); } } + diff --git a/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java index a1a103045..44a4283bd 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java @@ -17,19 +17,23 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + + + /** - * An interface which all loggable events must implement. See ILogEvent class. - * This class maintains a resource bundle name for given event type. - * + * An interface which all loggable events must implement. + * See ILogEvent class. + * This class maintains a resource bundle name for given + * event type. + * * @version $Revision$, $Date$ */ 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. - */ + * 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/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java index 07bd67d0e..d0caca71d 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java @@ -17,81 +17,80 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.io.Serializable; import java.util.Locale; + /** - * An interface which all loggable events must implement. CMS comes with a - * limited set of ILogEvent types to implement: audit, system, and signed audit. - * This is the base class of all the subsequent implemented types. 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. - * + * An interface which all loggable events must implement. CMS comes + * with a limited set of ILogEvent types to implement: audit, system, and + * signed audit. This is the base class of all the subsequent implemented types. + * 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(); /** - * Retrieves log source. This is an id of the subsystem responsible for - * creating the log event. - * + * Retrieves log source. + * This is an id of the subsystem responsible + * for creating the log event. * @return Integer source id. */ public int getSource(); + /** - * Retrieves log level. The log level of an event represents its relative - * importance or severity within CMS. - * + * 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(); /** - * Retrieves multiline attribute. Does this message consiste of more than - * one line. - * - * @return Boolean of multiline status. - */ + * Retrieves multiline attribute. + * Does this message consiste of more than one line. + * @return Boolean of multiline status. + */ public boolean getMultiline(); + /** - * Retrieves log event type. Each type of event has an associated String - * type value. - * + * Retrieves log event type. Each type of event + * has an associated String type value. * @return String containing the type of event. */ public String getEventType(); /** - * Sets log event type. Each type of event has an associated String type - * value. - * + * 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); + /** - * Returns localized message string. This method should only be called if a - * localized string is necessary. + * Returns localized message string. This method should + * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent(); @@ -99,7 +98,7 @@ public interface ILogEvent extends Serializable { /** * Returns the string based on the given locale. * <P> - * + * * @param locale locale * @return Details message. */ diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java index 0cf4c23e8..f94f20a95 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java @@ -17,19 +17,22 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.util.Properties; + /** - * An interface represents a log event factory. This factory will be responsible - * for creating and returning ILogEvent objects on demand. - * + * 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. @@ -40,11 +43,11 @@ public interface ILogEventFactory { * @return The created ILogEvent object. */ public ILogEvent create(int evtClass, Properties prop, int source, - int level, boolean multiline, String msg, Object params[]); + int level, boolean multiline, String msg, Object params[]); /** * Releases previously created event. - * + * * @param event The log event. */ public void release(ILogEvent event); diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java index 68b766691..12c09b0bc 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java @@ -17,6 +17,7 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.io.IOException; import java.util.EventListener; import java.util.Hashtable; @@ -29,104 +30,102 @@ import com.netscape.certsrv.base.IConfigStore; import com.netscape.certsrv.base.ISubsystem; import com.netscape.certsrv.common.NameValuePairs; + + /** - * An interface represents a log event listener. A ILogEventListener is - * registered to a specific ILogQueue to be notified of created ILogEvents. the - * log queue will notify all its registered listeners 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. - * + * An interface represents a log event listener. + * A ILogEventListener is registered to a specific + * ILogQueue to be notified of created ILogEvents. + * the log queue will notify all its registered listeners + * 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. - * + * The event notification method: Logs event. + * * @param event The log event to be processed. */ public void log(ILogEvent event) throws ELogException; /** - * Flushes the log buffers (if any). Will result in the messages being - * actually written to their destination. + * Flushes the log buffers (if any). Will result in the messages + * being actually written to their destination. */ public void flush(); /** - * Closes the log file and destroys any associated threads. + * Closes the log file and destroys any associated threads. */ public void shutdown(); /** * 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. + * @param owner The subsystem. + * @param config Configuration store for this log listener. + * @exception initialization error. */ - public void init(ISubsystem owner, IConfigStore config) - throws EBaseException; + public void init(ISubsystem owner, IConfigStore config) + throws EBaseException; /** * Startup the instance. */ - public void startup() throws EBaseException; + public void startup() + throws EBaseException; /** - * 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. - * @exception ServletException For Servelet errros. - * @exception IOException For input/output problems. - * @exception EBaseException For other problems. + * 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. + * @exception ServletException For Servelet errros. + * @exception IOException For input/output problems. + * @exception EBaseException For other problems. */ - public NameValuePairs retrieveLogContent(Hashtable req) - throws ServletException, IOException, EBaseException; + public NameValuePairs retrieveLogContent(Hashtable req) throws ServletException, + IOException, EBaseException; /** - * Retrieve list of log files. - * - */ - public NameValuePairs retrieveLogList(Hashtable req) - throws ServletException, IOException, EBaseException; + * 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. - */ + * 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. - */ + * Return list of instance config parameters for this log event listener. + * @return Vector of instance parameters. + */ public Vector getInstanceParams(); } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java index 5923d3307..878b9ba16 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java @@ -17,35 +17,40 @@ // --- END COPYRIGHT BLOCK --- 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. - * + * 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); /** - * Flushes log queue, flushes all registered listeners. Messages should be - * written to their destination. + * Flushes log queue, flushes all registered listeners. + * Messages should be written to their destination. */ public void flush(); /** * Registers an event listener. - * - * @param listener The log event listener to be registered to this queue. + * + * @param listener The log event listener to be registered + * to this queue. */ public void addLogEventListener(ILogEventListener listener); - /** + /** * Removes an event listener. * * @param listener The log event listener to be removed from this queue. @@ -55,7 +60,7 @@ public interface ILogQueue { /** * Initializes the log queue. * <P> - * + * */ public void init(); 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; } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/ILogger.java b/pki/base/common/src/com/netscape/certsrv/logging/ILogger.java index 8f64e78e3..01fbc6b93 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogger.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogger.java @@ -17,22 +17,23 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.util.Properties; + /** - * An interface represents a logger for certificate server. This object is used - * to issue log messages for the various types of logging event types. A log - * message results in a ILogEvent being created. This event is then placed on a - * ILogQueue to be ultimately 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". - * + * An interface represents a logger for certificate server. This object is used to + * issue log messages for the various types of logging event types. A log message results + * in a ILogEvent being created. This event is then placed on a ILogQueue to be ultimately + * 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 { - - // List of defined log classes. + + //List of defined log classes. /** * log class: audit event. */ @@ -40,24 +41,24 @@ public interface ILogger { public static final String PROP_AUDIT = "transaction"; /** - * log class: system event. System event with log level >= LL_FAILURE will - * also be logged in error log + * log class: system event. + * System event with log level >= LL_FAILURE will also be logged in error log */ public static final int EV_SYSTEM = 1; public static final String PROP_SYSTEM = "system"; /** - * log class: SignedAudit event. + * log class: SignedAudit event. */ public static final int EV_SIGNED_AUDIT = 2; public static final String PROP_SIGNED_AUDIT = "signedAudit"; - // List of defined log sources. - + //List of defined log sources. + /** * log source: used by servlet to retrieve all logs */ - public static final int S_ALL = 0; // used by servlet only + public static final int S_ALL = 0; //used by servlet only /** * log source: identify the log entry is from KRA @@ -135,29 +136,30 @@ public interface ILogger { */ public static final int S_TKS = 16; - + /** - * log source: identify the log entry is from other subsystem eg. policy, - * security, connector,registration + * log source: identify the log entry is from other subsystem + * eg. policy, security, connector,registration */ public static final int S_OTHER = 20; + // List of defined log levels. /** * log level: used by servlet to retrieve all level logs */ - public static final int LL_ALL = -1; // used by servlet only - public static final String LL_ALL_STRING = "All"; // used by servlet only + public static final int LL_ALL = -1; //used by servlet only + public static final String LL_ALL_STRING = "All"; //used by servlet only /** * log level: indicate this log entry is debug info */ - + /** - * Debug level is depreciated since CMS6.1. Please use CMS.debug() to output - * messages to debugging file. + * Debug level is depreciated since CMS6.1. Please use + * CMS.debug() to output messages to debugging file. */ - public static final int LL_DEBUG = 0; // depreciated + public static final int LL_DEBUG = 0; // depreciated public static final String LL_DEBUG_STRING = "Debug"; /** @@ -197,20 +199,20 @@ public interface ILogger { public static final String LL_SECURITY_STRING = "Security"; /** - * "SubjectID" for system-initiated events logged in signed audit log - * messages + * "SubjectID" for system-initiated events logged + * in signed audit log messages */ public static final String SYSTEM_UID = "$System$"; /** - * A constant string value used to denote a single "unknown" identity in - * signed audit log messages + * A constant string value used to denote a single "unknown" identity + * in signed audit log messages */ public static final String UNIDENTIFIED = "$Unidentified$"; /** - * A constant string value used to denote a single "non-role" identity in - * signed audit log messages + * A constant string value used to denote a single "non-role" identity + * in signed audit log messages */ public static final String NONROLEUSER = "$NonRoleUser$"; @@ -219,22 +221,23 @@ public interface ILogger { */ public static final String SUCCESS = "Success"; public static final String FAILURE = "Failure"; - + /** - * A constant string value used to denote a "non-applicable" data value in - * signed audit log messages + * A constant string value used to denote a "non-applicable" + * data value in signed audit log messages */ public final static String SIGNED_AUDIT_NON_APPLICABLE = "N/A"; /** - * A constant string value used to denote an "empty", or "null", data value - * in signed audit log messages + * A constant string value used to denote an "empty", or "null", + * data value in signed audit log messages */ public final static String SIGNED_AUDIT_EMPTY_VALUE = "<null>"; /** - * Constant string values associated with the type of certificate processing - * stored in the "InfoName" field in certain signed audit log messages + * Constant string values associated with the type of certificate + * processing stored in the "InfoName" field in certain signed + * audit log messages */ public final static String SIGNED_AUDIT_ACCEPTANCE = "certificate"; public final static String SIGNED_AUDIT_CANCELLATION = "cancelReason"; @@ -255,7 +258,7 @@ public interface ILogger { * NT event type: correspont to log level LL_FAILURE and above */ public static final int NT_ERROR = 1; - + // List of defined log multiline attribute. /** * indicate the log message has more than one line @@ -269,9 +272,8 @@ 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 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. */ @@ -279,9 +281,8 @@ 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 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. * @param msg The detail message to be logged. @@ -290,9 +291,8 @@ 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 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. * @param msg The detail message to be logged. @@ -301,226 +301,185 @@ 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. */ - public void log(int evtClass, Properties props, int source, int level, - String msg); + public void log(int evtClass, Properties props, int source, int level, String msg); /** * 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 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. * @param msg The detail message to be logged. * @param param The parameter in the detail message. */ - public void log(int evtClass, int source, int level, String msg, - Object param); + public void log(int evtClass, int source, int level, String msg, Object param); /** * 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 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. * @param msg The detail message to be logged. * @param params The parameters in the detail message. */ - public void log(int evtClass, int source, int level, String msg, - Object params[]); + public void log(int evtClass, int source, int level, String msg, Object params[]); /** * 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 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. * @param msg The detail message to be logged. * @param param The parameters in the detail message. */ - public void log(int evtClass, Properties props, int source, String msg, - Object param); + public void log(int evtClass, Properties props, int source, String msg, Object param); /** * 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. * @param param The parameter in the detail message. */ - public void log(int evtClass, Properties props, int source, int level, - String msg, Object param); + public void log(int evtClass, Properties props, int source, int level, String msg, + Object param); /** * 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. * @param params The parameters in the detail message. */ - public void log(int evtClass, Properties prop, int source, int level, - String msg, Object params[]); + public void log(int evtClass, Properties prop, int source, int level, String msg, + Object params[]); - // multiline log + //multiline log /** * 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 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. - * @param multiline true If the message has more than one line, otherwise - * false. + * @param multiline true If the message has more than one line, otherwise false. */ public void log(int evtClass, int source, String msg, boolean multiline); /** * 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 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. * @param msg The detail message to be logged. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, Properties props, int source, String msg, - boolean multiline); + public void log(int evtClass, Properties props, int source, String msg, boolean multiline); /** * 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 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. * @param msg The detail message to be logged. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, int source, int level, String msg, - boolean multiline); + public void log(int evtClass, int source, int level, String msg, boolean multiline); /** * 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, Properties props, int source, int level, - String msg, boolean multiline); + public void log(int evtClass, Properties props, int source, int level, String msg, boolean multiline); /** * 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 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. * @param msg The detail message to be logged. * @param param The parameter in the detail message. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, int source, int level, String msg, - Object param, boolean multiline); + public void log(int evtClass, int source, int level, String msg, Object param, boolean multiline); /** * 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 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. * @param msg The detail message to be logged. * @param param The parameter in the detail message. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, Properties props, int source, String msg, - Object param, boolean multiline); + public void log(int evtClass, Properties props, int source, String msg, Object param, boolean multiline); /** * 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. * @param param The parameter in the detail message. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, Properties props, int source, int level, - String msg, Object param, boolean multiline); + public void log(int evtClass, Properties props, int source, int level, String msg, + Object param, boolean multiline); /** * 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 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. * @param level The level of the log event. * @param msg The detail message to be logged. * @param params The parameters in the detail message. - * @param multiline True if the message has more than one line, otherwise - * false. + * @param multiline True if the message has more than one line, otherwise false. */ - public void log(int evtClass, Properties prop, int source, int level, - String msg, Object params[], boolean multiline); + public void log(int evtClass, Properties prop, int source, int level, String msg, + Object params[], boolean multiline); /* * Generates an ILogEvent - * - * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM or - * EV_SIGNED_AUDIT. - * + * @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. - * * @param level The level of the log event. - * * @param msg The detail message to be logged. - * * @param params The parameters in the detail message. - * - * @param multiline True if the message has more than one line, otherwise - * false. - * + * @param multiline True if the message has more than one line, otherwise false. * @return ILogEvent, a log event. */ - public ILogEvent create(int evtClass, Properties prop, int source, - int level, String msg, Object params[], boolean multiline); + public ILogEvent create(int evtClass, Properties prop, int source, int level, + String msg, Object params[], boolean multiline); /** * Register a log event factory. Which will create the desired ILogEvents. @@ -528,8 +487,8 @@ public interface ILogger { public void register(int evtClass, ILogEventFactory f); /** - * Retrieves the associated log queue. The log queue is where issued log - * events are collected for later processing. + * Retrieves the associated log queue. The log queue is where issued log events + * are collected for later processing. */ public ILogQueue getLogQueue(); diff --git a/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java b/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java index 9d7a5cc45..b8195eece 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java @@ -17,16 +17,18 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import com.netscape.certsrv.base.Plugin; + /** * This class represents a registered logger plugin. * <P> - * + * * @version $Revision$, $Date$ */ public class LogPlugin extends Plugin { - public LogPlugin(String id, String path) { + public LogPlugin (String id, String path) { super(id, path); } } diff --git a/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java b/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java index 33615443e..6a7472ff1 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java @@ -17,15 +17,17 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.util.ListResourceBundle; import java.util.ResourceBundle; import com.netscape.certsrv.base.BaseResources; + /** * This is the fallback resource bundle for all log events. * <P> - * + * * @version $Revision$, $Date$ * @see java.util.ListResourceBundle */ @@ -33,9 +35,9 @@ public class LogResources extends ListResourceBundle { public static final String BASE_RESOURCES = BaseResources.class.getName(); /** - * Contructs a log resource bundle and sets it's parent to the base resource - * bundle. - * + * 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 +47,6 @@ 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/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java index cfae81750..ab86a4ce2 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java @@ -17,18 +17,20 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.text.MessageFormat; import java.util.Locale; import com.netscape.certsrv.base.EBaseException; 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. - * - * + * 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 @@ -50,18 +52,18 @@ public class SignedAuditEvent implements IBundleLogEvent { private boolean mMultiline = false; private long mTimeStamp = System.currentTimeMillis(); - private static final String INVALID_LOG_LEVEL = "log level: {0} is invalid, should be 0-6"; + private static final String INVALID_LOG_LEVEL="log level: {0} is invalid, should be 0-6"; /** - * The bundle name for this event. ....not anymore...keep for now and clean - * up later + * The bundle name for this event. + * ....not anymore...keep for now and clean up later */ private String mBundleName = LogResources.class.getName(); /** * Constructs a SignedAuditEvent message event. * <P> - * + * * @param msgFormat The message string. */ public SignedAuditEvent(String msgFormat) { @@ -71,12 +73,11 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a message with a parameter. For example, - * * <PRE> - * new SignedAuditEvent("failed to load {0}", fileName); + * new SignedAuditEvent("failed to load {0}", fileName); * </PRE> * <P> - * + * * @param msgFormat Details in message string format. * @param param Message string parameter. */ @@ -87,10 +88,9 @@ 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, - * + * 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, * <PRE> * try { * ... @@ -99,7 +99,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param msgFormat Exception details in message string format. * @param exception System exception. */ @@ -112,7 +112,6 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a message from a base exception. This will use the msgFormat * from the exception itself. - * * <PRE> * try { * ... @@ -121,7 +120,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception. */ public SignedAuditEvent(Exception e) { @@ -135,10 +134,10 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Constructs a message event with a list of parameters that will be - * substituted into the message format. + * Constructs a message event with a list of parameters + * that will be substituted into the message format. * <P> - * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -150,7 +149,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return Details message. */ public String getMessage() { @@ -158,10 +157,10 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Returns a list of parameters. These parameters can be used to assist in - * formatting the message. + * Returns a list of parameters. These parameters can be + * used to assist in formatting the message. * <P> - * + * * @return List of message format parameters. */ public Object[] getParameters() { @@ -169,10 +168,10 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Returns localized message string. This method should only be called if a - * localized string is necessary. + * Returns localized message string. This method should + * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent() { @@ -182,19 +181,19 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ public String toContent(Locale locale) { return MessageFormatter.getLocalizedString(locale, getBundleName(), - getMessage(), getParameters()); + getMessage(), + getParameters()); } /** - * Sets the resource bundle name for this class instance. This should be - * overridden by subclasses who have their own resource bundles. - * + * 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) { @@ -203,7 +202,6 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -211,9 +209,9 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Retrieves log source. This is an id of the subsystem responsible for - * creating the log event. - * + * Retrieves log source. + * This is an id of the subsystem responsible + * for creating the log event. * @return Integer source id. */ public int getSource() { @@ -222,7 +220,6 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets log source. - * * @param source Integer id of log source. */ public void setSource(int source) { @@ -230,18 +227,18 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Retrieves log level. The log level of an event represents its relative - * importance or severity within CMS. - * + * 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() { return mLevel; } + /** * Retrieves NT specific log event type. - * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -249,9 +246,9 @@ 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. - * + * 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) { @@ -274,55 +271,53 @@ public class SignedAuditEvent implements IBundleLogEvent { break; default: - ConsoleError.send(new SignedAuditEvent(INVALID_LOG_LEVEL, Integer - .toString(level))); + ConsoleError.send(new SignedAuditEvent(INVALID_LOG_LEVEL, + Integer.toString(level))); break; } } /** * Retrieves log multiline attribute. - * - * @return Boolean whether or not this event is multiline. A multiline - * message simply consists of more than one line. + * @return Boolean whether or not this event is multiline. + * A multiline message simply consists of more than one line. */ public boolean getMultiline() { return mMultiline; } /** - * Sets log multiline attribute. A multiline message consists of more than - * one line. - * + * Sets log multiline attribute. A multiline message consists of + * more than one line. * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { mMultiline = multiline; } + /** * Retrieves event time stamp. - * * @return Long integer of the time the event was created. */ public long getTimeStamp() { return mTimeStamp; } + /** - * Retrieves log event type. Each type of event has an associated String - * type value. - * + * Retrieves log event type. Each type of event + * has an associated String type value. * @return String containing the type of event. */ public String getEventType() { return mEventType; } + /** - * Sets log event type. Each type of event has an associated String type - * value. - * + * 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) { @@ -330,10 +325,9 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Return string representation of log message. - * - * @return String containing log message. - */ + * Return string representation of log message. + * @return String containing log message. + */ public String toString() { if (getBundleName() == null) { MessageFormat detailMessage = new MessageFormat(mMessage); diff --git a/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java index 201b8ef24..83026323c 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java @@ -17,16 +17,19 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; + import java.text.MessageFormat; import java.util.Locale; import com.netscape.certsrv.base.EBaseException; 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. - * + * 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 @@ -53,12 +56,12 @@ public class SystemEvent implements IBundleLogEvent { */ private String mBundleName = LogResources.class.getName(); - private static final String INVALID_LOG_LEVEL = "log level: {0} is invalid, should be 0-6"; + private static final String INVALID_LOG_LEVEL="log level: {0} is invalid, should be 0-6"; /** * Constructs a SystemEvent message event. * <P> - * + * * @param msgFormat The message string. */ public SystemEvent(String msgFormat) { @@ -68,12 +71,11 @@ public class SystemEvent implements IBundleLogEvent { /** * Constructs a SystemEvent message with a parameter. For example, - * * <PRE> - * new SystemEvent("failed to load {0}", fileName); + * new SystemEvent("failed to load {0}", fileName); * </PRE> * <P> - * + * * @param msgFormat Details in message string format. * @param param Message string parameter. */ @@ -84,10 +86,9 @@ 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, - * + * 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, * <PRE> * try { * ... @@ -96,7 +97,7 @@ public class SystemEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param msgFormat Exception details in message string format. * @param exception System exception. */ @@ -107,9 +108,8 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Constructs a SystemEvent message from a base exception. This will use the - * msgFormat from the exception itself. - * + * Constructs a SystemEvent message from a base exception. This will use the msgFormat + * from the exception itself. * <PRE> * try { * ... @@ -118,7 +118,7 @@ public class SystemEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception. */ public SystemEvent(Exception e) { @@ -132,10 +132,10 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Constructs a SystemEvent message event with a list of parameters that - * will be substituted into the message format. + * Constructs a SystemEvent message event with a list of parameters + * that will be substituted into the message format. * <P> - * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -147,7 +147,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return Details message. */ public String getMessage() { @@ -155,10 +155,10 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Returns a list of parameters. These parameters can be used to assist in - * formatting the message. + * Returns a list of parameters. These parameters can be + * used to assist in formatting the message. * <P> - * + * * @return List of message format parameters. */ public Object[] getParameters() { @@ -166,10 +166,10 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Returns localized message string. This method should only be called if a - * localized string is necessary. + * Returns localized message string. This method should + * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent() { @@ -179,19 +179,19 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ public String toContent(Locale locale) { return MessageFormatter.getLocalizedString(locale, getBundleName(), - getMessage(), getParameters()); + getMessage(), + getParameters()); } /** - * Sets the resource bundle name for this class instance. This should be - * overridden by subclasses who have their own resource bundles. - * + * 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) { @@ -200,7 +200,6 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves bundle name. - * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -208,9 +207,9 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Retrieves log source. This is an id of the subsystem responsible for - * creating the log event. - * + * Retrieves log source. + * This is an id of the subsystem responsible + * for creating the log event. * @return Integer source id. */ public int getSource() { @@ -218,8 +217,8 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Sets log source. Sets the id of the subsystem issuing the event. - * + * Sets log source. + * Sets the id of the subsystem issuing the event. * @param source Integer source id. */ public void setSource(int source) { @@ -227,9 +226,9 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Retrieves log level. The log level of an event represents its relative - * importance or severity within CMS. - * + * 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() { @@ -238,7 +237,6 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. - * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -246,9 +244,9 @@ 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. - * + * 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) { @@ -271,26 +269,24 @@ public class SystemEvent implements IBundleLogEvent { break; default: - ConsoleError.send(new SystemEvent(INVALID_LOG_LEVEL, Integer - .toString(level))); + ConsoleError.send(new SystemEvent(INVALID_LOG_LEVEL, + Integer.toString(level))); break; } } /** * Retrieves log multiline attribute. - * - * @return Boolean whether or not this event is multiline. A multiline - * message simply consists of more than one line. + * @return Boolean whether or not this event is multiline. + * A multiline message simply consists of more than one line. */ public boolean getMultiline() { return mMultiline; } /** - * Sets log multiline attribute. A multiline message consists of more than - * one line. - * + * Sets log multiline attribute. A multiline message consists of + * more than one line. * @param multiline Boolean multiline value. */ public void setMultiline(boolean multiline) { @@ -299,7 +295,6 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves event time stamp. - * * @return Long integer of the time the event was created. */ public long getTimeStamp() { @@ -307,19 +302,18 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Retrieves log event type. Each type of event has an associated String - * type value. - * + * Retrieves log event type. Each type of event + * has an associated String type value. * @return String containing the type of event. */ public String getEventType() { return mEventType; } + /** - * Sets log event type. Each type of event has an associated String type - * value. - * + * 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) { @@ -327,10 +321,9 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Return string representation of log message. - * - * @return String containing log message. - */ + * Return string representation of log message. + * @return String containing log message. + */ public String toString() { if (getBundleName() == null) { MessageFormat detailMessage = new MessageFormat(mMessage); |