summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/logging/SystemEvent.java
diff options
context:
space:
mode:
Diffstat (limited to 'base/common/src/com/netscape/certsrv/logging/SystemEvent.java')
-rw-r--r--base/common/src/com/netscape/certsrv/logging/SystemEvent.java52
1 files changed, 26 insertions, 26 deletions
diff --git a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java
index 9f625cdfd..3704e60ca 100644
--- a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java
+++ b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java
@@ -27,7 +27,7 @@ import com.netscape.certsrv.base.MessageFormatter;
* The log event object that carries a log message.
* This class represents System events which are CMS events
* which need to be logged to a log file.
- *
+ *
* @version $Revision$, $Date$
* @see java.text.MessageFormat
* @see com.netscape.certsrv.logging.LogResources
@@ -59,7 +59,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Constructs a SystemEvent message event.
* <P>
- *
+ *
* @param msgFormat The message string.
*/
public SystemEvent(String msgFormat) {
@@ -69,12 +69,12 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Constructs a SystemEvent message with a parameter. For example,
- *
+ *
* <PRE>
* new SystemEvent(&quot;failed to load {0}&quot;, fileName);
* </PRE>
* <P>
- *
+ *
* @param msgFormat Details in message string format.
* @param param Message string parameter.
*/
@@ -88,7 +88,7 @@ public class SystemEvent implements IBundleLogEvent {
* Constructs a SystemEvent message from an exception. It can be used to carry
* a system exception that may contain information about
* the context. For example,
- *
+ *
* <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,7 +110,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Constructs a SystemEvent message from a base exception. This will use the msgFormat
* from the exception itself.
- *
+ *
* <PRE>
* try {
* ...
@@ -119,7 +119,7 @@ public class SystemEvent implements IBundleLogEvent {
* }
* </PRE>
* <P>
- *
+ *
* @param e CMS exception.
*/
public SystemEvent(Exception e) {
@@ -136,7 +136,7 @@ public class SystemEvent implements IBundleLogEvent {
* Constructs a SystemEvent message event with a list of parameters
* that will be substituted into the message format.
* <P>
- *
+ *
* @param msgFormat Message string format.
* @param params List of message format parameters.
*/
@@ -148,7 +148,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Returns the current message format string.
* <P>
- *
+ *
* @return Details message.
*/
public String getMessage() {
@@ -159,7 +159,7 @@ public class SystemEvent implements IBundleLogEvent {
* Returns a list of parameters. These parameters can be
* used to assist in formatting the message.
* <P>
- *
+ *
* @return List of message format parameters.
*/
public Object[] getParameters() {
@@ -170,7 +170,7 @@ public class SystemEvent implements IBundleLogEvent {
* Returns localized message string. This method should
* only be called if a localized string is necessary.
* <P>
- *
+ *
* @return Details message.
*/
public String toContent() {
@@ -180,7 +180,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Returns the string based on the given locale.
* <P>
- *
+ *
* @param locale Locale.
* @return Details message.
*/
@@ -193,7 +193,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Sets the resource bundle name for this class instance. This should
* be overridden by subclasses who have their own resource bundles.
- *
+ *
* @param bundle String with the name of resource bundle.
*/
public void setBundleName(String bundle) {
@@ -202,7 +202,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Retrieves bundle name.
- *
+ *
* @return String with name of resource bundle.
*/
protected String getBundleName() {
@@ -213,7 +213,7 @@ public class SystemEvent implements IBundleLogEvent {
* Retrieves log source.
* This is an id of the subsystem responsible
* for creating the log event.
- *
+ *
* @return Integer source id.
*/
public int getSource() {
@@ -223,7 +223,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Sets log source.
* Sets the id of the subsystem issuing the event.
- *
+ *
* @param source Integer source id.
*/
public void setSource(int source) {
@@ -234,7 +234,7 @@ public class SystemEvent implements IBundleLogEvent {
* Retrieves log level.
* The log level of an event represents its relative importance
* or severity within CMS.
- *
+ *
* @return Integer log level value.
*/
public int getLevel() {
@@ -243,7 +243,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Retrieves NT specific log event type.
- *
+ *
* @return Integer NTEventType value.
*/
public int getNTEventType() {
@@ -254,7 +254,7 @@ public class SystemEvent implements IBundleLogEvent {
* Sets log level, NT log event type.
* For certain log levels the NT log event type gets
* set as well.
- *
+ *
* @param level Integer log level value.
*/
public void setLevel(int level) {
@@ -285,7 +285,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Retrieves log multiline attribute.
- *
+ *
* @return Boolean whether or not this event is multiline.
* A multiline message simply consists of more than one line.
*/
@@ -296,7 +296,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Sets log multiline attribute. A multiline message consists of
* more than one line.
- *
+ *
* @param multiline Boolean multiline value.
*/
public void setMultiline(boolean multiline) {
@@ -305,7 +305,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Retrieves event time stamp.
- *
+ *
* @return Long integer of the time the event was created.
*/
public long getTimeStamp() {
@@ -315,7 +315,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Retrieves log event type. Each type of event
* has an associated String type value.
- *
+ *
* @return String containing the type of event.
*/
public String getEventType() {
@@ -325,7 +325,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Sets log event type. Each type of event
* has an associated String type value.
- *
+ *
* @param eventType String containing the type of event.
*/
public void setEventType(String eventType) {
@@ -334,7 +334,7 @@ public class SystemEvent implements IBundleLogEvent {
/**
* Return string representation of log message.
- *
+ *
* @return String containing log message.
*/
public String toString() {