diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/logging')
18 files changed, 334 insertions, 307 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 4f7e64f2..aa0077b0 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/AuditEvent.java @@ -17,20 +17,18 @@ // --- 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 + * 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 @@ -56,12 +54,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) { @@ -71,11 +69,12 @@ 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 */ @@ -89,6 +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, + * * <PRE> * try { * ... @@ -97,7 +97,7 @@ public class AuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param msgFormat exception details in message string format * @param exception system exception */ @@ -110,6 +110,7 @@ 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 +119,7 @@ public class AuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception */ public AuditEvent(Exception e) { @@ -135,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. * <P> - * + * * @param msgFormat message string format * @param params list of message format parameters */ @@ -147,7 +148,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return details message */ public String getMessage() { @@ -157,7 +158,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns a list of parameters. * <P> - * + * * @return list of message format parameters */ public Object[] getParameters() { @@ -168,7 +169,7 @@ public class AuditEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. * <P> - * + * * @return details message */ public String toContent() { @@ -178,7 +179,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale locale * @return details message */ @@ -189,8 +190,9 @@ public class AuditEvent implements IBundleLogEvent { } /** - * Gets the resource bundle name for this class instance. This should + * 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,6 +201,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. + * * @return a String that represents the resource bundle name */ protected String getBundleName() { @@ -207,8 +210,9 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log source. + * * @return an integer that indicates the component source - * where this message event was triggered + * where this message event was triggered */ public int getSource() { return mSource; @@ -216,18 +220,19 @@ public class AuditEvent implements IBundleLogEvent { /** * Sets log source. + * * @param source an integer that represents the component source - * where this message event was triggered + * 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. + * * @return Integer log level value. */ public int getLevel() { @@ -236,6 +241,7 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -246,6 +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) { @@ -273,12 +280,13 @@ public class AuditEvent implements IBundleLogEvent { break; } } - + /** * Retrieves log multiline attribute. + * * @return Boolean whether or not this event is multiline. - * A multiline message simply consists of more than one line. - */ + * A multiline message simply consists of more than one line. + */ public boolean getMultiline() { return mMultiline; } @@ -286,6 +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) { @@ -294,26 +303,27 @@ 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. + * * @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. + * * @param eventType String containing the type of event. */ public void setEventType(String eventType) { @@ -321,9 +331,10 @@ 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); 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 8d870ad9..81253ff5 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/AuditFormat.java @@ -17,12 +17,11 @@ // --- 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 + * class "AuditFormat" is legacy and has nothing to do with the signed * audit log events format - * + * * @version $Revision$, $Date$ */ public class AuditFormat { @@ -40,18 +39,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 */ @@ -59,54 +58,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}"; + "Admin UID: {0} added User UID: {1}"; public static final String REMOVEUSERFORMAT = - "Admin UID: {0} removed User UID: {1} "; + "Admin UID: {0} removed User UID: {1} "; public static final String MODIFYUSERFORMAT = - "Admin UID: {0} modified User UID: {1}"; + "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}"; + "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}"; + "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}"; + "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}"; + "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 146824ac..13e0f3d4 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleError.java @@ -17,12 +17,9 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; - - - /** * A static class to log error messages to the Console - * + * * @version $Revision$, $Date$ */ public class ConsoleError { @@ -30,8 +27,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 8dee67ef..2e87fc92 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ConsoleLog.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; - import java.io.IOException; import java.util.Hashtable; import java.util.Vector; @@ -29,49 +28,49 @@ 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 { @@ -79,14 +78,15 @@ 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 + * 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 + * + * @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<String, String> req) throws ServletException, IOException, EBaseException { @@ -94,8 +94,8 @@ public class ConsoleLog implements ILogEventListener { } /** - * Retrieve log file list. - * <br> unimplemented + * Retrieve log file list. <br> + * unimplemented */ public synchronized NameValuePairs retrieveLogList(Hashtable<String, String> req) throws ServletException, IOException, EBaseException { 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 90a74ba4..717dbdfe 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogException.java @@ -17,13 +17,11 @@ // --- 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. @@ -39,14 +37,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) { @@ -56,11 +54,12 @@ 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. */ @@ -74,6 +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, + * * <PRE> * try { * ... @@ -82,7 +82,7 @@ public class ELogException extends EBaseException { * } * </PRE> * <P> - * + * * @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. * <P> - * + * * @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. * <P> - * + * * @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. * <P> - * + * * @return Details message. */ public String toString() { @@ -129,7 +129,7 @@ public class ELogException extends EBaseException { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ @@ -141,11 +141,12 @@ public class ELogException extends EBaseException { /** * 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 2dad7aec..7de84733 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogNotFound.java @@ -17,10 +17,9 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; - /** * Exception for log not found. - * + * * @version $Revision$, $Date$ */ public class ELogNotFound extends ELogException { @@ -32,6 +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/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java b/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java index efac65a2..6c434aff 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ELogPluginNotFound.java @@ -17,10 +17,9 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; - /** * Exception for log plugin not found. - * + * * @version $Revision$, $Date$ */ public class ELogPluginNotFound extends ELogException { @@ -32,10 +31,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 44a4283b..9dd8595c 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/IBundleLogEvent.java @@ -17,23 +17,21 @@ // --- 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. - * + * * @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 d0caca71..42391898 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEvent.java @@ -17,25 +17,24 @@ // --- 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. + * 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. - * + * 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(); @@ -44,36 +43,39 @@ 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(); - /** * 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. + * * @return String containing the type of event. */ public String getEventType(); @@ -81,16 +83,16 @@ 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); - /** * Returns localized message string. This method should * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent(); @@ -98,7 +100,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 f94f20a9..bfd5be93 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java @@ -17,22 +17,20 @@ // --- 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. - * + * * @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. @@ -43,11 +41,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 80953ead..15ff08ad 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogEventListener.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.logging; - import java.io.IOException; import java.util.EventListener; import java.util.Hashtable; @@ -30,102 +29,107 @@ 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 + * 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; + throws EBaseException; /** * Retrieve last "maxLine" number of system logs with log level >"level" - * and from source "source". If the parameter is omitted. All entries + * 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. + * + * @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<String, String> req) throws ServletException, IOException, EBaseException; /** - * Retrieve list of log files. - * - */ + * Retrieve list of log files. + * + */ public NameValuePairs retrieveLogList(Hashtable<String, String> 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<String> 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<String> 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 878b9ba1..bca7a93d 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogQueue.java @@ -17,21 +17,18 @@ // --- 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. - * + * * @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); @@ -44,13 +41,13 @@ public interface ILogQueue { /** * Registers an event listener. - * + * * @param listener The log event listener to be registered - * to this queue. + * to this queue. */ public void addLogEventListener(ILogEventListener listener); - /** + /** * Removes an event listener. * * @param listener The log event listener to be removed from this queue. @@ -60,7 +57,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 2bdba0ab..ce317a5b 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/ILogSubsystem.java @@ -17,21 +17,19 @@ // --- 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 + * 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 + * 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 + * "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> * @@ -46,14 +44,16 @@ 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 + * 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 */ @@ -61,44 +61,48 @@ 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<String, LogPlugin> getLogPlugins(); + public Hashtable<String, LogPlugin> 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<String, ILogEventListener> getLogInsts(); /** - * Get the default configuration parameter names associated with a - * plugin. It is used by + * 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 + * configuration parameters are to be configured * @return a Vector of default configuration paramter names - * associated with this log plugin + * associated with this log plugin * @exception ELogException when instantiation of the plugin - * implementation fails. + * implementation fails. */ public Vector<String> getLogDefaultParams(String implName) throws ELogException; /** - * Get the default configuration parameter names associated with a - * log instance. It is used by administration servlet to handle + * 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 + * parameters are to be configured * @return a Vector of default configuration paramter names - * associated with this log instance. + * associated with this log instance. */ public Vector<String> getLogInstanceParams(String insName) - throws ELogException; + 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 01fbc6b9..4cdb4b80 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,20 @@ // --- 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 + * 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". - * + * types: "signedAudit", "system", and "audit". + * * @version $Revision$, $Date$ */ public interface ILogger { - + //List of defined log classes. /** * log class: audit event. @@ -41,20 +39,20 @@ public interface ILogger { public static final String PROP_AUDIT = "transaction"; /** - * log class: system event. + * 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. - + /** * log source: used by servlet to retrieve all logs */ @@ -136,14 +134,13 @@ 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 */ public static final int S_OTHER = 20; - // List of defined log levels. /** * log level: used by servlet to retrieve all level logs @@ -154,12 +151,12 @@ public interface ILogger { /** * 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. */ - public static final int LL_DEBUG = 0; // depreciated + public static final int LL_DEBUG = 0; // depreciated public static final String LL_DEBUG_STRING = "Debug"; /** @@ -221,7 +218,7 @@ 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 @@ -258,7 +255,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 @@ -272,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. @@ -281,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. @@ -291,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. @@ -301,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. @@ -312,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. @@ -323,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. @@ -334,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. @@ -345,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. @@ -354,11 +351,11 @@ public interface ILogger { * @param param The parameter in the detail message. */ public void log(int evtClass, Properties props, int source, int level, String msg, - Object param); + 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 prop The resource bundle used for the detailed message. * @param source The source of the log event. @@ -367,13 +364,13 @@ public interface ILogger { * @param params The parameters in the detail message. */ public void log(int evtClass, Properties prop, int source, int level, String msg, - Object params[]); + Object params[]); //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 source The source of the log event. * @param msg The detail message to be logged. @@ -383,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. @@ -394,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. @@ -405,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. @@ -417,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. @@ -429,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. @@ -441,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. @@ -451,11 +448,11 @@ public interface ILogger { * @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); + 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 prop The resource bundle used for the detailed message. * @param source The source of the log event. @@ -465,7 +462,7 @@ public interface ILogger { * @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); + Object params[], boolean multiline); /* * Generates an ILogEvent @@ -479,7 +476,7 @@ public interface ILogger { * @return ILogEvent, a log event. */ public ILogEvent create(int evtClass, Properties prop, int source, int level, - String msg, Object params[], boolean multiline); + String msg, Object params[], boolean multiline); /** * Register a log event factory. Which will create the desired ILogEvents. @@ -487,7 +484,7 @@ public interface ILogger { public void register(int evtClass, ILogEventFactory f); /** - * Retrieves the associated log queue. The log queue is where issued log events + * 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 b8195eec..9d7a5cc4 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/LogPlugin.java @@ -17,18 +17,16 @@ // --- 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 6a7472ff..899bf189 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/LogResources.java @@ -17,17 +17,15 @@ // --- 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 */ @@ -37,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() { @@ -47,6 +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/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java b/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java index ab86a4ce..8541eda3 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java @@ -17,20 +17,18 @@ // --- 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 + * 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 @@ -52,7 +50,7 @@ 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. @@ -63,7 +61,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a SignedAuditEvent message event. * <P> - * + * * @param msgFormat The message string. */ public SignedAuditEvent(String msgFormat) { @@ -73,11 +71,12 @@ 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. */ @@ -91,6 +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, + * * <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,6 +112,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Constructs a message from a base exception. This will use the msgFormat * from the exception itself. + * * <PRE> * try { * ... @@ -120,7 +121,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception. */ public SignedAuditEvent(Exception e) { @@ -137,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. * <P> - * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -149,7 +150,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return Details message. */ public String getMessage() { @@ -160,7 +161,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * 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() { @@ -171,7 +172,7 @@ public class SignedAuditEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent() { @@ -181,7 +182,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ @@ -192,8 +193,9 @@ public class SignedAuditEvent implements IBundleLogEvent { } /** - * Sets the resource bundle name for this class instance. This should + * 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) { @@ -202,6 +204,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves bundle name. + * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -212,6 +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() { @@ -220,6 +224,7 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Sets log source. + * * @param source Integer id of log source. */ public void setSource(int source) { @@ -230,15 +235,16 @@ 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() { return mLevel; } - /** * Retrieves NT specific log event type. + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -249,6 +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) { @@ -279,8 +286,9 @@ 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. + * A multiline message simply consists of more than one line. */ public boolean getMultiline() { return mMultiline; @@ -289,35 +297,36 @@ 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) { 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. + * * @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. + * * @param eventType String containing the type of event. */ public void setEventType(String eventType) { @@ -325,9 +334,10 @@ 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 83026323..9f625cdf 100644 --- a/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java +++ b/pki/base/common/src/com/netscape/certsrv/logging/SystemEvent.java @@ -17,19 +17,17 @@ // --- 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. - * + * which need to be logged to a log file. + * * @version $Revision$, $Date$ * @see java.text.MessageFormat * @see com.netscape.certsrv.logging.LogResources @@ -56,12 +54,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) { @@ -71,11 +69,12 @@ 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. */ @@ -89,6 +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, + * * <PRE> * try { * ... @@ -97,7 +97,7 @@ public class SystemEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param msgFormat Exception details in message string format. * @param exception System exception. */ @@ -110,6 +110,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Constructs a SystemEvent message from a base exception. This will use the msgFormat * from the exception itself. + * * <PRE> * try { * ... @@ -118,7 +119,7 @@ public class SystemEvent implements IBundleLogEvent { * } * </PRE> * <P> - * + * * @param e CMS exception. */ public SystemEvent(Exception e) { @@ -135,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. * <P> - * + * * @param msgFormat Message string format. * @param params List of message format parameters. */ @@ -147,7 +148,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the current message format string. * <P> - * + * * @return Details message. */ public String getMessage() { @@ -158,7 +159,7 @@ public class SystemEvent implements IBundleLogEvent { * 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,7 +170,7 @@ public class SystemEvent implements IBundleLogEvent { * Returns localized message string. This method should * only be called if a localized string is necessary. * <P> - * + * * @return Details message. */ public String toContent() { @@ -179,7 +180,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Returns the string based on the given locale. * <P> - * + * * @param locale Locale. * @return Details message. */ @@ -190,8 +191,9 @@ public class SystemEvent implements IBundleLogEvent { } /** - * Sets the resource bundle name for this class instance. This should + * 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,6 +202,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves bundle name. + * * @return String with name of resource bundle. */ protected String getBundleName() { @@ -210,6 +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() { @@ -219,6 +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) { @@ -229,6 +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() { @@ -237,6 +243,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves NT specific log event type. + * * @return Integer NTEventType value. */ public int getNTEventType() { @@ -246,7 +253,8 @@ 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. + * set as well. + * * @param level Integer log level value. */ public void setLevel(int level) { @@ -277,8 +285,9 @@ 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. + * A multiline message simply consists of more than one line. */ public boolean getMultiline() { return mMultiline; @@ -287,6 +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) { @@ -295,6 +305,7 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves event time stamp. + * * @return Long integer of the time the event was created. */ public long getTimeStamp() { @@ -304,16 +315,17 @@ 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() { return mEventType; } - /** * 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) { @@ -321,9 +333,10 @@ 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); |