com.netscape.certsrv.logging

Interface ILogger

public interface ILogger

An interface represents a logger for certificate server. This object is used to issue log messages for the various types of logging event types. A log message results in a ILogEvent being created. This event is then placed on a ILogQueue to be ultimately written to the destination log file. This object also maintains a collection of ILogFactory objects which are used to create the supported types of ILogEvents. CMS comes out of the box with three event types: "signedAudit", "system", and "audit".

Version:

$Revision$, $Date$

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
ILogEvent	create(int evtClass, java.util.Properties prop, int source, int level, java.lang.String msg, java.lang.Object[] params, boolean multiline)
ILogQueue	getLogQueue() Retrieves the associated log queue.
void	log(int evtClass, int source, int level, java.lang.String msg) Logs an event to the log queue.
void	log(int evtClass, int source, int level, java.lang.String msg, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, int source, int level, java.lang.String msg, java.lang.Object param) Logs an event to the log queue.
void	log(int evtClass, int source, int level, java.lang.String msg, java.lang.Object[] params) Logs an event to the log queue.
void	log(int evtClass, int source, int level, java.lang.String msg, java.lang.Object param, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, int source, java.lang.String msg) Logs an event to the log queue.
void	log(int evtClass, int source, java.lang.String msg, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, int level, java.lang.String msg) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, int level, java.lang.String msg, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, int level, java.lang.String msg, java.lang.Object param) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties prop, int source, int level, java.lang.String msg, java.lang.Object[] params) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties prop, int source, int level, java.lang.String msg, java.lang.Object[] params, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, int level, java.lang.String msg, java.lang.Object param, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, java.lang.String msg) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, java.lang.String msg, boolean multiline) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, java.lang.String msg, java.lang.Object param) Logs an event to the log queue.
void	log(int evtClass, java.util.Properties props, int source, java.lang.String msg, java.lang.Object param, boolean multiline) Logs an event to the log queue.
void	register(int evtClass, ILogEventFactory f) Register a log event factory.

Field Detail

EV_AUDIT

static final int EV_AUDIT

log class: audit event.

See Also:

Constant Field Values

PROP_AUDIT

static final java.lang.String PROP_AUDIT

See Also:

Constant Field Values

EV_SYSTEM

static final int EV_SYSTEM

log class: system event. System event with log level >= LL_FAILURE will also be logged in error log

See Also:

Constant Field Values

PROP_SYSTEM

static final java.lang.String PROP_SYSTEM

See Also:

Constant Field Values

EV_SIGNED_AUDIT

static final int EV_SIGNED_AUDIT

log class: SignedAudit event.

See Also:

Constant Field Values

PROP_SIGNED_AUDIT

static final java.lang.String PROP_SIGNED_AUDIT

See Also:

Constant Field Values

S_ALL

static final int S_ALL

log source: used by servlet to retrieve all logs

See Also:

Constant Field Values

S_KRA

static final int S_KRA

log source: identify the log entry is from KRA

See Also:

Constant Field Values

S_RA

static final int S_RA

log source: identify the log entry is from RA

See Also:

Constant Field Values

S_CA

static final int S_CA

log source: identify the log entry is from CA

See Also:

Constant Field Values

S_HTTP

static final int S_HTTP

log source: identify the log entry is from http subsystem

See Also:

Constant Field Values

S_DB

static final int S_DB

log source: identify the log entry is from database subsystem

See Also:

Constant Field Values

S_AUTHENTICATION

static final int S_AUTHENTICATION

log source: identify the log entry is from authentication subsystem

See Also:

Constant Field Values

S_ADMIN

static final int S_ADMIN

log source: identify the log entry is from admin subsystem

See Also:

Constant Field Values

S_LDAP

static final int S_LDAP

log source: identify the log entry is from ldap subsystem

See Also:

Constant Field Values

S_REQQUEUE

static final int S_REQQUEUE

log source: identify the log entry is from request queue subsystem

See Also:

Constant Field Values

S_ACLS

static final int S_ACLS

log source: identify the log entry is from acl subsystem

See Also:

Constant Field Values

S_USRGRP

static final int S_USRGRP

log source: identify the log entry is from usergrp subsystem

See Also:

Constant Field Values

S_OCSP

static final int S_OCSP

See Also:

Constant Field Values

S_AUTHORIZATION

static final int S_AUTHORIZATION

log source: identify the log entry is from authorization subsystem

See Also:

Constant Field Values

S_SIGNED_AUDIT

static final int S_SIGNED_AUDIT

log source: identify the log entry is from signed audit

See Also:

Constant Field Values

S_XCERT

static final int S_XCERT

log source: identify the log entry is from CrossCertPair subsystem

See Also:

Constant Field Values

S_TKS

static final int S_TKS

log source: identify the log entry is from CrossCertPair subsystem

See Also:

Constant Field Values

S_TPS

static final int S_TPS

See Also:

Constant Field Values

S_OTHER

static final int S_OTHER

log source: identify the log entry is from other subsystem eg. policy, security, connector,registration

See Also:

Constant Field Values

LL_ALL

static final int LL_ALL

log level: used by servlet to retrieve all level logs

See Also:

Constant Field Values

LL_ALL_STRING

static final java.lang.String LL_ALL_STRING

See Also:

Constant Field Values

LL_DEBUG

static final int LL_DEBUG

Debug level is depreciated since CMS6.1. Please use CMS.debug() to output messages to debugging file.

See Also:

Constant Field Values

LL_DEBUG_STRING

static final java.lang.String LL_DEBUG_STRING

See Also:

Constant Field Values

LL_INFO

static final int LL_INFO

log level: indicate this log entry is for info note

See Also:

Constant Field Values

LL_INFO_STRING

static final java.lang.String LL_INFO_STRING

See Also:

Constant Field Values

LL_WARN

static final int LL_WARN

log level: indicate this log entry is warning info

See Also:

Constant Field Values

LL_WARN_STRING

static final java.lang.String LL_WARN_STRING

See Also:

Constant Field Values

LL_FAILURE

static final int LL_FAILURE

log level: indicate this log entry is fail/error info

See Also:

Constant Field Values

LL_FAILURE_STRING

static final java.lang.String LL_FAILURE_STRING

See Also:

Constant Field Values

LL_MISCONF

static final int LL_MISCONF

log level: indicate this log entry is about misconfiguration

See Also:

Constant Field Values

LL_MISCONF_STRING

static final java.lang.String LL_MISCONF_STRING

See Also:

Constant Field Values

LL_CATASTRPHE

static final int LL_CATASTRPHE

log level: indicate this log entry is catastrphe info

See Also:

Constant Field Values

LL_CATASTRPHE_STRING

static final java.lang.String LL_CATASTRPHE_STRING

See Also:

Constant Field Values

LL_SECURITY

static final int LL_SECURITY

log level: indicate this log entry is security info

See Also:

Constant Field Values

LL_SECURITY_STRING

static final java.lang.String LL_SECURITY_STRING

See Also:

Constant Field Values

SYSTEM_UID

static final java.lang.String SYSTEM_UID

"SubjectID" for system-initiated events logged in signed audit log messages

See Also:

Constant Field Values

UNIDENTIFIED

static final java.lang.String UNIDENTIFIED

A constant string value used to denote a single "unknown" identity in signed audit log messages

See Also:

Constant Field Values

NONROLEUSER

static final java.lang.String NONROLEUSER

A constant string value used to denote a single "non-role" identity in signed audit log messages

See Also:

Constant Field Values

SUCCESS

static final java.lang.String SUCCESS

"Outcome" for events logged in signed audit log messages

See Also:

Constant Field Values

FAILURE

static final java.lang.String FAILURE

See Also:

Constant Field Values

SIGNED_AUDIT_NON_APPLICABLE

static final java.lang.String SIGNED_AUDIT_NON_APPLICABLE

A constant string value used to denote a "non-applicable" data value in signed audit log messages

See Also:

Constant Field Values

SIGNED_AUDIT_EMPTY_VALUE

static final java.lang.String SIGNED_AUDIT_EMPTY_VALUE

A constant string value used to denote an "empty", or "null", data value in signed audit log messages

See Also:

Constant Field Values

SIGNED_AUDIT_ACCEPTANCE

static final java.lang.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

See Also:

Constant Field Values

SIGNED_AUDIT_CANCELLATION

static final java.lang.String SIGNED_AUDIT_CANCELLATION

See Also:

Constant Field Values

SIGNED_AUDIT_REJECTION

static final java.lang.String SIGNED_AUDIT_REJECTION

See Also:

Constant Field Values

NT_INFO

static final int NT_INFO

NT event type: correspond to log level LL_DEBUG or LL_INFO

See Also:

Constant Field Values

NT_WARN

static final int NT_WARN

NT event type: correspond to log level LL_WARNING

See Also:

Constant Field Values

NT_ERROR

static final int NT_ERROR

NT event type: correspont to log level LL_FAILURE and above

See Also:

Constant Field Values

L_MULTILINE

static final boolean L_MULTILINE

indicate the log message has more than one line

See Also:

Constant Field Values

L_SINGLELINE

static final boolean L_SINGLELINE

indicate the log message has one line

See Also:

Constant Field Values

Method Detail

log

void log(int evtClass,
         int source,
         java.lang.String msg)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

msg - The detail message to be logged.

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         java.lang.String msg)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

msg - The detail message to be logged.

log

void log(int evtClass,
         int source,
         int level,
         java.lang.String msg)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         int level,
         java.lang.String msg)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

log

void log(int evtClass,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object param)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

param - The parameter in the detail message.

log

void log(int evtClass,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object[] params)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

params - The parameters in the detail message.

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         java.lang.String msg,
         java.lang.Object param)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

msg - The detail message to be logged.

param - The parameters in the detail message.

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object param)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

param - The parameter in the detail message.

log

void log(int evtClass,
         java.util.Properties prop,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object[] params)

Logs an event to the log queue.

Parameters:

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

prop - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

params - The parameters in the detail message.

log

void log(int evtClass,
         int source,
         java.lang.String msg,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

msg - The detail message to be logged.

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

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         java.lang.String msg,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

msg - The detail message to be logged.

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

log

void log(int evtClass,
         int source,
         int level,
         java.lang.String msg,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

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

log

void log(int evtClass,
         java.util.Properties props,
         int source,
         int level,
         java.lang.String msg,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The detail message to be logged.

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

log

void log(int evtClass,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object param,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

source - The source of the log event.

level - The level of the log event.

msg - The 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

void log(int evtClass,
         java.util.Properties props,
         int source,
         java.lang.String msg,
         java.lang.Object param,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - TTTTsource of the log event.

msg - The 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

void log(int evtClass,
         java.util.Properties props,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object param,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

props - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The 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

void log(int evtClass,
         java.util.Properties prop,
         int source,
         int level,
         java.lang.String msg,
         java.lang.Object[] params,
         boolean multiline)

Logs an event to the log queue.

Parameters:

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

prop - The resource bundle used for the detailed message.

source - The source of the log event.

level - The level of the log event.

msg - The 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

ILogEvent create(int evtClass,
                 java.util.Properties prop,
                 int source,
                 int level,
                 java.lang.String msg,
                 java.lang.Object[] params,
                 boolean multiline)

register

void register(int evtClass,
              ILogEventFactory f)

Register a log event factory. Which will create the desired ILogEvents.

getLogQueue

ILogQueue getLogQueue()

Retrieves the associated log queue. The log queue is where issued log events are collected for later processing.