diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java | 124 |
1 files changed, 59 insertions, 65 deletions
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); |