com.eibus.util.logger

Class CordysLogger

java.lang.Object

com.eibus.util.logger.CordysLogger

public class CordysLogger
extends java.lang.Object

Logger for Cordys BCP. Creates a new logger instance based on the category name.The created instance will be used for logging messages .Same instance will be returned for all subsequent calls with the same cateogry name . Users can publish messages as string, object, XMLNode .Can also log exception directly to the logger.

Method Summary

Modifier and Type	Method and Description
static CordysLogger	_getCordysLogger(java.lang.Class<?> clazz, Log4JConfigurator log4JConfigurator) Retrieve a CordysLogger according to the value of the clazz parameter.
static void	_initializeDiagnosticContext() Initializes the diagnostic context for the invoking thread.
void	_log(java.lang.String callerFQCN, Severity severity, java.lang.Throwable exception, java.lang.Object logMessage) Internal method to log a special message record.
static void	_popDiagnosticContext(java.lang.String name) Clients should call this method before leaving a diagnostic context.
static void	_pushDiagnosticContext(java.lang.String name, java.lang.String value) Push diagnostic context information for the current thread.
static void	_removeDiagnosticContext() Remove the diagnostic context for this thread.
void	debug(int message) Log a message Node with the DEBUG Severity.
void	debug(int message, java.lang.Throwable t) Log a message Node with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.
void	debug(IStringResource message, java.lang.Object... insertions) Log IStringResource object with the DEBUG Severity.
void	debug(java.lang.String message) Log a message string with the DEBUG Severity.
void	debug(java.lang.String message, java.lang.Throwable t) Log a message string with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.
void	debug(java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource object with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.
void	error(int message) Deprecated.
void	error(int message, java.lang.Throwable t) Deprecated.
void	error(java.lang.String message) Deprecated.
void	error(java.lang.String message, java.lang.Throwable t) Deprecated.
void	error(java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource object with the ERROR Severity including the stack trace of the Throwable t passed as parameter.
void	fatal(int message) Deprecated.
void	fatal(int message, java.lang.Throwable t) Deprecated.
void	fatal(java.lang.String message) Deprecated.
void	fatal(java.lang.String message, java.lang.Throwable t) Deprecated.
void	fatal(java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource object with the FATAL Severity including the stack trace of the Throwable t passed as parameter.
static CordysLogger	getCordysLogger(java.lang.Class<?> clazz) Retrieve a CordysLogger according to the value of the clazz parameter.
static LoggerContext	getLoggerContext() This is for initiating the Composite Application Logger Context(CAL).
void	info(int message) Deprecated.
void	info(int message, java.lang.Throwable t) Deprecated.
void	info(IStringResource message) Log IStringResource object with the INFO Severity.
void	info(IStringResource message, java.lang.Object... insertions) Log IStringResource object with the INFO Severity.
void	info(java.lang.String message) Deprecated.
void	info(java.lang.String message, java.lang.Throwable t) Deprecated.
void	info(java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource object with the INFO Severity.
boolean	isDebugEnabled() Check whether the category is enabled for the debug Severity.
boolean	isEnabled(Severity severity) Check whether the category is enabled for the specfied severiy.
boolean	isErrorEnabled() Deprecated.
boolean	isFatalEnabled() Deprecated.
boolean	isInfoEnabled() Check whether the category is enabled for the info Severity.
boolean	isWarningEnabled() Check whether the category is enabled for the warning Severity.
void	log(Severity severity, int message) Deprecated. Convert the XML node to string and use log
void	log(Severity severity, int message, java.lang.Throwable t) Deprecated. Convert the XML node to string and use log
void	log(Severity severity, java.util.Map<java.lang.String,java.lang.String> contextMap, java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.
void	log(Severity severity, java.lang.Object message) Deprecated. Use log
void	log(Severity severity, java.lang.Object message, java.lang.Throwable t) Deprecated. Use log
void	log(Severity severity, java.lang.String message) Deprecated. Use log
void	log(Severity severity, java.lang.String message, java.lang.Throwable t) Deprecated. Use log
void	log(Severity severity, java.lang.Throwable exception, IStringResource message) Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.
void	log(Severity severity, java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.
void	warn(int message) Deprecated.
void	warn(int message, java.lang.Throwable t) Deprecated.
void	warn(java.lang.String message) Deprecated.
void	warn(java.lang.String message, java.lang.Throwable t) Deprecated.
void	warn(java.lang.Throwable exception, IStringResource message, java.lang.Object... insertions) Log IStringResource object with the WARN Severity including the stack trace of the Throwable t passed as parameter.

Methods inherited from class java.lang.Object

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

Method Detail

getCordysLogger

public static CordysLogger getCordysLogger(java.lang.Class<?> clazz)

Retrieve a CordysLogger according to the value of the clazz parameter. If the parameter by name CordysLogger already exists, then the existing instance will be returned. Otherwise, a new instance is created with severity set to OFF.

default level of the CordysLogger will be OFF

_getCordysLogger

public static CordysLogger _getCordysLogger(java.lang.Class<?> clazz,
                                            Log4JConfigurator log4JConfigurator)

Retrieve a CordysLogger according to the value of the clazz parameter. If the parameter by name CordysLogger already exists, then the existing instance will be returned. Otherwise, a new instance is created with severity set to OFF.

default level of the CordysLogger will be OFF

Parameters:

clazz -

log4JConfigurator -

Returns:

isDebugEnabled

public boolean isDebugEnabled()

Check whether the category is enabled for the debug Severity.

Returns:

boolean - true if this category is enabled for Severity debug, false otherwise.

isInfoEnabled

public boolean isInfoEnabled()

Check whether the category is enabled for the info Severity.

Returns:

boolean - true if this category is enabled for Severity info, false otherwise.

isWarningEnabled

public boolean isWarningEnabled()

Check whether the category is enabled for the warning Severity.

Returns:

boolean - true if this category is enabled for Severity warning, false otherwise.

isErrorEnabled

@Deprecated
public boolean isErrorEnabled()

Deprecated.

Check whether the category is enabled for the error Severity.

Returns:

boolean - true if this category is enabled for Severity error, false otherwise.

isFatalEnabled

@Deprecated
public boolean isFatalEnabled()

Deprecated.

Check whether the category is enabled for the FATAL Severity.

Returns:

boolean - true if this category is enabled for Severity FATAL, false otherwise.

isEnabled

public boolean isEnabled(Severity severity)

Check whether the category is enabled for the specfied severiy.

Parameters:

severity - The severity of the logging request.

Returns:

boolean - true if this category is enabled for default Severity, false otherwise.

log

@Deprecated
public void log(Severity severity,
                             int message)

Deprecated. Convert the XML node to string and use log

Log a message Node with the specified Severity

This method first checks if this category is enabled by comparing the Severity of this category with the configured severity. If the category with severity is enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

message - the message Node to log.

log

@Deprecated
public void log(Severity severity,
                             int message,
                             java.lang.Throwable t)

Deprecated. Convert the XML node to string and use log

Log a message Node with the specified severity including the stack trace of the Throwable t passed as parameter.

Parameters:

severity - The severity of the logging request.

message - the message Node to log.

t - the exception to log, including its stack trace.

log

@Deprecated
public void log(Severity severity,
                             java.lang.String message)

Deprecated. Use log

Log a message string with the specified severity

This method first checks if this category is enabled by comparing the Severity of this category with configured severity . If the category with severity is enabled,it converts the message to CordysLogRecord object, that containsinformation about userContext, MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

message - the message string to log.

log

@Deprecated
public void log(Severity severity,
                             java.lang.String message,
                             java.lang.Throwable t)

Deprecated. Use log

Log a message string with the specified severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message String to log.

t - the exception to log, including its stack trace.

severity - The severity of the logging request.

log

@Deprecated
public void log(Severity severity,
                             java.lang.Object message)

Deprecated. Use log

Log a message object with specfied severity

This method first checks if this category enabled by comparing the Severity of this category with configured severity . If the category is enabled,registered renderer convert the message object and proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

message - the message object to log.

log

@Deprecated
public void log(Severity severity,
                             java.lang.Object message,
                             java.lang.Throwable t)

Deprecated. Use log

Log a message string with the specified severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message object to log.

t - the exception to log, including its stack trace.

severity - The severity of the logging request.

info

@Deprecated
public void info(int message)

Deprecated.

Log a message Node with the INFO Severity.

This method first checks if this category is INFO enabled by comparing the Severity of this category with INFO Severity. If the category is INFO enabled,it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message Node to log.

info

@Deprecated
public void info(int message,
                              java.lang.Throwable t)

Deprecated.

Log a message Node with the INFO Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message Node to log.

t - the exception to log, including its stack trace.

info

@Deprecated
public void info(java.lang.String message)

Deprecated.

Log a message string with the INFO Severity.

This method first checks if this category is INFO enabled by comparing the Severity of this category with INFO Severity. If the category is INFO enabled,it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message string to log.

info

@Deprecated
public void info(java.lang.String message,
                              java.lang.Throwable t)

Deprecated.

Log a message string with the INFO Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message String to log.

t - the exception to log, including its stack trace.

debug

public void debug(int message)

Log a message Node with the DEBUG Severity.

This method first checks if this category is DEBUG enabled by comparing the Severity of this category with DEBUG Severity. If the category is DEBUG enabled,it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message Node to log.

debug

public void debug(int message,
                  java.lang.Throwable t)

Log a message Node with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message Node to log.

t - the exception to log, including its stack trace.

debug

public void debug(IStringResource message,
                  java.lang.Object... insertions)

Log IStringResource object with the DEBUG Severity.

This method first checks if this category is DEBUG enabled by comparing the Severity of this category with DEBUG Severity. If the category is DEBUG enabled,it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

IStringResource - The message to log.

insertions - insertions into the message.

debug

public void debug(java.lang.Throwable exception,
                  IStringResource message,
                  java.lang.Object... insertions)

Log IStringResource object with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is DEBUG enabled by comparing the Severity of this category with DEBUG Severity. If the category is DEBUG enabled,it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

debug

public void debug(java.lang.String message)

Log a message string with the DEBUG Severity.

This method first checks if this category is DEBUG enabled by comparing the Severity of this category with DEBUG Severity. If the category is DEBUG enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message string to log.

debug

public void debug(java.lang.String message,
                  java.lang.Throwable t)

Log a message string with the DEBUG Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message string to log.

t - the exception to log, including its stack trace.

warn

@Deprecated
public void warn(int message)

Deprecated.

Log a message Node with the WARN Severity.

This method first checks if this category is WARN enabled by comparing the Severity of this category with WARN Severity. If the category is WARN enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message Node to log.

warn

@Deprecated
public void warn(int message,
                              java.lang.Throwable t)

Deprecated.

Log a message Node with the WARN Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message Node to log.

t - the exception to log, including its stack trace.

warn

@Deprecated
public void warn(java.lang.String message)

Deprecated.

Log a message string with the WARN Severity.

This method first checks if this category is DEBUG enabled by comparing the Severity of this category with WARN Severity. If the category is WARN enabled , it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message string to log.

warn

@Deprecated
public void warn(java.lang.String message,
                              java.lang.Throwable t)

Deprecated.

Log a message string with the WARN Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message string to log.

t - the exception to log, including its stack trace.

error

@Deprecated
public void error(int message)

Deprecated.

Log a message Node with the ERROR Severity.

This method first checks if this category is ERROR enabled by comparing the Severity of this category with WARN Severity. If the category is ERROR enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message Node to log.

error

@Deprecated
public void error(int message,
                               java.lang.Throwable t)

Deprecated.

Log a message Node with the ERROR Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message Node to log.

t - the exception to log, including its stack trace.

error

@Deprecated
public void error(java.lang.String message)

Deprecated.

Log a message string with the ERROR Severity.

This method first checks if this category is ERROR enabled by comparing the Severity of this category with ERROR Severity. If the category is ERROR enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message string to log.

error

@Deprecated
public void error(java.lang.String message,
                               java.lang.Throwable t)

Deprecated.

Log a message string with the ERROR Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message string to log.

t - the exception to log, including its stack trace.

fatal

@Deprecated
public void fatal(int message)

Deprecated.

Log a message Node with the FATAL Severity.

This method first checks if this category is FATAL enabled by comparing the Severity of this category with WARN Severity. If the category is FATAL enabled, it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message Node to log.

fatal

@Deprecated
public void fatal(int message,
                               java.lang.Throwable t)

Deprecated.

Log a message Node with the FATAL Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message Node to log.

t - the exception to log, including its stack trace.

fatal

@Deprecated
public void fatal(java.lang.String message)

Deprecated.

Log a message string with the FATAL Severity.

This method first checks if this category is FATAL enabled by comparing the Severity of this category with FATAL Severity. If the category is FATAL enabled,it converts the message to CordysLogRecord object, that contains information about userContext,MessageID, component etc . It proceeds to call all the registered appenders in this category .

Parameters:

message - the message string to log.

fatal

@Deprecated
public void fatal(java.lang.String message,
                               java.lang.Throwable t)

Deprecated.

Log a message string with the FATAL Severity including the stack trace of the Throwable t passed as parameter.

Parameters:

message - the message string to log.

t - the exception to log, including its stack trace.

log

public void log(Severity severity,
                java.lang.Throwable exception,
                IStringResource message)

Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is enabled by comparing the Severity of this category with the configured severity. If the category with severity is enabled, It proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

t - the exception to log, including its stack trace.

IStringResource - The message to log.

log

public void log(Severity severity,
                java.lang.Throwable exception,
                IStringResource message,
                java.lang.Object... insertions)

Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is enabled by comparing the Severity of this category with the configured severity. If the category with severity is enabled, it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

log

public void log(Severity severity,
                java.util.Map<java.lang.String,java.lang.String> contextMap,
                java.lang.Throwable exception,
                IStringResource message,
                java.lang.Object... insertions)

Log IStringResource with the specified Severity including the stack trace of the Throwable t passed as parameter.

This method forcibly logs the message with the given severity.It reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

severity - The severity of the logging request.

contextMap - The contextMap to push the information into the Diagnostic Context.

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

info

public void info(IStringResource message)

Log IStringResource object with the INFO Severity.

This method first checks if this category is INFO enabled by comparing the Severity of this category with INFO Severity. If the category is INFO enabled, It proceeds to call all the registered appenders in this category .

Parameters:

IStringResource - The message to log.

info

public void info(java.lang.Throwable exception,
                 IStringResource message,
                 java.lang.Object... insertions)

Log IStringResource object with the INFO Severity.

This method first checks if this category is INFO enabled by comparing the Severity of this category with INFO Severity. If the category is INFO enabled,it reads the object[] arguments , if not null and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

info

public void info(IStringResource message,
                 java.lang.Object... insertions)

Log IStringResource object with the INFO Severity.

This method first checks if this category is INFO enabled by comparing the Severity of this category with INFO Severity. If the category is INFO enabled,it reads the object[] arguments , if not null and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

IStringResource - The message to log.

insertions - insertions into the message.

warn

public void warn(java.lang.Throwable exception,
                 IStringResource message,
                 java.lang.Object... insertions)

Log IStringResource object with the WARN Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is WARN enabled by comparing the Severity of this category with WARN Severity. If the category is WARN enabled,it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

error

public void error(java.lang.Throwable exception,
                  IStringResource message,
                  java.lang.Object... insertions)

Log IStringResource object with the ERROR Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is ERROR enabled by comparing the Severity of this category with ERROR Severity. If the category is ERROR enabled,it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

fatal

public void fatal(java.lang.Throwable exception,
                  IStringResource message,
                  java.lang.Object... insertions)

Log IStringResource object with the FATAL Severity including the stack trace of the Throwable t passed as parameter.

This method first checks if this category is FATAL enabled by comparing the Severity of this category with ERROR Severity. If the category is FATAL enabled,it reads the object[] arguments and insert that in to localized message in appropriate places . It proceeds to call all the registered appenders in this category .

Parameters:

exception - the exception to log, including its stack trace.

IStringResource - The message to log.

insertions - insertions into the message.

_log

public void _log(java.lang.String callerFQCN,
                 Severity severity,
                 java.lang.Throwable exception,
                 java.lang.Object logMessage)

Internal method to log a special message record.

Parameters:

callerFQCN - The wrapper class' fully qualified class name

severity - the severity of the log message

exception - the related exception

logMessage - the log message itself

_pushDiagnosticContext

public static void _pushDiagnosticContext(java.lang.String name,
                                          java.lang.String value)

Push diagnostic context information for the current thread.

The contents of the message parameter is determined solely by the client.

Parameters:

message - The transaction context information.

_popDiagnosticContext

public static void _popDiagnosticContext(java.lang.String name)

Clients should call this method before leaving a diagnostic context.

There is no penalty for forgetting to match each push operation with a corresponding pop, except the obvious mismatch between the real application context and the context set in by Cordys Logger.

_removeDiagnosticContext

public static void _removeDiagnosticContext()

Remove the diagnostic context for this thread.

Each thread that created a diagnostic context by calling _pushDiagnosticContext() should call this method before exiting. Otherwise, the memory used by the thread cannot be reclaimed by the VM.

_initializeDiagnosticContext

public static void _initializeDiagnosticContext()

Initializes the diagnostic context for the invoking thread.

Certain default diagnostic context is initialized by the Cordys Logger. To avail them, a thread must invoke this method. It is important to invoke the method _removeDiagnosticContext() when a thread is ready to quit to avoid memory leak.

getLoggerContext

public static LoggerContext getLoggerContext()

This is for initiating the Composite Application Logger Context(CAL). If logger context is not present then it is created and returned.
The sample code for instrumenting CAL inside your application.

 
 LoggerContext loggerContext = CordysLogger.getLoggerContext();
 loggerContext.addDiagnosticContext("context", "my sample application");
 
 

Returns:

the LoggerContext