From 2326a4426218ac1db2885f349d0623490d49d69a Mon Sep 17 00:00:00 2001 From: "Endi S. Dewata" Date: Wed, 21 Jun 2017 22:34:45 +0200 Subject: 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 --- .../com/netscape/certsrv/logging/AuditEvent.java | 10 +-- .../com/netscape/certsrv/logging/ILogEvent.java | 6 +- .../netscape/certsrv/logging/ILogEventFactory.java | 4 +- .../src/com/netscape/certsrv/logging/ILogger.java | 74 +++++++++++----------- .../com/netscape/certsrv/logging/LogSource.java | 59 +++++++++++++++++ .../netscape/certsrv/logging/SignedAuditEvent.java | 12 ++-- .../com/netscape/certsrv/logging/SystemEvent.java | 12 ++-- .../cms/src/com/netscape/cms/logging/LogFile.java | 18 +++--- .../com/netscape/cms/servlet/base/CMSServlet.java | 3 +- .../cms/servlet/base/SubsystemService.java | 3 +- .../com/netscape/cms/servlet/common/CMSFile.java | 2 +- .../netscape/cms/servlet/processors/Processor.java | 3 +- .../cms/servlet/profile/ProfileServlet.java | 3 +- .../cmscore/logging/AuditEventFactory.java | 5 +- .../src/com/netscape/cmscore/logging/Logger.java | 39 ++++++------ .../cmscore/logging/SignedAuditEventFactory.java | 5 +- .../cmscore/logging/SystemEventFactory.java | 5 +- .../cmscore/logging/LoggerDefaultStub.java | 37 +++++------ 18 files changed, 185 insertions(+), 115 deletions(-) create mode 100644 base/common/src/com/netscape/certsrv/logging/LogSource.java (limited to 'base') diff --git a/base/common/src/com/netscape/certsrv/logging/AuditEvent.java b/base/common/src/com/netscape/certsrv/logging/AuditEvent.java index 1d94dad16..0a42343c6 100644 --- a/base/common/src/com/netscape/certsrv/logging/AuditEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/AuditEvent.java @@ -228,7 +228,7 @@ public class AuditEvent implements IBundleLogEvent { private String mMessage = null; private int mLevel = -1; private int mNTEventType = -1; - private int mSource = -1; + private LogSource mSource; private boolean mMultiline = false; private long mTimeStamp = System.currentTimeMillis(); @@ -399,20 +399,20 @@ public class AuditEvent implements IBundleLogEvent { /** * Retrieves log source. * - * @return an integer that indicates the component source + * @return the component source * where this message event was triggered */ - public int getSource() { + public LogSource getSource() { return mSource; } /** * Sets log source. * - * @param source an integer that represents the component source + * @param source the component source * where this message event was triggered */ - public void setSource(int source) { + public void setSource(LogSource source) { mSource = source; } diff --git a/base/common/src/com/netscape/certsrv/logging/ILogEvent.java b/base/common/src/com/netscape/certsrv/logging/ILogEvent.java index 865d3dc9a..a0e641564 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogEvent.java @@ -41,12 +41,12 @@ public interface ILogEvent extends Serializable { /** * Retrieves log source. - * This is an id of the subsystem responsible + * This is the subsystem responsible * for creating the log event. * - * @return Integer source id. + * @return log source. */ - public int getSource(); + public LogSource getSource(); /** * Retrieves log level. diff --git a/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java b/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java index 1cc48a502..e61abba1b 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogEventFactory.java @@ -33,14 +33,14 @@ public interface ILogEventFactory { * * @param evtClass The event type. * @param prop The resource bundle. - * @param source The subsystem ID who creates the log event. + * @param source The subsystem who creates the log event. * @param level The severity of the log event. * @param multiline The log message has more than one line or not. * @param msg The detail message of the log. * @param params The parameters in the detail log message. * @return The created ILogEvent object. */ - public ILogEvent create(LogCategory evtClass, Properties prop, int source, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource source, int level, boolean multiline, String msg, Object params[]); /** diff --git a/base/common/src/com/netscape/certsrv/logging/ILogger.java b/base/common/src/com/netscape/certsrv/logging/ILogger.java index 633f668b8..f3e365f95 100644 --- a/base/common/src/com/netscape/certsrv/logging/ILogger.java +++ b/base/common/src/com/netscape/certsrv/logging/ILogger.java @@ -56,91 +56,91 @@ public interface ILogger { /** * log source: used by servlet to retrieve all logs */ - public static final int S_ALL = 0; //used by servlet only + public static final LogSource S_ALL = LogSource.ALL; //used by servlet only /** * log source: identify the log entry is from KRA */ - public static final int S_KRA = 1; + public static final LogSource S_KRA = LogSource.KRA; /** * log source: identify the log entry is from RA */ - public static final int S_RA = 2; + public static final LogSource S_RA = LogSource.RA; /** * log source: identify the log entry is from CA */ - public static final int S_CA = 3; + public static final LogSource S_CA = LogSource.CA; /** * log source: identify the log entry is from http subsystem */ - public static final int S_HTTP = 4; + public static final LogSource S_HTTP = LogSource.HTTP; /** * log source: identify the log entry is from database subsystem */ - public static final int S_DB = 5; + public static final LogSource S_DB = LogSource.DB; /** * log source: identify the log entry is from authentication subsystem */ - public static final int S_AUTHENTICATION = 6; + public static final LogSource S_AUTHENTICATION = LogSource.AUTHENTICATION; /** * log source: identify the log entry is from admin subsystem */ - public static final int S_ADMIN = 7; + public static final LogSource S_ADMIN = LogSource.ADMIN; /** * log source: identify the log entry is from ldap subsystem */ - public static final int S_LDAP = 8; + public static final LogSource S_LDAP = LogSource.LDAP; /** * log source: identify the log entry is from request queue subsystem */ - public static final int S_REQQUEUE = 9; + public static final LogSource S_REQQUEUE = LogSource.REQQUEUE; /** * log source: identify the log entry is from acl subsystem */ - public static final int S_ACLS = 10; + public static final LogSource S_ACLS = LogSource.ACLS; /** * log source: identify the log entry is from usergrp subsystem */ - public static final int S_USRGRP = 11; - public static final int S_OCSP = 12; + public static final LogSource S_USRGRP = LogSource.USRGRP; + public static final LogSource S_OCSP = LogSource.OCSP; /** * log source: identify the log entry is from authorization subsystem */ - public static final int S_AUTHORIZATION = 13; + public static final LogSource S_AUTHORIZATION = LogSource.AUTHORIZATION; /** * log source: identify the log entry is from signed audit */ - public static final int S_SIGNED_AUDIT = 14; + public static final LogSource S_SIGNED_AUDIT = LogSource.SIGNED_AUDIT; /** * log source: identify the log entry is from CrossCertPair subsystem */ - public static final int S_XCERT = 15; + public static final LogSource S_XCERT = LogSource.XCERT; /** * log source: identify the log entry is from CrossCertPair subsystem */ - public static final int S_TKS = 16; - public static final int S_TPS = 17; + public static final LogSource S_TKS = LogSource.TKS; + public static final LogSource S_TPS = LogSource.TPS; /** * log source: identify the log entry is from other subsystem * eg. policy, security, connector,registration */ - public static final int S_OTHER = 20; + public static final LogSource S_OTHER = LogSource.OTHER; // List of defined log levels. /** @@ -275,7 +275,7 @@ public interface ILogger { * @param source The source of the log event. * @param msg The detail message to be logged. */ - public void log(LogCategory evtClass, int source, String msg); + public void log(LogCategory evtClass, LogSource source, String msg); /** * Logs an event to the log queue. @@ -285,7 +285,7 @@ public interface ILogger { * @param source The source of the log event. * @param msg The detail message to be logged. */ - public void log(LogCategory evtClass, Properties props, int source, String msg); + public void log(LogCategory evtClass, Properties props, LogSource source, String msg); /** * Logs an event to the log queue. @@ -295,7 +295,7 @@ public interface ILogger { * @param level The level of the log event. * @param msg The detail message to be logged. */ - public void log(LogCategory evtClass, int source, int level, String msg); + public void log(LogCategory evtClass, LogSource source, int level, String msg); /** * Logs an event to the log queue. @@ -306,7 +306,7 @@ public interface ILogger { * @param level The level of the log event. * @param msg The detail message to be logged. */ - public void log(LogCategory evtClass, Properties props, int source, int level, String msg); + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg); /** * Logs an event to the log queue. @@ -317,7 +317,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param param The parameter in the detail message. */ - public void log(LogCategory evtClass, int source, int level, String msg, Object param); + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param); /** * Logs an event to the log queue. @@ -328,7 +328,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param params The parameters in the detail message. */ - public void log(LogCategory evtClass, int source, int level, String msg, Object params[]); + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object params[]); /** * Logs an event to the log queue. @@ -339,7 +339,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param param The parameters in the detail message. */ - public void log(LogCategory evtClass, Properties props, int source, String msg, Object param); + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param); /** * Logs an event to the log queue. @@ -351,7 +351,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param param The parameter in the detail message. */ - public void log(LogCategory evtClass, Properties props, int source, int level, String msg, + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param); /** @@ -364,7 +364,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param params The parameters in the detail message. */ - public void log(LogCategory evtClass, Properties prop, int source, int level, String msg, + public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[]); //multiline log @@ -377,7 +377,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param multiline true If the message has more than one line, otherwise false. */ - public void log(LogCategory evtClass, int source, String msg, boolean multiline); + public void log(LogCategory evtClass, LogSource source, String msg, boolean multiline); /** * Logs an event to the log queue. @@ -388,7 +388,7 @@ public interface ILogger { * @param msg The 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, int source, String msg, boolean multiline); + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, boolean multiline); /** * Logs an event to the log queue. @@ -399,7 +399,7 @@ public interface ILogger { * @param msg The detail message to be logged. * @param multiline True if the message has more than one line, otherwise false. */ - public void log(LogCategory evtClass, int source, int level, String msg, boolean multiline); + public void log(LogCategory evtClass, LogSource source, int level, String msg, boolean multiline); /** * Logs an event to the log queue. @@ -411,7 +411,7 @@ public interface ILogger { * @param msg The 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, int source, int level, String msg, boolean multiline); + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, boolean multiline); /** * Logs an event to the log queue. @@ -423,7 +423,7 @@ public interface 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(LogCategory evtClass, int source, int level, String msg, Object param, boolean multiline); + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline); /** * Logs an event to the log queue. @@ -435,7 +435,7 @@ public interface 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(LogCategory evtClass, Properties props, int source, String msg, Object param, boolean multiline); + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param, boolean multiline); /** * Logs an event to the log queue. @@ -448,7 +448,7 @@ public interface 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(LogCategory evtClass, Properties props, int source, int level, String msg, + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param, boolean multiline); /** @@ -462,7 +462,7 @@ public interface 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(LogCategory evtClass, Properties prop, int source, int level, String msg, + public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[], boolean multiline); /* @@ -476,7 +476,7 @@ public interface ILogger { * @param multiline True if the message has more than one line, otherwise false. * @return ILogEvent, a log event. */ - public ILogEvent create(LogCategory evtClass, Properties prop, int source, int level, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[], boolean multiline); /** diff --git a/base/common/src/com/netscape/certsrv/logging/LogSource.java b/base/common/src/com/netscape/certsrv/logging/LogSource.java new file mode 100644 index 000000000..a7efeb1ea --- /dev/null +++ b/base/common/src/com/netscape/certsrv/logging/LogSource.java @@ -0,0 +1,59 @@ +// --- 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) 2017 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.certsrv.logging; + +public enum LogSource { + ALL (0), + KRA (1), + RA (2), + CA (3), + HTTP (4), + DB (5), + AUTHENTICATION (6), + ADMIN (7), + LDAP (8), + REQQUEUE (9), + ACLS (10), + USRGRP (11), + OCSP (12), + AUTHORIZATION (13), + SIGNED_AUDIT (14), + XCERT (15), + TKS (16), + TPS (17), + OTHER (20); + + private final int value; + + private LogSource(int value) { + this.value = value; + } + + public int value() { + return value; + } + + public static LogSource valueOf(int value) { + for (LogSource s : LogSource.values()) { + if (s.value == value) { + return s; + } + } + return null; + } +} diff --git a/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java b/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java index b5483eb9f..c9adb3f85 100644 --- a/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/SignedAuditEvent.java @@ -46,7 +46,7 @@ public class SignedAuditEvent implements IBundleLogEvent { private String mMessage = null; private int mLevel = -1; private int mNTEventType = -1; - private int mSource = -1; + private LogSource mSource; private boolean mMultiline = false; private long mTimeStamp = System.currentTimeMillis(); @@ -213,21 +213,21 @@ public class SignedAuditEvent implements IBundleLogEvent { /** * Retrieves log source. - * This is an id of the subsystem responsible + * This is the subsystem responsible * for creating the log event. * - * @return Integer source id. + * @return LogSource log source. */ - public int getSource() { + public LogSource getSource() { return mSource; } /** * Sets log source. * - * @param source Integer id of log source. + * @param source log source. */ - public void setSource(int source) { + public void setSource(LogSource source) { mSource = source; } diff --git a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java index 3704e60ca..96f944c38 100644 --- a/base/common/src/com/netscape/certsrv/logging/SystemEvent.java +++ b/base/common/src/com/netscape/certsrv/logging/SystemEvent.java @@ -45,7 +45,7 @@ public class SystemEvent implements IBundleLogEvent { private String mMessage = null; private int mLevel = -1; private int mNTEventType = -1; - private int mSource = -1; + private LogSource mSource; private boolean mMultiline = false; private long mTimeStamp = System.currentTimeMillis(); @@ -211,12 +211,12 @@ public class SystemEvent implements IBundleLogEvent { /** * Retrieves log source. - * This is an id of the subsystem responsible + * This is the subsystem responsible * for creating the log event. * - * @return Integer source id. + * @return log source. */ - public int getSource() { + public LogSource getSource() { return mSource; } @@ -224,9 +224,9 @@ public class SystemEvent implements IBundleLogEvent { * Sets log source. * Sets the id of the subsystem issuing the event. * - * @param source Integer source id. + * @param source log source. */ - public void setSource(int source) { + public void setSource(LogSource source) { mSource = source; } 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 readEntry(int maxLine, int lowLevel, int source, String fName) { + public Vector readEntry(int maxLine, int lowLevel, LogSource source, String fName) { Vector mEntries = new Vector(); 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 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(); 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 171b21dd8..bfab6bbbc 100644 --- a/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java +++ b/base/server/cmscore/src/com/netscape/cmscore/logging/AuditEventFactory.java @@ -20,11 +20,12 @@ 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; import com.netscape.certsrv.logging.ILogger; +import com.netscape.certsrv.logging.LogCategory; +import com.netscape.certsrv.logging.LogSource; /** * A log event object for handling audit messages @@ -58,7 +59,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(LogCategory evtClass, Properties prop, int source, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource 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 0d96e32c8..38cf95c56 100644 --- a/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java +++ b/base/server/cmscore/src/com/netscape/cmscore/logging/Logger.java @@ -25,6 +25,7 @@ import com.netscape.certsrv.logging.ILogEventFactory; 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 @@ -84,7 +85,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(LogCategory evtClass, int source, String msg) { + public void log(LogCategory evtClass, LogSource source, String msg) { log(evtClass, null, source, ILogger.LL_INFO, msg, null); } @@ -96,7 +97,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(LogCategory evtClass, Properties props, int source, String msg) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg) { log(evtClass, props, source, ILogger.LL_INFO, msg, null); } @@ -110,7 +111,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(LogCategory evtClass, int source, int level, String msg) { + public void log(LogCategory evtClass, LogSource source, int level, String msg) { log(evtClass, null, source, level, msg, null); } @@ -123,7 +124,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(LogCategory evtClass, Properties props, int source, int level, String msg) { + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg) { log(evtClass, props, source, level, msg, null); } @@ -138,7 +139,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(LogCategory evtClass, int source, int level, String msg, Object param) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param) { log(evtClass, null, source, level, msg, param); } @@ -151,7 +152,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(LogCategory evtClass, Properties props, int source, String msg, Object param) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param) { log(evtClass, props, source, ILogger.LL_INFO, msg, param); } @@ -165,7 +166,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(LogCategory evtClass, Properties props, int source, int level, String msg, + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param) { Object o[] = new Object[1]; @@ -184,7 +185,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(LogCategory evtClass, int source, int level, String msg, + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object params[]) { log(evtClass, null, source, level, msg, params); } @@ -200,7 +201,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(LogCategory evtClass, Properties prop, int source, int level, String msg, + 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) @@ -217,7 +218,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(LogCategory evtClass, int source, String msg, boolean multiline) { + public void log(LogCategory evtClass, LogSource source, String msg, boolean multiline) { log(evtClass, null, source, ILogger.LL_INFO, msg, null, multiline); } @@ -230,7 +231,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(LogCategory evtClass, Properties props, int source, String msg, boolean multiline) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, boolean multiline) { log(evtClass, props, source, ILogger.LL_INFO, msg, null, multiline); } @@ -245,7 +246,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(LogCategory evtClass, int source, int level, String msg, boolean multiline) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, boolean multiline) { log(evtClass, null, source, level, msg, null, multiline); } @@ -259,7 +260,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(LogCategory evtClass, Properties props, int source, int level, String msg, boolean multiline) { + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, boolean multiline) { log(evtClass, props, source, level, msg, null, multiline); } @@ -275,7 +276,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(LogCategory evtClass, int source, int level, String msg, Object param, boolean multiline) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline) { log(evtClass, null, source, level, msg, param, multiline); } @@ -289,7 +290,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(LogCategory evtClass, Properties props, int source, String msg, Object param, boolean multiline) { + 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); } @@ -304,7 +305,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(LogCategory evtClass, Properties props, int source, int level, String msg, + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param, boolean multiline) { Object o[] = new Object[1]; @@ -324,7 +325,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(LogCategory evtClass, int source, int level, String msg, + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object params[], boolean multiline) { log(evtClass, null, source, level, msg, params, multiline); } @@ -341,7 +342,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(LogCategory evtClass, Properties prop, int source, int level, String msg, + 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) @@ -355,7 +356,7 @@ public class Logger implements ILogger { * events here. */ //XXXXXXXXXXX prop is out dated!!!! XXXXXXXXXXXXXXX - public ILogEvent create(LogCategory evtClass, Properties prop, int source, int level, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource 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 34c9be630..3dc67b122 100644 --- a/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java +++ b/base/server/cmscore/src/com/netscape/cmscore/logging/SignedAuditEventFactory.java @@ -19,11 +19,12 @@ 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; import com.netscape.certsrv.logging.ILogger; +import com.netscape.certsrv.logging.LogCategory; +import com.netscape.certsrv.logging.LogSource; import com.netscape.certsrv.logging.SignedAuditEvent; import com.netscape.cmscore.util.Debug; @@ -60,7 +61,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(LogCategory evtClass, Properties prop, int source, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource 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 ce5fa6370..f76c49d81 100644 --- a/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java +++ b/base/server/cmscore/src/com/netscape/cmscore/logging/SystemEventFactory.java @@ -19,11 +19,12 @@ 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; import com.netscape.certsrv.logging.ILogger; +import com.netscape.certsrv.logging.LogCategory; +import com.netscape.certsrv.logging.LogSource; import com.netscape.certsrv.logging.SystemEvent; /** @@ -58,7 +59,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(LogCategory evtClass, Properties prop, int source, + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource 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 bc4c90ca2..0e6b7673c 100644 --- a/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java +++ b/base/server/test/com/netscape/cmscore/logging/LoggerDefaultStub.java @@ -7,63 +7,64 @@ import com.netscape.certsrv.logging.ILogEventFactory; import com.netscape.certsrv.logging.ILogQueue; import com.netscape.certsrv.logging.ILogger; import com.netscape.certsrv.logging.LogCategory; +import com.netscape.certsrv.logging.LogSource; /** * Default logging stub for testing. */ public class LoggerDefaultStub implements ILogger { - public void log(LogCategory evtClass, int source, String msg) { + public void log(LogCategory evtClass, LogSource source, String msg) { } - public void log(LogCategory evtClass, Properties props, int source, String msg) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg) { } - public void log(LogCategory evtClass, int source, int level, String msg) { + public void log(LogCategory evtClass, LogSource source, int level, String msg) { } - public void log(LogCategory evtClass, Properties props, int source, int level, String msg) { + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg) { } - public void log(LogCategory evtClass, int source, int level, String msg, Object param) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param) { } - public void log(LogCategory evtClass, int source, int level, String msg, Object params[]) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object params[]) { } - public void log(LogCategory evtClass, Properties props, int source, String msg, Object param) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, Object param) { } - public void log(LogCategory evtClass, Properties props, int source, int level, String msg, Object param) { + public void log(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param) { } - public void log(LogCategory evtClass, Properties prop, int source, int level, String msg, Object params[]) { + public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[]) { } - public void log(LogCategory evtClass, int source, String msg, boolean multiline) { + public void log(LogCategory evtClass, LogSource source, String msg, boolean multiline) { } - public void log(LogCategory evtClass, Properties props, int source, String msg, boolean multiline) { + public void log(LogCategory evtClass, Properties props, LogSource source, String msg, boolean multiline) { } - public void log(LogCategory evtClass, int source, int level, String msg, boolean multiline) { + public void log(LogCategory evtClass, LogSource 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(LogCategory evtClass, Properties props, LogSource source, int level, String msg, boolean multiline) { } - public void log(LogCategory evtClass, int source, int level, String msg, Object param, boolean multiline) { + public void log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline) { } - public void log(LogCategory evtClass, Properties props, int source, String msg, Object param, boolean multiline) { + public void log(LogCategory evtClass, Properties props, LogSource source, 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(LogCategory evtClass, Properties props, LogSource source, int level, String msg, Object param, boolean multiline) { } - public void log(LogCategory evtClass, Properties prop, int source, int level, String msg, Object params[], boolean multiline) { + public void log(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[], boolean multiline) { } - public ILogEvent create(LogCategory evtClass, Properties prop, int source, int level, String msg, Object params[], + public ILogEvent create(LogCategory evtClass, Properties prop, LogSource source, int level, String msg, Object params[], boolean multiline) { return null; } -- cgit