org.cristalise.kernel.utils

Class Logger

java.lang.Object

org.cristalise.kernel.utils.Logger

public class Logger
extends Object

Old fashioned Logger utility class designed before the well know logging frameworks of java were available

 - message string should always contain the class name and the method name: Logger.msg(1,"ItemFact::createDir() - LifeCycle DB created");
 - use meaningfull abbreviation and also use the dash to separate the 'header' from the message!
 - each method should start with this 'method signature' debug: Logger.msg(1,"ItemFact::createDir() - path:" + path);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static SimpleTCPIPServer	mConsole

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Modifier and Type	Method and Description
static void	addLogStream(PrintStream console, int logLevel) Add a new log stream
static void	closeConsole()
static void	debug(int level, String msg, Object... args) Report information that will be useful for debugging.
static void	debug(String msg) Deprecated. use debug method with level parameter
static void	die(String msg, Object... args) Report FATAL error and call the shutdown hook of the process.
static boolean	doLog(int logLevel) Check whether the given logLevel would produce a log entry or not
static void	error(String msg, Object... args) Report error (uses log level 0).
static void	error(Throwable ex) Report exception
static int	getConsolePort()
static int	initConsole(String id)
static void	msg(int level, String msg, Object... args) Report information that will be useful for debugging.
static void	msg(String msg, Object... args) Report information that is important to log all the time (uses log level 0).
static void	removeAll()
static void	removeLogStream(PrintStream console) Remove exeisting log stream
static void	warning(String msg, Object... args) Report warning (uses log level 0).

Methods inherited from class java.lang.Object

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

Field Detail

mConsole

protected static SimpleTCPIPServer mConsole

Constructor Detail

Logger

public Logger()

Method Detail

doLog

public static boolean doLog(int logLevel)

Check whether the given logLevel would produce a log entry or not

Parameters:

logLevel - the level to be checked

Returns:

true of the logLevel is smaller then or equal to the configured level

debug

@Deprecated
public static void debug(String msg)

Deprecated. use debug method with level parameter

Use this only for temporary messages while developing/debugging. When the code is stable, change calls to debug to message/warning/error with an appropriate log level. Is is marked deprecated to highlight stray calls. This makes it easier to manage debug calls in the source.

Parameters:

msg - - the string to write to the console, or log file if specified in cmd line

debug

public static void debug(int level,
                         String msg,
                         Object... args)

Report information that will be useful for debugging. Uses String.format() if args is not zero length.

Parameters:

level - - log level of this message. If the current log level was set less that this number, the log message will not be displayed

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

msg

public static void msg(int level,
                       String msg,
                       Object... args)

Report information that will be useful for debugging. Uses String.format() if args is not zero length.

Parameters:

level - - log level of this message. If the current log level was set less that this number, the log message will not be displayed

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

msg

public static void msg(String msg,
                       Object... args)

Report information that is important to log all the time (uses log level 0). Uses String.format() if args is not zero length.

Parameters:

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

error

public static void error(String msg,
                         Object... args)

Report error (uses log level 0). Uses String.format() if args is not zero length.

Parameters:

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

error

public static void error(Throwable ex)

Report exception

Parameters:

ex - the Throwable to be logged

warning

public static void warning(String msg,
                           Object... args)

Report warning (uses log level 0). Uses String.format() if args is not zero length.

Parameters:

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

die

public static void die(String msg,
                       Object... args)

Report FATAL error and call the shutdown hook of the process. Uses String.format() if args is not zero length.

Parameters:

msg - - the string to write to the log. It can also use String.format() syntax

args - - Arguments referenced by the format specifiers in the msg string

addLogStream

public static void addLogStream(PrintStream console,
                                int logLevel)

Add a new log stream

Parameters:

console - the PrintStream to be used as console

logLevel - the log level to be used for this stream

removeLogStream

public static void removeLogStream(PrintStream console)

Remove exeisting log stream

Parameters:

console - the PrintStream to be used as console

initConsole

public static int initConsole(String id)

getConsolePort

public static int getConsolePort()

closeConsole

public static void closeConsole()

removeAll

public static void removeAll()