Added LogSource enumeration.

A LogSource enumeration has been added to replace the integer
log source in the Logger class.

https://pagure.io/dogtagpki/issue/2689

Change-Id: I6f69219fbbfa00d83f26a32174c75ff2782eb6af

6 files changed, 19 insertions, 13 deletions

diff --git a/base/server/cms/src/com/netscape/cms/logging/LogFile.java b/base/server/cms/src/com/netscape/cms/logging/LogFile.java
index ba5a026ff..d5319ab53 100644
--- a/base/server/cms/src/com/netscape/cms/logging/LogFile.java
+++ b/base/server/cms/src/com/netscape/cms/logging/LogFile.java
@@ -76,6 +76,7 @@ import com.netscape.certsrv.logging.ELogException;
 import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventListener;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogSource;
 import com.netscape.certsrv.logging.SignedAuditEvent;
 import com.netscape.certsrv.logging.SystemEvent;
 import com.netscape.cmsutil.util.Utils;
@@ -1114,12 +1115,12 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
         if (ev.getMultiline() == ILogger.L_MULTILINE) {
             entry = CMS.getPID() + "." + Thread.currentThread().getName() + " - ["
                     + mLogDateFormat.format(mDate) + "] [" +
-                    Integer.toString(ev.getSource()) + "] [" + Integer.toString(ev.getLevel())
+                    ev.getSource().value() + "] [" + Integer.toString(ev.getLevel())
                     + "] " + prepareMultiline(ev.toString());
         } else {
             entry = CMS.getPID() + "." + Thread.currentThread().getName() + " - ["
                     + mLogDateFormat.format(mDate) + "] [" +
-                    Integer.toString(ev.getSource()) + "] [" + Integer.toString(ev.getLevel())
+                    ev.getSource().value() + "] [" + Integer.toString(ev.getLevel())
                     + "] " + ev.toString();
         }
 
@@ -1153,7 +1154,7 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
      * @param fName The log file name to be read. If it's null, read the current
      *            log file
      */
-    public Vector<LogEntry> readEntry(int maxLine, int lowLevel, int source, String fName) {
+    public Vector<LogEntry> readEntry(int maxLine, int lowLevel, LogSource source, String fName) {
         Vector<LogEntry> mEntries = new Vector<LogEntry>();
         String fileName = mFileName;
         BufferedReader fBuffer;
@@ -1202,7 +1203,7 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
                                 // if parse succeed, write out previous entry
                                 if (preLogEntry != null) {
                                     if ((Integer.parseInt(preLogEntry.getLevel()) >= lowLevel) &&
-                                            ((Integer.parseInt(preLogEntry.getSource()) == source) ||
+                                            ((Integer.parseInt(preLogEntry.getSource()) == source.value()) ||
                                             (source == ILogger.S_ALL)
                                             )) {
                                         mEntries.addElement(preLogEntry);
@@ -1255,7 +1256,7 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
                      */
                     if (preLogEntry != null) {
                         if ((Integer.parseInt(preLogEntry.getLevel()) >= lowLevel) &&
-                                ((Integer.parseInt(preLogEntry.getSource()) == source) ||
+                                ((Integer.parseInt(preLogEntry.getSource()) == source.value()) ||
                                 (source == ILogger.S_ALL)
                                 )) {
                             mEntries.addElement(preLogEntry);
@@ -1276,7 +1277,7 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
                 if (preLogEntry != null) {
                     if ((Integer.parseInt(preLogEntry.getLevel()) >= lowLevel)
                             &&
-                            ((Integer.parseInt(preLogEntry.getSource()) == source)
+                            ((Integer.parseInt(preLogEntry.getSource()) == source.value())
                             ||
                             (source == ILogger.S_ALL)
                             )) {
@@ -1330,7 +1331,8 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
             IOException, EBaseException {
         NameValuePairs params = new NameValuePairs();
         String tmp, fName = null;
-        int maxLine = -1, level = -1, source = -1;
+        int maxLine = -1, level = -1;
+        LogSource source = null;
         Vector<LogEntry> entries = null;
 
         if ((tmp = req.get(Constants.PR_LOG_ENTRY)) != null) {
@@ -1340,7 +1342,7 @@ public class LogFile implements ILogEventListener, IExtendedPluginInfo {
             level = Integer.parseInt(tmp);
         }
         if ((tmp = req.get(Constants.PR_LOG_SOURCE)) != null) {
-            source = Integer.parseInt(tmp);
+            source = LogSource.valueOf(Integer.parseInt(tmp));
         }
         tmp = req.get(Constants.PR_LOG_NAME);
         if (!(tmp.equals(Constants.PR_CURRENT_LOG))) {
diff --git a/base/server/cms/src/com/netscape/cms/servlet/base/CMSServlet.java b/base/server/cms/src/com/netscape/cms/servlet/base/CMSServlet.java
index 3b6c55b1c..c10620549 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/base/CMSServlet.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/base/CMSServlet.java
@@ -67,6 +67,7 @@ import com.netscape.certsrv.kra.IKeyRecoveryAuthority;
 import com.netscape.certsrv.logging.AuditEvent;
 import com.netscape.certsrv.logging.ILogger;
 import com.netscape.certsrv.logging.LogCategory;
+import com.netscape.certsrv.logging.LogSource;
 import com.netscape.certsrv.logging.event.AuthFailEvent;
 import com.netscape.certsrv.logging.event.AuthSuccessEvent;
 import com.netscape.certsrv.logging.event.AuthzFailEvent;
@@ -236,7 +237,7 @@ public abstract class CMSServlet extends HttpServlet {
 
     // system logger.
     protected ILogger mLogger = CMS.getLogger();
-    protected int mLogCategory = ILogger.S_OTHER;
+    protected LogSource mLogCategory = ILogger.S_OTHER;
     private MessageDigest mSHADigest = null;
 
     protected String mGetClientCert = "false";
diff --git a/base/server/cms/src/com/netscape/cms/servlet/base/SubsystemService.java b/base/server/cms/src/com/netscape/cms/servlet/base/SubsystemService.java
index 2bcde64e9..40a8791ed 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/base/SubsystemService.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/base/SubsystemService.java
@@ -31,6 +31,7 @@ import com.netscape.certsrv.authorization.IAuthzSubsystem;
 import com.netscape.certsrv.logging.AuditEvent;
 import com.netscape.certsrv.logging.IAuditor;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogSource;
 
 public class SubsystemService extends PKIService {
 
@@ -72,7 +73,7 @@ public class SubsystemService extends PKIService {
         return CMS.getUserMessage(getLocale(headers), messageId, params);
     }
 
-    public void log(int source, int level, String message) {
+    public void log(LogSource source, int level, String message) {
 
         logger.log(ILogger.EV_SYSTEM,
                 null,
diff --git a/base/server/cms/src/com/netscape/cms/servlet/common/CMSFile.java b/base/server/cms/src/com/netscape/cms/servlet/common/CMSFile.java
index 7f73ce8d3..863a75fd4 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/common/CMSFile.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/common/CMSFile.java
@@ -85,7 +85,7 @@ public class CMSFile {
     }
 
     protected void log(int level, String msg) {
-        mLogger.log(ILogger.EV_SYSTEM, level, ILogger.S_OTHER, "CMSgateway:" + msg);
+        mLogger.log(ILogger.EV_SYSTEM, ILogger.S_OTHER, level, "CMSgateway:" + msg);
     }
 
     public String toString() {
diff --git a/base/server/cms/src/com/netscape/cms/servlet/processors/Processor.java b/base/server/cms/src/com/netscape/cms/servlet/processors/Processor.java
index ffe707cd9..2648a4bc4 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/processors/Processor.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/processors/Processor.java
@@ -12,6 +12,7 @@ import com.netscape.certsrv.base.EBaseException;
 import com.netscape.certsrv.base.EPropertyNotFound;
 import com.netscape.certsrv.logging.IAuditor;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogSource;
 
 public class Processor {
 
@@ -60,7 +61,7 @@ public class Processor {
         return map;
     }
 
-    public void log(int source, int level, String message) {
+    public void log(LogSource source, int level, String message) {
 
         if (logger == null) return;
 
diff --git a/base/server/cms/src/com/netscape/cms/servlet/profile/ProfileServlet.java b/base/server/cms/src/com/netscape/cms/servlet/profile/ProfileServlet.java
index 589423b01..233d9a710 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/profile/ProfileServlet.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/profile/ProfileServlet.java
@@ -37,6 +37,7 @@ import com.netscape.certsrv.authorization.IAuthzSubsystem;
 import com.netscape.certsrv.base.EBaseException;
 import com.netscape.certsrv.logging.ILogger;
 import com.netscape.certsrv.logging.LogCategory;
+import com.netscape.certsrv.logging.LogSource;
 import com.netscape.certsrv.template.ArgList;
 import com.netscape.certsrv.template.ArgSet;
 import com.netscape.certsrv.template.ArgString;
@@ -156,7 +157,7 @@ public class ProfileServlet extends CMSServlet {
     protected String mAclMethod = null;
     protected String mAuthzResourceName = null;
     protected ILogger mLogger = CMS.getLogger();
-    protected int mLogCategory = ILogger.S_OTHER;
+    protected LogSource mLogCategory = ILogger.S_OTHER;
     protected String mProfileSubId = null;
 
     protected ILogger mSignedAuditLogger = CMS.getSignedAuditLogger();