Reorganized Logger classes.

Some Logger classes have been moved into com.netscape.cms.logging
due to dependency requirements in subsequent changes.

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

Change-Id: I1e8ec247764d344647a519618a7523c51799f3de

1 files changed, 407 insertions, 0 deletions

diff --git a/base/server/cms/src/com/netscape/cms/logging/Logger.java b/base/server/cms/src/com/netscape/cms/logging/Logger.java
new file mode 100644
index 000000000..ccba6e2a9
--- /dev/null
+++ b/base/server/cms/src/com/netscape/cms/logging/Logger.java
@@ -0,0 +1,407 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; version 2 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.cms.logging;
+
+import java.util.Hashtable;
+import java.util.Properties;
+
+import com.netscape.certsrv.logging.ILogEvent;
+import com.netscape.certsrv.logging.ILogQueue;
+import com.netscape.certsrv.logging.ILogger;
+import com.netscape.certsrv.logging.LogCategory;
+import com.netscape.certsrv.logging.LogSource;
+
+/**
+ * A class represents certificate server logger
+ * implementation.
+ * <P>
+ *
+ * @author thomask
+ * @author mzhao
+ * @version $Revision$, $Date$
+ */
+public class Logger implements ILogger {
+
+    protected static Logger mLogger = new Logger();
+    protected ILogQueue mLogQueue = LogQueue.getLogQueue();
+    protected static Hashtable<LogCategory, LogFactory> mFactories = new Hashtable<LogCategory, LogFactory>();
+
+    static {
+        register(EV_AUDIT, new AuditEventFactory());
+        register(EV_SYSTEM, new SystemEventFactory());
+        register(EV_SIGNED_AUDIT, new SignedAuditEventFactory());
+    }
+
+    LogFactory factory;
+    LogCategory category;
+    LogSource source;
+
+    public Logger() {
+    }
+
+    public Logger(LogFactory factory, LogCategory category, LogSource source) {
+        this.factory = factory;
+        this.category = category;
+        this.source = source;
+    }
+
+    /**
+     * get default single global logger
+     */
+    static public Logger getLogger() {
+        return mLogger;
+    }
+
+    public static Logger getLogger(LogCategory category, LogSource source) {
+
+        LogFactory factory = mFactories.get(category);
+
+        if (factory == null) {
+            throw new RuntimeException("Unknown logger category: " + category);
+        }
+
+        return factory.createLogger(category, source);
+    }
+
+    /**
+     * Retrieves the associated log queue.
+     */
+    public ILogQueue getLogQueue() {
+        return mLogQueue;
+    }
+
+    /**
+     * Registers log factory.
+     *
+     * @param evtClass the event class name: ILogger.EV_SYSTEM or ILogger.EV_AUDIT
+     * @param f the event factory name
+     */
+    public static void register(LogCategory evtClass, LogFactory f) {
+        mFactories.put(evtClass, f);
+    }
+
+    //************** default level ****************
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     */
+    public void log(LogCategory evtClass, LogSource source, String msg) {
+        log(evtClass, null, source, ILogger.LL_INFO, msg, null);
+    }
+
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, String msg) {
+        log(evtClass, props, source, ILogger.LL_INFO, msg, null);
+    }
+
+    //************** no param ****************
+
+    public void log(int level, String msg) {
+        log(category, null, source, level, msg);
+    }
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     */
+    public void log(LogCategory evtClass, LogSource source, int level, String msg) {
+        log(evtClass, null, source, level, msg, null);
+    }
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg) {
+        log(evtClass, props, source, level, msg, null);
+    }
+
+    //********************* one param **********************
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     */
+    public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param) {
+        log(evtClass, null, source, level, msg, param);
+    }
+
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param) {
+        log(evtClass, props, source, ILogger.LL_INFO, msg, param);
+    }
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg,
+            Object param) {
+        Object o[] = new Object[1];
+
+        o[0] = param;
+        log(evtClass, props, source, level, msg, o);
+    }
+
+    //******************* multiple param **************************
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param params the parameters in the detail message
+     */
+    public void log(LogCategory evtClass, LogSource source, int level, String msg,
+            Object params[]) {
+        log(evtClass, null, source, level, msg, params);
+    }
+
+    //*************** the real implementation *****************
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param params the parameters in the detail message
+     */
+    public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg,
+            Object params[]) {
+        ILogEvent iLEvent = create(evtClass, prop, source, level, msg, params, ILogger.L_SINGLELINE);
+        if (iLEvent != null)
+            mLogQueue.log(iLEvent);
+    }
+
+    //******************** multiline log *************************
+    //************** default level ****************
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @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(LogCategory evtClass, LogSource source, String msg, boolean multiline) {
+        log(evtClass, null, source, ILogger.LL_INFO, msg, null, multiline);
+    }
+
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @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(LogCategory evtClass, Properties props, LogSource source, String msg, boolean multiline) {
+        log(evtClass, props, source, ILogger.LL_INFO, msg, null, multiline);
+    }
+
+    //************** no param ****************
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @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(LogCategory evtClass, LogSource source, int level, String msg, boolean multiline) {
+        log(evtClass, null, source, level, msg, null, multiline);
+    }
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @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(LogCategory evtClass, Properties props, LogSource source, int level, String msg, boolean multiline) {
+        log(evtClass, props, source, level, msg, null, multiline);
+    }
+
+    //********************* one param **********************
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     * @param multiline true if the message has more than one line, otherwise false
+     */
+    public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline) {
+        log(evtClass, null, source, level, msg, param, multiline);
+    }
+
+    /**
+     * Logs an event using default log level: ILogger.LL_INFO
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     * @param multiline true if the message has more than one line, otherwise false
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param, boolean multiline) {
+        log(evtClass, props, source, ILogger.LL_INFO, msg, param, multiline);
+    }
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param param the parameter in the detail message
+     * @param multiline true if the message has more than one line, otherwise false
+     */
+    public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg,
+            Object param, boolean multiline) {
+        Object o[] = new Object[1];
+
+        o[0] = param;
+        log(evtClass, props, source, level, msg, o, multiline);
+    }
+
+    //******************* multiple param **************************
+
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param params the parameters in the detail message
+     * @param multiline true if the message has more than one line, otherwise false
+     */
+    public void log(LogCategory evtClass, LogSource source, int level, String msg,
+            Object params[], boolean multiline) {
+        log(evtClass, null, source, level, msg, params, multiline);
+    }
+
+    //*************** the real implementation *****************
+    /**
+     * Logs an event to the log queue.
+     *
+     * @param evtClass What kind of event it is: EV_AUDIT or EV_SYSTEM.
+     * @param props the resource bundle used for the detailed message
+     * @param source the source of the log event
+     * @param level the level of the log event
+     * @param msg the one line detail message to be logged
+     * @param params the parameters in the detail message
+     * @param multiline true if the message has more than one line, otherwise false
+     */
+    public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg,
+            Object params[], boolean multiline) {
+        ILogEvent iLEvent = create(evtClass, prop, source, level, msg, params, multiline);
+        if (iLEvent != null)
+            mLogQueue.log(iLEvent);
+    }
+
+    //******************** end  multiline log *************************
+
+    public ILogEvent create(int level, String msg, Object params[], boolean multiline) {
+        return create(category, null, source, level, msg, params, multiline);
+    }
+
+    /**
+     * Creates generic log event. If required, we can recycle
+     * events here.
+     */
+    //XXXXXXXXXXX prop is out dated!!!! XXXXXXXXXXXXXXX
+    public ILogEvent create(LogCategory evtClass, Properties prop, LogSource source, int level,
+            String msg, Object params[], boolean multiline) {
+
+        LogFactory f = factory == null ? mFactories.get(evtClass) : factory;
+
+        if (f == null) {
+            throw new RuntimeException("Unknown logger category: " + evtClass);
+        }
+
+        return f.create(evtClass, prop, source, level, multiline, msg, params);
+    }
+
+    /**
+     * Notifies logger to reuse the event. This framework
+     * opens up possibility to reuse event.
+     *
+     * @param event a log event
+     */
+    public void release(ILogEvent event) {
+        // do nothing for now.
+    }
+
+}