Added LogCategory enumeration.

A LogCategory enumeration has been added to replace the integer
log category in the Logger class.

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

Change-Id: Ic92e64c3abdf859841eaf1006afc61bbf573086d

9 files changed, 56 insertions, 47 deletions

diff --git a/base/server/cms/src/com/netscape/cms/ocsp/DefStore.java b/base/server/cms/src/com/netscape/cms/ocsp/DefStore.java
index a0aefa99a..c684977d0 100644
--- a/base/server/cms/src/com/netscape/cms/ocsp/DefStore.java
+++ b/base/server/cms/src/com/netscape/cms/ocsp/DefStore.java
@@ -50,6 +50,7 @@ import com.netscape.certsrv.dbs.crldb.ICRLIssuingPointRecord;
 import com.netscape.certsrv.dbs.repository.IRepositoryRecord;
 import com.netscape.certsrv.logging.AuditFormat;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogCategory;
 import com.netscape.certsrv.ocsp.IDefStore;
 import com.netscape.certsrv.ocsp.IOCSPAuthority;
 import com.netscape.certsrv.util.IStatsSubsystem;
@@ -284,7 +285,7 @@ public class DefStore implements IDefStore, IExtendedPluginInfo {
         }
     }
 
-    public void log(int event, int level, String msg) {
+    public void log(LogCategory event, int level, String msg) {
         mOCSPAuthority.log(event, level, msg);
     }
 
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 65dc06aa3..3b6c55b1c 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
@@ -66,6 +66,7 @@ import com.netscape.certsrv.dbs.certdb.ICertificateRepository;
 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.event.AuthFailEvent;
 import com.netscape.certsrv.logging.event.AuthSuccessEvent;
 import com.netscape.certsrv.logging.event.AuthzFailEvent;
@@ -936,7 +937,7 @@ public abstract class CMSServlet extends HttpServlet {
     /**
      * log according to authority category.
      */
-    protected void log(int event, int level, String msg) {
+    protected void log(LogCategory event, int level, String msg) {
         mLogger.log(event, mLogCategory, level,
                 "Servlet " + mId + ": " + msg);
     }
diff --git a/base/server/cms/src/com/netscape/cms/servlet/processors/PKIProcessor.java b/base/server/cms/src/com/netscape/cms/servlet/processors/PKIProcessor.java
index e6ee2db90..e60c30a27 100644
--- a/base/server/cms/src/com/netscape/cms/servlet/processors/PKIProcessor.java
+++ b/base/server/cms/src/com/netscape/cms/servlet/processors/PKIProcessor.java
@@ -32,6 +32,7 @@ import com.netscape.certsrv.base.SessionContext;
 import com.netscape.certsrv.common.ICMSRequest;
 import com.netscape.certsrv.logging.AuditEvent;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogCategory;
 import com.netscape.certsrv.request.IRequest;
 import com.netscape.cms.servlet.base.CMSServlet;
 import com.netscape.cms.servlet.common.ECMSGWException;
@@ -283,7 +284,7 @@ public class PKIProcessor implements IPKIProcessor {
     /**
      * log according to authority category.
      */
-    public static void log(int event, int level, String msg) {
+    public static void log(LogCategory event, int level, String msg) {
         CMS.getLogger().log(event, ILogger.S_OTHER, level,
                 "PKIProcessor " + ": " + msg);
     }
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 614565140..589423b01 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
@@ -36,6 +36,7 @@ import com.netscape.certsrv.apps.CMS;
 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.template.ArgList;
 import com.netscape.certsrv.template.ArgSet;
 import com.netscape.certsrv.template.ArgString;
@@ -455,7 +456,7 @@ public class ProfileServlet extends CMSServlet {
     /**
      * log according to authority category.
      */
-    protected void log(int event, int level, String msg) {
+    protected void log(LogCategory event, int level, String msg) {
         mLogger.log(event, mLogCategory, level,
                 "Servlet " + mId + ": " + msg);
     }
diff --git a/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java b/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java
index fea638eb6..171b21dd8 100644
--- a/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java
+++ b/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java
@@ -20,6 +20,7 @@ package com.netscape.cmscore.logging;
 import java.util.Properties;
 
 import com.netscape.certsrv.logging.AuditEvent;
+import com.netscape.certsrv.logging.LogCategory;
 import com.netscape.certsrv.logging.IBundleLogEvent;
 import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventFactory;
@@ -57,7 +58,7 @@ public class AuditEventFactory implements ILogEventFactory {
      * @param msg the detail message of the log
      * @param params the parameters in the detail log message
      */
-    public ILogEvent create(int evtClass, Properties prop, int source,
+    public ILogEvent create(LogCategory evtClass, Properties prop, int source,
             int level, boolean multiline, String msg, Object params[]) {
         if (evtClass != ILogger.EV_AUDIT)
             return null;
diff --git a/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java b/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java
index c1c6e4af0..0d96e32c8 100644
--- a/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java
+++ b/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java
@@ -24,6 +24,7 @@ import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventFactory;
 import com.netscape.certsrv.logging.ILogQueue;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogCategory;
 
 /**
  * A class represents certificate server logger
@@ -38,7 +39,7 @@ public class Logger implements ILogger {
 
     protected static Logger mLogger = new Logger();
     protected ILogQueue mLogQueue = LogQueue.getLogQueue();
-    protected Hashtable<Integer, ILogEventFactory> mFactories = new Hashtable<Integer, ILogEventFactory>();
+    protected Hashtable<LogCategory, ILogEventFactory> mFactories = new Hashtable<LogCategory, ILogEventFactory>();
 
     /**
      * Constructs a generic logger, and registers a list
@@ -71,7 +72,7 @@ public class Logger implements ILogger {
      * @param evtClass the event class name: ILogger.EV_SYSTEM or ILogger.EV_AUDIT
      * @param f the event factory name
      */
-    public void register(int evtClass, ILogEventFactory f) {
+    public void register(LogCategory evtClass, ILogEventFactory f) {
         mFactories.put(evtClass, f);
     }
 
@@ -83,7 +84,7 @@ public class Logger implements ILogger {
      * @param source the source of the log event
      * @param msg the one line detail message to be logged
      */
-    public void log(int evtClass, int source, String msg) {
+    public void log(LogCategory evtClass, int source, String msg) {
         log(evtClass, null, source, ILogger.LL_INFO, msg, null);
     }
 
@@ -95,7 +96,7 @@ public class Logger implements ILogger {
      * @param source the source of the log event
      * @param msg the one line detail message to be logged
      */
-    public void log(int evtClass, Properties props, int source, String msg) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg) {
         log(evtClass, props, source, ILogger.LL_INFO, msg, null);
     }
 
@@ -109,7 +110,7 @@ public class Logger implements ILogger {
      * @param level the level of the log event
      * @param msg the one line detail message to be logged
      */
-    public void log(int evtClass, int source, int level, String msg) {
+    public void log(LogCategory evtClass, int source, int level, String msg) {
         log(evtClass, null, source, level, msg, null);
     }
 
@@ -122,7 +123,7 @@ public class Logger implements ILogger {
      * @param level the level of the log event
      * @param msg the one line detail message to be logged
      */
-    public void log(int evtClass, Properties props, int source, int level, String msg) {
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg) {
         log(evtClass, props, source, level, msg, null);
     }
 
@@ -137,7 +138,7 @@ public class Logger implements ILogger {
      * @param msg the one line 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(LogCategory evtClass, int source, int level, String msg, Object param) {
         log(evtClass, null, source, level, msg, param);
     }
 
@@ -150,7 +151,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @param param the parameter in the detail message
      */
-    public void log(int evtClass, Properties props, int source, String msg, Object param) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg, Object param) {
         log(evtClass, props, source, ILogger.LL_INFO, msg, param);
     }
 
@@ -164,7 +165,7 @@ public class Logger implements ILogger {
      * @param msg the one line 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,
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg,
             Object param) {
         Object o[] = new Object[1];
 
@@ -183,7 +184,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @param params the parameters in the detail message
      */
-    public void log(int evtClass, int source, int level, String msg,
+    public void log(LogCategory evtClass, int source, int level, String msg,
             Object params[]) {
         log(evtClass, null, source, level, msg, params);
     }
@@ -199,7 +200,7 @@ public class Logger implements ILogger {
      * @param msg the one line 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,
+    public void log(LogCategory evtClass, Properties prop, int source, int level, String msg,
             Object params[]) {
         ILogEvent iLEvent = create(evtClass, prop, source, level, msg, params, ILogger.L_SINGLELINE);
         if (iLEvent != null)
@@ -216,7 +217,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @param multiline true if the message has more than one line, otherwise false
      */
-    public void log(int evtClass, int source, String msg, boolean multiline) {
+    public void log(LogCategory evtClass, int source, String msg, boolean multiline) {
         log(evtClass, null, source, ILogger.LL_INFO, msg, null, multiline);
     }
 
@@ -229,7 +230,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @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(LogCategory evtClass, Properties props, int source, String msg, boolean multiline) {
         log(evtClass, props, source, ILogger.LL_INFO, msg, null, multiline);
     }
 
@@ -244,7 +245,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @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(LogCategory evtClass, int source, int level, String msg, boolean multiline) {
         log(evtClass, null, source, level, msg, null, multiline);
     }
 
@@ -258,7 +259,7 @@ public class Logger implements ILogger {
      * @param msg the one line detail message to be logged
      * @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(LogCategory evtClass, Properties props, int source, int level, String msg, boolean multiline) {
         log(evtClass, props, source, level, msg, null, multiline);
     }
 
@@ -274,7 +275,7 @@ public class Logger implements ILogger {
      * @param param the parameter in the detail message
      * @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(LogCategory evtClass, int source, int level, String msg, Object param, boolean multiline) {
         log(evtClass, null, source, level, msg, param, multiline);
     }
 
@@ -288,7 +289,7 @@ public class Logger implements ILogger {
      * @param param the parameter in the detail message
      * @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(LogCategory evtClass, Properties props, int source, String msg, Object param, boolean multiline) {
         log(evtClass, props, source, ILogger.LL_INFO, msg, param, multiline);
     }
 
@@ -303,7 +304,7 @@ public class Logger implements ILogger {
      * @param param the parameter in the detail message
      * @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,
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg,
             Object param, boolean multiline) {
         Object o[] = new Object[1];
 
@@ -323,7 +324,7 @@ public class Logger implements ILogger {
      * @param params the parameters in the detail message
      * @param multiline true if the message has more than one line, otherwise false
      */
-    public void log(int evtClass, int source, int level, String msg,
+    public void log(LogCategory evtClass, int source, int level, String msg,
             Object params[], boolean multiline) {
         log(evtClass, null, source, level, msg, params, multiline);
     }
@@ -340,7 +341,7 @@ public class Logger implements ILogger {
      * @param params the parameters in the detail message
      * @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,
+    public void log(LogCategory evtClass, Properties prop, int source, int level, String msg,
             Object params[], boolean multiline) {
         ILogEvent iLEvent = create(evtClass, prop, source, level, msg, params, multiline);
         if (iLEvent != null)
@@ -354,7 +355,7 @@ public class Logger implements ILogger {
      * events here.
      */
     //XXXXXXXXXXX prop is out dated!!!! XXXXXXXXXXXXXXX
-    public ILogEvent create(int evtClass, Properties prop, int source, int level,
+    public ILogEvent create(LogCategory evtClass, Properties prop, int source, int level,
             String msg, Object params[], boolean multiline) {
         ILogEventFactory f = mFactories.get(evtClass);
 
diff --git a/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java b/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java
index 01f999120..34c9be630 100644
--- a/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java
+++ b/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java
@@ -19,6 +19,7 @@ package com.netscape.cmscore.logging;
 
 import java.util.Properties;
 
+import com.netscape.certsrv.logging.LogCategory;
 import com.netscape.certsrv.logging.IBundleLogEvent;
 import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventFactory;
@@ -59,7 +60,7 @@ public class SignedAuditEventFactory implements ILogEventFactory {
      * @param msg the detail message of the log
      * @param params the parameters in the detail log message
      */
-    public ILogEvent create(int evtClass, Properties prop, int source,
+    public ILogEvent create(LogCategory evtClass, Properties prop, int source,
             int level, boolean multiline, String msg, Object params[]) {
         if (evtClass != ILogger.EV_SIGNED_AUDIT)
             return null;
diff --git a/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java b/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java
index 6821fac6f..ce5fa6370 100644
--- a/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java
+++ b/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java
@@ -19,6 +19,7 @@ package com.netscape.cmscore.logging;
 
 import java.util.Properties;
 
+import com.netscape.certsrv.logging.LogCategory;
 import com.netscape.certsrv.logging.IBundleLogEvent;
 import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventFactory;
@@ -57,7 +58,7 @@ public class SystemEventFactory implements ILogEventFactory {
      * @param msg the detail message of the log
      * @param params the parameters in the detail log message
      */
-    public ILogEvent create(int evtClass, Properties prop, int source,
+    public ILogEvent create(LogCategory evtClass, Properties prop, int source,
             int level, boolean multiline, String msg, Object params[]) {
         if (evtClass != ILogger.EV_SYSTEM)
             return null;
diff --git a/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java b/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java
index 2e558ea53..bc4c90ca2 100644
--- a/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java
+++ b/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java
@@ -6,68 +6,69 @@ import com.netscape.certsrv.logging.ILogEvent;
 import com.netscape.certsrv.logging.ILogEventFactory;
 import com.netscape.certsrv.logging.ILogQueue;
 import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogCategory;
 
 /**
  * Default logging stub for testing.
  */
 public class LoggerDefaultStub implements ILogger {
-    public void log(int evtClass, int source, String msg) {
+    public void log(LogCategory evtClass, int source, String msg) {
     }
 
-    public void log(int evtClass, Properties props, int source, String msg) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg) {
     }
 
-    public void log(int evtClass, int source, int level, String msg) {
+    public void log(LogCategory evtClass, int source, int level, String msg) {
     }
 
-    public void log(int evtClass, Properties props, int source, int level, String msg) {
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg) {
     }
 
-    public void log(int evtClass, int source, int level, String msg, Object param) {
+    public void log(LogCategory evtClass, int source, int level, String msg, Object param) {
     }
 
-    public void log(int evtClass, int source, int level, String msg, Object params[]) {
+    public void log(LogCategory evtClass, int source, int level, String msg, Object params[]) {
     }
 
-    public void log(int evtClass, Properties props, int source, String msg, Object param) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg, Object param) {
     }
 
-    public void log(int evtClass, Properties props, int source, int level, String msg, Object param) {
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg, Object param) {
     }
 
-    public void log(int evtClass, Properties prop, int source, int level, String msg, Object params[]) {
+    public void log(LogCategory evtClass, Properties prop, int source, int level, String msg, Object params[]) {
     }
 
-    public void log(int evtClass, int source, String msg, boolean multiline) {
+    public void log(LogCategory evtClass, int source, String msg, boolean multiline) {
     }
 
-    public void log(int evtClass, Properties props, int source, String msg, boolean multiline) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg, boolean multiline) {
     }
 
-    public void log(int evtClass, int source, int level, String msg, boolean multiline) {
+    public void log(LogCategory evtClass, int source, int level, String msg, boolean multiline) {
     }
 
-    public void log(int evtClass, Properties props, int source, int level, String msg, boolean multiline) {
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg, boolean multiline) {
     }
 
-    public void log(int evtClass, int source, int level, String msg, Object param, boolean multiline) {
+    public void log(LogCategory evtClass, int source, int level, String msg, Object param, boolean multiline) {
     }
 
-    public void log(int evtClass, Properties props, int source, String msg, Object param, boolean multiline) {
+    public void log(LogCategory evtClass, Properties props, int source, String msg, Object param, boolean multiline) {
     }
 
-    public void log(int evtClass, Properties props, int source, int level, String msg, Object param, boolean multiline) {
+    public void log(LogCategory evtClass, Properties props, int source, int level, String msg, Object param, boolean multiline) {
     }
 
-    public void log(int evtClass, Properties prop, int source, int level, String msg, Object params[], boolean multiline) {
+    public void log(LogCategory 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[],
+    public ILogEvent create(LogCategory evtClass, Properties prop, int source, int level, String msg, Object params[],
             boolean multiline) {
         return null;
     }
 
-    public void register(int evtClass, ILogEventFactory f) {
+    public void register(LogCategory evtClass, ILogEventFactory f) {
     }
 
     public ILogQueue getLogQueue() {