com.ibm.di.api.local.impl
Class LogListenerAdapter

java.lang.Object
  extended by com.ibm.di.api.local.impl.LogListenerAdapter
All Implemented Interfaces:
LogInterface

public class LogListenerAdapter
extends java.lang.Object
implements LogInterface

Adapt the local API's log listener interface to the log interface of the Server.

Since:
7.0

Field Summary
 
Fields inherited from interface com.ibm.di.log.LogInterface
CONFIG_INSTANCE, NAME, TIME, TYPE
 
Constructor Summary
LogListenerAdapter(LogListener logListener, Log log, java.text.Format logMsgFormat)
          Constructor
 
Method Summary
 void addAppender(LogConfigItem config, java.util.Map params)
          Add an Appender to the Logger using the given config.
 void close()
          Free up all resources this logger uses.
 void debug(java.lang.String str)
          Log a message with level debug.
 void error(java.lang.String str)
          Log a message with level error.
 void error(java.lang.String str, java.lang.Throwable error)
          Log a message with level error, and an additional Throwable.
 void fatal(java.lang.String str)
          Log a message with level fatal.
 void fatal(java.lang.String str, java.lang.Throwable error)
          Log a message with level fatal, and an additional Throwable.
 void info(java.lang.String str)
          Log a message with level info.
 boolean isDebugEnabled()
          Check if a debug message would be logged.
 void log(java.lang.String level, java.lang.String str)
          Log a message with the specified level.
 void setCategory(java.lang.String category)
          Set the category for this Logger.
 void warn(java.lang.String str)
          Log a message with level warning.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LogListenerAdapter

public LogListenerAdapter(LogListener logListener,
                          Log log,
                          java.text.Format logMsgFormat)
Constructor

Parameters:
logListener - Log listener from the remote Server API layer.
log - The Log, which contains this object. Necessary so that we can unregister ourselves in case of error.
Method Detail

addAppender

public void addAppender(LogConfigItem config,
                        java.util.Map params)
                 throws java.lang.Exception
Add an Appender to the Logger using the given config. Appender is the org.apache.log4j name, java.util.logging would call it a Handler. May throw an Exception if the config does not make sense.
The params Map may contain these keys to help set up the Appender:

Specified by:
addAppender in interface LogInterface
Parameters:
config - The LogConfigItem.
params - Extra information that may be useful/
Throws:
java.lang.Exception

close

public void close()
Free up all resources this logger uses. The logger will not be called anymore.

Specified by:
close in interface LogInterface

debug

public void debug(java.lang.String str)
Log a message with level debug.

Specified by:
debug in interface LogInterface
Parameters:
str - The string to be logged

error

public void error(java.lang.String str)
Log a message with level error.

Specified by:
error in interface LogInterface
Parameters:
str - The string to be logged

error

public void error(java.lang.String str,
                  java.lang.Throwable error)
Log a message with level error, and an additional Throwable.

Specified by:
error in interface LogInterface
Parameters:
str - The string to be logged
error - The Throwable to be logged

fatal

public void fatal(java.lang.String str)
Log a message with level fatal.

Specified by:
fatal in interface LogInterface
Parameters:
str - The string to be logged

fatal

public void fatal(java.lang.String str,
                  java.lang.Throwable error)
Log a message with level fatal, and an additional Throwable.

Specified by:
fatal in interface LogInterface
Parameters:
str - The string to be logged
error - The Throwable to be logged

info

public void info(java.lang.String str)
Log a message with level info.

Specified by:
info in interface LogInterface
Parameters:
str - The string to be logged

isDebugEnabled

public boolean isDebugEnabled()
Check if a debug message would be logged.

Specified by:
isDebugEnabled in interface LogInterface
Returns:
true if a debug message might be logged

log

public void log(java.lang.String level,
                java.lang.String str)
Log a message with the specified level.

Specified by:
log in interface LogInterface
Parameters:
level - The level to use when logging.
str - The string to be logged

setCategory

public void setCategory(java.lang.String category)
                 throws java.lang.Exception
Set the category for this Logger. This method specifies a category, to allow a category based configuration.

Specified by:
setCategory in interface LogInterface
Parameters:
category - The category to use.
Throws:
java.lang.Exception

warn

public void warn(java.lang.String str)
Log a message with level warning.

Specified by:
warn in interface LogInterface
Parameters:
str - The string to be logged