com.kheops.util

Class Logger

java.lang.Object

com.kheops.util.Logger

public class Logger
extends java.lang.Object

A Logger object use log4j to write messages to a file stream and optionally to the default output stream or to a database .

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_LOG_FILE_NAME
static java.lang.String	DAILY
static java.lang.String	IGNITE_LOG_PATTERN
static int	LEVEL_ALL
static int	LEVEL_DEBUG
static int	LEVEL_ERROR
static int	LEVEL_FATAL
static int	LEVEL_INFO
static int	LEVEL_OFF
static int	LEVEL_WARNING
static java.lang.String	LOG_PATTERN
static java.lang.String	LOG_PATTERN_NO_IP Deprecated.
static java.lang.String	MONTHLY
static java.lang.String	SERVER_LOG_FILE_NAME
static java.lang.String	STR_LEVEL_ALL
static java.lang.String	STR_LEVEL_DEBUG
static java.lang.String	STR_LEVEL_ERROR
static java.lang.String	STR_LEVEL_FATAL
static java.lang.String	STR_LEVEL_INFO
static java.lang.String	STR_LEVEL_OFF
static java.lang.String	STR_LEVEL_WARNING
static java.lang.String	WEEKLY

Method Summary

Modifier and Type	Method and Description
void	all(java.lang.String message)
void	all(java.lang.String message, java.lang.String username)
void	all(java.lang.String message, java.lang.Throwable exception)
void	all(java.lang.String message, java.lang.Throwable exception, java.lang.String username)
void	close() Closes the logger and remove all appenders.
void	debug(java.lang.String message)
void	debug(java.lang.String message, java.lang.String username)
void	debug(java.lang.String message, java.lang.Throwable exception)
void	debug(java.lang.String message, java.lang.Throwable exception, java.lang.String username)
void	error(java.lang.String message)
void	error(java.lang.String message, java.lang.String username)
void	error(java.lang.String message, java.lang.Throwable exception)
void	error(java.lang.String message, java.lang.Throwable exception, java.lang.String username)
void	fatal(java.lang.String message)
void	fatal(java.lang.String message, java.lang.String username)
void	fatal(java.lang.String message, java.lang.Throwable exception)
void	fatal(java.lang.String message, java.lang.Throwable exception, java.lang.String username)
int	getFileAgeLimit()
static Logger	getInstance() Retrieve an instance of logger by name or creete one if don't exist.
int	getLogLevel()
java.lang.String	getLogPath()
void	info(java.lang.String message)
void	info(java.lang.String message, java.lang.String username)
void	info(java.lang.String message, java.lang.Throwable exception)
void	info(java.lang.String message, java.lang.Throwable exception, java.lang.String username)
void	init(java.lang.String logPath, java.lang.String rolloverSchedule, boolean logToConsole, java.lang.String logLevel, int fileAgeLimit, java.lang.String logFileName) init a logger "JMap" with parameters.
boolean	isAllEnabled()
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isFatalEnabled()
boolean	isInfoEnabled()
boolean	isWarningEnabled()
boolean	loadExternalConfig(java.io.File file) Load an external log4j configuration file.
void	log(int type, java.lang.String message) Logs a new message of the specified type.
void	log(int type, java.lang.String message, java.lang.String userName) Logs a new message of the specified type tagged to the specified user.
void	log(int type, java.lang.String message, java.lang.Throwable exception) Logs a new message of the specified type and includes the stack trace of the specified exception.
void	log(int level, java.lang.String message, java.lang.Throwable exception, java.lang.String userName) Logs a new message of the specified level tagged to the specified user.
static void	removeClientIp() Remove client ip address from current thread MDC.
static void	setClientIp(java.lang.String clientIp) Set client ip address on current thread MDC.
void	setFileAgeLimit(int fileAgeLimit)
void	setLogLevel(int logLevel)
void	setLogPath(java.lang.String logPath)
void	setLogToConsole(boolean logToConsole) Indicates whether or not log write the messages to the console
void	setRollover(java.lang.String rollover)
static java.lang.String	toLevel(int level)
static int	toLevel(java.lang.String level)
void	warning(java.lang.String message)
void	warning(java.lang.String message, java.lang.String username)
void	warning(java.lang.String message, java.lang.Throwable exception)
void	warning(java.lang.String message, java.lang.Throwable exception, java.lang.String username)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_PATTERN

public static final java.lang.String LOG_PATTERN

See Also:

Constant Field Values

IGNITE_LOG_PATTERN

public static final java.lang.String IGNITE_LOG_PATTERN

See Also:

Constant Field Values

LOG_PATTERN_NO_IP

@Deprecated
public static final java.lang.String LOG_PATTERN_NO_IP

Deprecated.

See Also:

Constant Field Values

MONTHLY

public static final java.lang.String MONTHLY

See Also:

Constant Field Values

WEEKLY

public static final java.lang.String WEEKLY

See Also:

Constant Field Values

DAILY

public static final java.lang.String DAILY

See Also:

Constant Field Values

STR_LEVEL_ALL

public static final java.lang.String STR_LEVEL_ALL

See Also:

Constant Field Values

STR_LEVEL_DEBUG

public static final java.lang.String STR_LEVEL_DEBUG

See Also:

Constant Field Values

STR_LEVEL_INFO

public static final java.lang.String STR_LEVEL_INFO

See Also:

Constant Field Values

STR_LEVEL_WARNING

public static final java.lang.String STR_LEVEL_WARNING

See Also:

Constant Field Values

STR_LEVEL_ERROR

public static final java.lang.String STR_LEVEL_ERROR

See Also:

Constant Field Values

STR_LEVEL_FATAL

public static final java.lang.String STR_LEVEL_FATAL

See Also:

Constant Field Values

STR_LEVEL_OFF

public static final java.lang.String STR_LEVEL_OFF

See Also:

Constant Field Values

LEVEL_ALL

public static final int LEVEL_ALL

LEVEL_DEBUG

public static final int LEVEL_DEBUG

LEVEL_INFO

public static final int LEVEL_INFO

LEVEL_WARNING

public static final int LEVEL_WARNING

LEVEL_ERROR

public static final int LEVEL_ERROR

LEVEL_FATAL

public static final int LEVEL_FATAL

LEVEL_OFF

public static final int LEVEL_OFF

SERVER_LOG_FILE_NAME

public static final java.lang.String SERVER_LOG_FILE_NAME

See Also:

Constant Field Values

CLIENT_LOG_FILE_NAME

public static final java.lang.String CLIENT_LOG_FILE_NAME

See Also:

Constant Field Values

Method Detail

getInstance

public static Logger getInstance()

Retrieve an instance of logger by name or creete one if don't exist.

init

public void init(java.lang.String logPath,
                 java.lang.String rolloverSchedule,
                 boolean logToConsole,
                 java.lang.String logLevel,
                 int fileAgeLimit,
                 java.lang.String logFileName)

init a logger "JMap" with parameters.

Parameters:

logPath - the path of the output files

rolloverSchedule - the number of days before creating a new log file

logToConsole - if true, messages will also be written to the console

logLevel - assigned level of the Logger

fileAgeLimit - limit of file age days before we run the rollover files process

logFileName - file name of the log files to generate

loadExternalConfig

public boolean loadExternalConfig(java.io.File file)

Load an external log4j configuration file. Supported file extension are xml and properties (legacy).

Returns:

true if file was loaded

setLogToConsole

public void setLogToConsole(boolean logToConsole)

Indicates whether or not log write the messages to the console

Parameters:

logToConsole - if true, messages will also be written to the console

setFileAgeLimit

public void setFileAgeLimit(int fileAgeLimit)

Parameters:

fileAgeLimit - The fileAgeLimit to set.

setRollover

public void setRollover(java.lang.String rollover)

Parameters:

rollover - The rollover to set.

setLogPath

public void setLogPath(java.lang.String logPath)

Parameters:

logPath - The logPath to set.

setLogLevel

public void setLogLevel(int logLevel)

Parameters:

logLevel - The logLevel to set.

getLogLevel

public int getLogLevel()

isAllEnabled

public boolean isAllEnabled()

isDebugEnabled

public boolean isDebugEnabled()

isInfoEnabled

public boolean isInfoEnabled()

isWarningEnabled

public boolean isWarningEnabled()

isErrorEnabled

public boolean isErrorEnabled()

isFatalEnabled

public boolean isFatalEnabled()

toLevel

public static int toLevel(java.lang.String level)

toLevel

public static java.lang.String toLevel(int level)

getLogPath

public java.lang.String getLogPath()

getFileAgeLimit

public int getFileAgeLimit()

Returns:

Returns the ageFileLimit.

log

public void log(int type,
                java.lang.String message)

Logs a new message of the specified type.

Parameters:

type - the type of the message

message - the text of the message

log

public void log(int type,
                java.lang.String message,
                java.lang.String userName)

Logs a new message of the specified type tagged to the specified user.

Parameters:

type - the type of the message

message - the text of the message

userName - the user this message will be tagged to

log

public void log(int type,
                java.lang.String message,
                java.lang.Throwable exception)

Logs a new message of the specified type and includes the stack trace of the specified exception.

Parameters:

type - the type of the message

message - the text of the message

exception - a Throwable object for which the stack trace must be written

log

public void log(int level,
                java.lang.String message,
                java.lang.Throwable exception,
                java.lang.String userName)

Logs a new message of the specified level tagged to the specified user. Includes the stack trace of the specified exception.

Parameters:

level - the level of the message

message - the text of the message

exception - a Throwable object for which the stack trace must be written

userName - the user this message will be tagged to

setClientIp

public static void setClientIp(java.lang.String clientIp)

Set client ip address on current thread MDC. Use 15 characters padding.

removeClientIp

public static void removeClientIp()

Remove client ip address from current thread MDC.

close

public void close()

Closes the logger and remove all appenders.

all

public void all(java.lang.String message)

all

public void all(java.lang.String message,
                java.lang.Throwable exception)

all

public void all(java.lang.String message,
                java.lang.String username)

all

public void all(java.lang.String message,
                java.lang.Throwable exception,
                java.lang.String username)

debug

public void debug(java.lang.String message)

debug

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

debug

public void debug(java.lang.String message,
                  java.lang.String username)

debug

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

error

public void error(java.lang.String message)

error

public void error(java.lang.String message,
                  java.lang.Throwable exception)

error

public void error(java.lang.String message,
                  java.lang.String username)

error

public void error(java.lang.String message,
                  java.lang.Throwable exception,
                  java.lang.String username)

fatal

public void fatal(java.lang.String message)

fatal

public void fatal(java.lang.String message,
                  java.lang.Throwable exception)

fatal

public void fatal(java.lang.String message,
                  java.lang.String username)

fatal

public void fatal(java.lang.String message,
                  java.lang.Throwable exception,
                  java.lang.String username)

info

public void info(java.lang.String message)

info

public void info(java.lang.String message,
                 java.lang.Throwable exception)

info

public void info(java.lang.String message,
                 java.lang.String username)

info

public void info(java.lang.String message,
                 java.lang.Throwable exception,
                 java.lang.String username)

warning

public void warning(java.lang.String message)

warning

public void warning(java.lang.String message,
                    java.lang.Throwable exception)

warning

public void warning(java.lang.String message,
                    java.lang.String username)

warning

public void warning(java.lang.String message,
                    java.lang.Throwable exception,
                    java.lang.String username)