Class Logger

java.lang.Object

com.netscape.cms.logging.Logger

All Implemented Interfaces:

ILogger

Direct Known Subclasses:

SignedAuditLogger

public class Logger
extends Object
implements ILogger

A class represents certificate server logger implementation.

Version:

$Revision$, $Date$

Author:

thomask, mzhao

Field Summary

Fields

Modifier and Type	Field	Description
protected static Hashtable<LogCategory, LogFactory>	mFactories
protected static Logger	mLogger
protected ILogQueue	mLogQueue

Fields inherited from interface ILogger

EV_AUDIT, EV_SIGNED_AUDIT, FAILURE, L_MULTILINE, L_SINGLELINE, LL_ALL, LL_ALL_STRING, LL_CATASTRPHE, LL_CATASTRPHE_STRING, LL_DEBUG, LL_DEBUG_STRING, LL_FAILURE, LL_FAILURE_STRING, LL_INFO, LL_INFO_STRING, LL_MISCONF, LL_MISCONF_STRING, LL_SECURITY, LL_SECURITY_STRING, LL_WARN, LL_WARN_STRING, NONROLEUSER, NT_ERROR, NT_INFO, NT_WARN, PROP_AUDIT, PROP_SIGNED_AUDIT, PROP_SYSTEM, S_ACLS, S_ADMIN, S_ALL, S_AUTHENTICATION, S_AUTHORIZATION, S_CA, S_DB, S_HTTP, S_KRA, S_LDAP, S_OCSP, S_OTHER, S_RA, S_REQQUEUE, S_SIGNED_AUDIT, S_TKS, S_TPS, S_USRGRP, S_XCERT, SIGNED_AUDIT_ACCEPTANCE, SIGNED_AUDIT_CANCELLATION, SIGNED_AUDIT_EMPTY_VALUE, SIGNED_AUDIT_NON_APPLICABLE, SIGNED_AUDIT_REJECTION, SUCCESS, SYSTEM_UID, UNIDENTIFIED

Modifier and Type	Field	Description
static final LogCategory	EV_AUDIT	log class: audit event.
static final LogCategory	EV_SIGNED_AUDIT	log class: SignedAudit event.
static final String	FAILURE
static final boolean	L_MULTILINE	indicate the log message has more than one line
static final boolean	L_SINGLELINE	indicate the log message has one line
static final int	LL_ALL	log level: used by servlet to retrieve all level logs
static final String	LL_ALL_STRING
static final int	LL_CATASTRPHE	log level: indicate this log entry is catastrphe info
static final String	LL_CATASTRPHE_STRING
static final int	LL_DEBUG	Debug level is depreciated since CMS6.1.
static final String	LL_DEBUG_STRING
static final int	LL_FAILURE	log level: indicate this log entry is fail/error info
static final String	LL_FAILURE_STRING
static final int	LL_INFO	log level: indicate this log entry is for info note
static final String	LL_INFO_STRING
static final int	LL_MISCONF	log level: indicate this log entry is about misconfiguration
static final String	LL_MISCONF_STRING
static final int	LL_SECURITY	log level: indicate this log entry is security info
static final String	LL_SECURITY_STRING
static final int	LL_WARN	log level: indicate this log entry is warning info
static final String	LL_WARN_STRING
static final String	NONROLEUSER	A constant string value used to denote a single "non-role" identity in signed audit log messages
static final int	NT_ERROR	NT event type: correspont to log level LL_FAILURE and above
static final int	NT_INFO	NT event type: correspond to log level LL_DEBUG or LL_INFO
static final int	NT_WARN	NT event type: correspond to log level LL_WARNING
static final String	PROP_AUDIT
static final String	PROP_SIGNED_AUDIT
static final String	PROP_SYSTEM	log class: system event.
static final LogSource	S_ACLS	log source: identify the log entry is from acl subsystem
static final LogSource	S_ADMIN	log source: identify the log entry is from admin subsystem
static final LogSource	S_ALL	log source: used by servlet to retrieve all logs
static final LogSource	S_AUTHENTICATION	log source: identify the log entry is from authentication subsystem
static final LogSource	S_AUTHORIZATION	log source: identify the log entry is from authorization subsystem
static final LogSource	S_CA	log source: identify the log entry is from CA
static final LogSource	S_DB	log source: identify the log entry is from database subsystem
static final LogSource	S_HTTP	log source: identify the log entry is from http subsystem
static final LogSource	S_KRA	log source: identify the log entry is from KRA
static final LogSource	S_LDAP	log source: identify the log entry is from ldap subsystem
static final LogSource	S_OCSP
static final LogSource	S_OTHER	log source: identify the log entry is from other subsystem eg.
static final LogSource	S_RA	log source: identify the log entry is from RA
static final LogSource	S_REQQUEUE	log source: identify the log entry is from request queue subsystem
static final LogSource	S_SIGNED_AUDIT	log source: identify the log entry is from signed audit
static final LogSource	S_TKS	log source: identify the log entry is from CrossCertPair subsystem
static final LogSource	S_TPS
static final LogSource	S_USRGRP	log source: identify the log entry is from usergrp subsystem
static final LogSource	S_XCERT	log source: identify the log entry is from CrossCertPair subsystem
static final String	SIGNED_AUDIT_ACCEPTANCE	Constant string values associated with the type of certificate processing stored in the "InfoName" field in certain signed audit log messages
static final String	SIGNED_AUDIT_CANCELLATION
static final String	SIGNED_AUDIT_EMPTY_VALUE	A constant string value used to denote an "empty", or "null", data value in signed audit log messages
static final String	SIGNED_AUDIT_NON_APPLICABLE	A constant string value used to denote a "non-applicable" data value in signed audit log messages
static final String	SIGNED_AUDIT_REJECTION
static final String	SUCCESS	"Outcome" for events logged in signed audit log messages
static final String	SYSTEM_UID	"SubjectID" for system-initiated events logged in signed audit log messages
static final String	UNIDENTIFIED	A constant string value used to denote a single "unknown" identity in signed audit log messages

Constructor Summary

Constructors

Constructor	Description
Logger()
Logger(LogFactory factory, LogCategory category, LogSource source)
Logger(LogFactory factory, LogCategory category, LogSource source, int level)

Method Summary

Modifier and Type	Method	Description
ILogEvent	create(int level, String msg, Object[] params, boolean multiline)
ILogEvent	create(LogCategory evtClass, LogSource source, int level, String msg, Object[] params, boolean multiline)	Creates generic log event.
static Logger	getLogger()	get default single global logger
static Logger	getLogger(LogCategory category, LogSource source)
ILogQueue	getLogQueue()	Retrieves the associated log queue.
void	log(int level, String msg)
void	log(int level, String msg, boolean multiline)
void	log(int level, String msg, Object[] params)
void	log(int level, String msg, Object[] params, boolean multiline)
void	log(LogCategory evtClass, LogSource source, int level, String msg)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, int level, String msg, boolean multiline)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, int level, String msg, Object param)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, int level, String msg, Object[] params)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, int level, String msg, Object[] params, boolean multiline)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline)	Logs an event to the log queue.
void	log(LogCategory evtClass, LogSource source, String msg)	Logs an event using default log level.
void	log(LogCategory evtClass, LogSource source, String msg, boolean multiline)	Logs an event using default log level.
void	log(LogEvent event)
void	log(String msg)
static void	register(LogCategory evtClass, LogFactory f)	Registers log factory.
void	release(ILogEvent event)	Notifies logger to reuse the event.
void	update(LogEvent event, LogSource source, int level, String message, Object[] params, boolean multiline)	Updates a log event.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

mLogger

protected static Logger mLogger

mLogQueue

protected ILogQueue mLogQueue

mFactories

protected static Hashtable<LogCategory, LogFactory> mFactories

Constructor Details

Logger

public Logger()

Logger

public Logger(LogFactory factory,
 LogCategory category,
 LogSource source)

Logger

public Logger(LogFactory factory,
 LogCategory category,
 LogSource source,
 int level)

Method Details

getLogger

public static Logger getLogger()

get default single global logger

getLogger

public static Logger getLogger(LogCategory category,
 LogSource source)

getLogQueue

public ILogQueue getLogQueue()

Retrieves the associated log queue.

Specified by:

getLogQueue in interface ILogger

register

public static void register(LogCategory evtClass,
 LogFactory f)

Registers log factory.

Parameters:

evtClass - the event class name: ILogger.EV_SYSTEM or ILogger.EV_AUDIT

f - the event factory name

log

public void log(String msg)

log

public void log(LogEvent event)

log

public void log(LogCategory evtClass,
 LogSource source,
 String msg)

Logs an event using default log level.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

msg - the one line detail message to be logged

log

public void log(int level,
 String msg)

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg)

Logs an event to the log queue.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - the level of the log event

msg - the one line detail message to be logged

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 Object param)

Logs an event to the log queue.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - The level of the log event.

msg - the one line detail message to be logged

param - the parameter in the detail message

log

public void log(int level,
 String msg,
 Object[] params)

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 Object[] params)

Logs an event to the log queue.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - the level of the log event

msg - the one line detail message to be logged

params - the parameters in the detail message

log

public void log(LogCategory evtClass,
 LogSource source,
 String msg,
 boolean multiline)

Logs an event using default log level.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

msg - the one line detail message to be logged

multiline - true if the message has more than one line, otherwise false

log

public void log(int level,
 String msg,
 boolean multiline)

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 boolean multiline)

Logs an event to the log queue.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - the level of the log event

msg - the one line detail message to be logged

multiline - true if the message has more than one line, otherwise false

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 Object param,
 boolean multiline)

Logs an event to the log queue.

Specified by:

log in interface ILogger

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - The level of the log event.

msg - the one line detail message to be logged

param - the parameter in the detail message

multiline - true if the message has more than one line, otherwise false

log

public void log(int level,
 String msg,
 Object[] params,
 boolean multiline)

log

public void log(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 Object[] params,
 boolean multiline)

Logs an event to the log queue.

Parameters:

evtClass - What kind of event it is: EV_AUDIT or EV_SYSTEM.

source - the source of the log event

level - the level of the log event

msg - the one line detail message to be logged

params - the parameters in the detail message

multiline - true if the message has more than one line, otherwise false

create

public ILogEvent create(int level,
 String msg,
 Object[] params,
 boolean multiline)

create

public ILogEvent create(LogCategory evtClass,
 LogSource source,
 int level,
 String msg,
 Object[] params,
 boolean multiline)

Creates generic log event. If required, we can recycle events here.

Specified by:

create in interface ILogger

update

public void update(LogEvent event,
 LogSource source,
 int level,
 String message,
 Object[] params,
 boolean multiline)

Updates a log event.

Parameters:

event - The event to be updated.

source - The subsystem who creates the log event.

level - The severity of the log event.

message - The detail message of the log.

params - The parameters in the detail log message.

multiline - The log message has more than one line or not.

release

public void release(ILogEvent event)

Notifies logger to reuse the event. This framework opens up possibility to reuse event.

Parameters:

event - a log event