com.ibm.di.server
Class Log

java.lang.Object
  com.ibm.di.server.Log

All Implemented Interfaces:

Serializable

public class Log
extends Object
implements Serializable

The Log object is used to log messages to logs. It keeps a list of different Loggers, all implementing LogInterface, and asks all of them to log.

See Also:

Serialized Form

Nested Class Summary

static class

Log.InternalLogger A collection of loggers.

Field Summary

boolean

debug The debug mode flag for the log.

Constructor Summary

Log(Log parentLog)
A constructor taking another Log as a parameter.

Log(String resourceName)
A constructor which takes only a resource name.

Log(String resourceName, Log.InternalLogger loggers)
Deprecated.

Log(String resourceName, org.apache.log4j.Logger logger)
Deprecated.

Log(String resourceName, String category)
A constructor with both resourceName and category name

Method Summary

void	addLogger(org.apache.log4j.Logger logger) Deprecated. Do not use log4j directly
void	addLogger(LogInterface logger) Add a LogInterface to internal list of loggers.
void	close() Close the output logger
void	debug(String res) Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged.
void	debug(String res, Object param) Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged.
void	debug(String res, Object[] params) Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged.
void	debug(String res, Object param1, Object param2) Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged.
void	dump(Object o) This methods dumps an Object to the log file.
void	dumpEntry(Entry e) Dumps a formatted message to the logfile from the contents of an Entry
void	error(String res) Log a message with error level.
void	error(String res, Object[] params) Log a message with error level.
void	error(String res, Object[] params, Throwable error) Log a message with error level.
void	error(String res, Object param, Throwable error) Log a message with error level.
void	error(String res, String param) Log a message with error level.
void	error(String res, String param1, String param2) Log a message with error level.
void	error(String res, Throwable error) Log a message with error level.
void	exception(String res) Throws a new exception with a custom message.
void	exception(String res, Object param) Throws a new exception with a custom message.
void	exception(String res, Object[] params) Throws a new exception with a custom message.
void	exception(String res, Object param1, Object param2) Throws a new exception with a custom message.
void	fatal(String res) Log a message with fatal level.
void	fatal(String res, Object param) Log a message with fatal level.
void	fatal(String res, Object[] params) Log a message with fatal level.
void	fatal(String res, Object param, Throwable err) Log a message with fatal level.
void	fatal(String res, Throwable err) Log a message with fatal level.
void	fine(String res) Log a message with debug level.
void	fine(String res, Object param) Log a message with debug level.
void	fine(String res, Object[] params) Log a message with debug level.
void	fine(String res, Object param1, Object param2) Log a message with debug level.
String	getCategory() Returns the category for this Log
LogInterface	getClassLogger(String className) Returns a LogInterface with the given class Name.
boolean	getDebug() Return the value of the debug parameter
org.apache.log4j.Logger	getLogger() Deprecated.
Vector	getLoggers() Returns a Vector containing all org.apache.log4j.Logger objects used by this Log.
String	getPrefix() Returns the prefix to be prepended to all messages
String	getString(String resource) Return the NLS string given the resource.
String	getString(String resource, Object param) Return the NLS string given the resource and a parameter.
String	getString(String resource, Object[] params) Return the NLS string given the resource and an array of parameters
String	getString(String resource, Object param1, Object param2) Return the NLS string given the resource and two parameters
TDILog4j	getTDILog4j() Returns a TDILog4j Logger connected to this Log object.
void	info(String res) Log a message with info level.
void	info(String res, Object param) Log a message with info level.
void	info(String res, Object[] params) Log a message with info level.
void	info(String res, Object param1, Object param2) Log a message with info level.
boolean	isDebugEnabled() Checks whether debug is enabled.
static boolean	isLoggingEnabled() Returns whether TDI logging is active or disabled.
void	log(String level, String msg) Log a message with the specified level.
void	logdebug(String msg) Log a message with info level if the debug mode flag is true, otherwise an debug level message is logged.
void	logerror(String msg) Log a message with error level.
void	logerror(String msg, Throwable error) Log a message with error level with an additional Throwable object.
void	logfatal(String msg) Log a message with fatal level.
void	logfine(String msg) Logs a message to the output stream.
void	loginfo(String msg) Log a message with info level.
void	logwarn(String msg) Log a message with warning level.
void	removeLogger(LogInterface logger) Remove a LogInterface from the internal list of loggers.
void	setCategory(String category) Sets the category for this Log
void	setDebug(boolean debug) Sets debug parameter
void	setLogger(org.apache.log4j.Logger logger) Deprecated. Do not use log4j directly
static void	setLoggingEnabled() Checks the com.ibm.di.logging.enabled property to see if logging is enabled
static void	setLoggingEnabled(boolean enabled) Disables or enables TDI logging.
void	setPrefix(String prefix) Sets a prefix to be prepended to all messages
void	warn(String res) Log a message with warning level.
void	warn(String res, Object param) Log a message with warning level.
void	warn(String res, Object[] params) Log a message with warning level.
void	warn(String res, Object param1, Object param2) Log a message with warning level.

Methods inherited from class java.lang.Object

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

Field Detail

debug

public boolean debug

The debug mode flag for the log.

Constructor Detail

Log

public Log(String resourceName)

A constructor which takes only a resource name.

Parameters:

resourceName - Name used both as translation resource name and the category name

Log

public Log(String resourceName,
           String category)

A constructor with both resourceName and category name

Parameters:

resourceName - Name used for locating translation resource

category - The category name for the loggers

Log

@Deprecated
public Log(String resourceName,
                      org.apache.log4j.Logger logger)

Deprecated.

A constructor with both resourceName and a Logger

Parameters:

resourceName - Name used for locating translation resource

logger - A Logger added to the list of loggers

Log

public Log(Log parentLog)

A constructor taking another Log as a parameter. All messages are logged to that Log's internal list of loggers.

Parameters:

parentLog - The other Log

Log

@Deprecated
public Log(String resourceName,
                      Log.InternalLogger loggers)

Deprecated.

A constructor with both resourceName and an InternalLogger

Parameters:

resourceName - Name used for locating translation resource

loggers - Used as the list of loggers

Method Detail

getLogger

@Deprecated
public org.apache.log4j.Logger getLogger()

Deprecated.

Returns:

The "first" org.apache.log4j.Logger object used by this Log

getLoggers

public Vector getLoggers()

Returns a Vector containing all org.apache.log4j.Logger objects used by this Log.

Returns:

a Vector containing all Logger objects used by this Log.

setLogger

@Deprecated
public void setLogger(org.apache.log4j.Logger logger)

Deprecated. Do not use log4j directly

Sets the Logger object.

Parameters:

logger - The new Logger object.

addLogger

@Deprecated
public void addLogger(org.apache.log4j.Logger logger)

Deprecated. Do not use log4j directly

Add a org.apache.log4j.Logger.

Parameters:

logger - The new Logger object

addLogger

public void addLogger(LogInterface logger)

Add a LogInterface to internal list of loggers.

Parameters:

logger - The new LogInterface object.

removeLogger

public void removeLogger(LogInterface logger)

Remove a LogInterface from the internal list of loggers.

Parameters:

logger - The LogInterface object.

getTDILog4j

public TDILog4j getTDILog4j()

Returns a TDILog4j Logger connected to this Log object.

Returns:

the TDILog4j Logger

getClassLogger

public LogInterface getClassLogger(String className)
                            throws Exception

Returns a LogInterface with the given class Name. An instance is created and added to the internal list of loggers.

Parameters:

className - The class name

Returns:

a LogInterface with the given class Name.

Throws:

Exception - if problem occurs

setDebug

public void setDebug(boolean debug)

Sets debug parameter

Parameters:

debug - true if debug level should be output as info

getDebug

public boolean getDebug()

Return the value of the debug parameter

Returns:

the boolean value

isDebugEnabled

public boolean isDebugEnabled()

Checks whether debug is enabled.

Returns:

true if the debug mode flag is true or any of the kept loggers has enabled debug, otherwise returns false.

setLoggingEnabled

public static void setLoggingEnabled()

Checks the com.ibm.di.logging.enabled property to see if logging is enabled

setLoggingEnabled

public static void setLoggingEnabled(boolean enabled)

Disables or enables TDI logging. All loggers are affected by this setting.

Parameters:

enabled - if true all loggers are enabled, otherwise they are disabled

isLoggingEnabled

public static boolean isLoggingEnabled()

Returns whether TDI logging is active or disabled.

Returns:

true if logging is enabled, otherwise false

setCategory

public void setCategory(String category)

Sets the category for this Log

Parameters:

category - The category

Since:

7.0

getCategory

public String getCategory()

Returns the category for this Log

Returns:

The category

Since:

7.0

setPrefix

public void setPrefix(String prefix)

Sets a prefix to be prepended to all messages

Parameters:

prefix -

getPrefix

public String getPrefix()

Returns the prefix to be prepended to all messages

Returns:

the prefix

getString

public String getString(String resource)

Return the NLS string given the resource.

Parameters:

resource - the given resource

Returns:

a NLS string

getString

public String getString(String resource,
                        Object param)

Return the NLS string given the resource and a parameter.

Parameters:

resource - the given resource

param - a parameter

Returns:

a NLS strings

getString

public String getString(String resource,
                        Object param1,
                        Object param2)

Return the NLS string given the resource and two parameters

Parameters:

resource - the given resource

param1 - a parameter

param2 - a parameter

Returns:

a NLS strings

getString

public String getString(String resource,
                        Object[] params)

Return the NLS string given the resource and an array of parameters

Parameters:

resource - the given resource

params - an array of parameters

Returns:

a NLS strings

close

public void close()

Close the output logger

logfine

public void logfine(String msg)

Logs a message to the output stream.

Parameters:

msg - The message to log.

logdebug

public void logdebug(String msg)

Log a message with info level if the debug mode flag is true, otherwise an debug level message is logged. This is done for all used loggers.

Parameters:

msg - the message to log

loginfo

public void loginfo(String msg)

Log a message with info level. This is done for all used loggers.

Parameters:

msg - the message to log

logwarn

public void logwarn(String msg)

Log a message with warning level. This is done for all used loggers.

Parameters:

msg - the message to log

logerror

public void logerror(String msg)

Log a message with error level. This is done for all used loggers.

Parameters:

msg - the message to log

logerror

public void logerror(String msg,
                     Throwable error)

Log a message with error level with an additional Throwable object. This is done for all used loggers.

Parameters:

msg - the message to log

error - the Throwable to be logged

logfatal

public void logfatal(String msg)

Log a message with fatal level. This is done for all used loggers.

Parameters:

msg - the message to log

fine

public void fine(String res)

Log a message with debug level. This is done for all used loggers. The message is a NLS string formed using the resource given.

Parameters:

res - the resource used for the message

fine

public void fine(String res,
                 Object param)

Log a message with debug level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

fine

public void fine(String res,
                 Object param1,
                 Object param2)

Log a message with debug level. This is done for all used loggers. The message is a NLS string formed using the resource and includes two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

fine

public void fine(String res,
                 Object[] params)

Log a message with debug level. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

debug

public void debug(String res)

Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged. This is done for all used loggers. The message is a NLS string formed using the resource given.

Parameters:

res - the resource used for the message

debug

public void debug(String res,
                  Object param)

Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

debug

public void debug(String res,
                  Object param1,
                  Object param2)

Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged. This is done for all used loggers. The message is a NLS string formed using the resource and includes two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

debug

public void debug(String res,
                  Object[] params)

Log a message with debug level if the debug mode flag is true, otherwise an info level message is logged. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

info

public void info(String res)

Log a message with info level. This is done for all used loggers. The message is a NLS string formed using the resource.

Parameters:

res - the resource used for the message

info

public void info(String res,
                 Object param)

Log a message with info level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

info

public void info(String res,
                 Object param1,
                 Object param2)

Log a message with info level. This is done for all used loggers. The message is a NLS string formed using the resource and includes two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

info

public void info(String res,
                 Object[] params)

Log a message with info level. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

warn

public void warn(String res)

Log a message with warning level. This is done for all used loggers. The message is a NLS string formed using the resource.

Parameters:

res - the resource used for the message

warn

public void warn(String res,
                 Object param)

Log a message with warning level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

warn

public void warn(String res,
                 Object param1,
                 Object param2)

Log a message with warning level. This is done for all used loggers. The message is a NLS string formed using the resource and includes two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

warn

public void warn(String res,
                 Object[] params)

Log a message with warning level. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

error

public void error(String res)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource.

Parameters:

res - the resource used for the message

error

public void error(String res,
                  Throwable error)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a Throwable object.

Parameters:

res - the resource used for the message

error - the Throwable to be logged

error

public void error(String res,
                  String param)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

error

public void error(String res,
                  Object param,
                  Throwable error)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter and a Throwable object.

Parameters:

res - the resource used for the message

param - a parameter for the message

error - the Throwable to be logged

error

public void error(String res,
                  String param1,
                  String param2)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

error

public void error(String res,
                  Object[] params)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

error

public void error(String res,
                  Object[] params,
                  Throwable error)

Log a message with error level. This is done for all used loggers. The message is a NLS string formed using the resource and includes array with parameters and a Throwable object.

Parameters:

res - the resource used for the message

params - an array with parameters for the message

error - the Throwable to be logged

fatal

public void fatal(String res)

Log a message with fatal level. This is done for all used loggers. The message is a NLS string formed using the resource given.

Parameters:

res - the resource used for the message

fatal

public void fatal(String res,
                  Throwable err)

Log a message with fatal level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a Throwable object.

Parameters:

res - the resource used for the message

err - the Throwable to be logged

fatal

public void fatal(String res,
                  Object param)

Log a message with fatal level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

fatal

public void fatal(String res,
                  Object param,
                  Throwable err)

Log a message with fatal level. This is done for all used loggers. The message is a NLS string formed using the resource and includes a parameter and a Throwable object.

Parameters:

res - the resource used for the message

param - a parameter for the message

err - the Throwable to be logged

fatal

public void fatal(String res,
                  Object[] params)

Log a message with fatal level. This is done for all used loggers. The message is a NLS string formed using the resource and includes the given parameters.

Parameters:

res - the resource used for the message

params - parameters for the message

log

public void log(String level,
                String msg)

Log a message with the specified level. This is done for all used loggers.

Parameters:

level - The level to use when logging

msg - The string to be logged

exception

public void exception(String res)
               throws Exception

Throws a new exception with a custom message. The message is a NLS string formed using the given resource.

Parameters:

res - the resource used for the message

Throws:

Exception - the thrown exception

exception

public void exception(String res,
                      Object param)
               throws Exception

Throws a new exception with a custom message. The message is a NLS string formed using the given resource and an additional parameter.

Parameters:

res - the resource used for the message

param - a parameter for the message

Throws:

Exception - the thrown exception

exception

public void exception(String res,
                      Object param1,
                      Object param2)
               throws Exception

Throws a new exception with a custom message. The message is a NLS string formed using the given resource and two additional parameters.

Parameters:

res - the resource used for the message

param1 - a parameter for the message

param2 - a parameter for the message

Throws:

Exception - the thrown exception

exception

public void exception(String res,
                      Object[] params)
               throws Exception

Throws a new exception with a custom message. The message is a NLS string formed using the given resource and an array of additional parameters.

Parameters:

res - the resource used for the message

params - parameters for the message

Throws:

Exception - the thrown exception

dumpEntry

public void dumpEntry(Entry e)

Dumps a formatted message to the logfile from the contents of an Entry

Parameters:

e - The entry to dump

See Also:

dump(java.lang.Object)

dump

public void dump(Object o)

This methods dumps an Object to the log file.

Parameters:

o - The entry to dump

See Also:

dumpEntry(com.ibm.di.entry.Entry)