com.ibm.di.protocols.rxa
Interface LogProxy

All Known Implementing Classes:
LogProxyImpl

public interface LogProxy

Interface for the Log proxy class. This interface matches server.Log.


Method Summary
 void close()
          Close the output logger
 void debug(String res)
          Logs a debug message
 void debug(String res, Object param)
          Logs a debug message
 void debug(String res, Object[] params)
          Logs a debug message
 void debug(String res, Object param1, Object param2)
          Logs a debug message
 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)
          Logs an error message
 void error(String res, Object[] params)
          Logs an error message
 void error(String res, Object[] params, Throwable error)
          Logs an error message
 void error(String res, Object param, Throwable error)
          Logs an error message
 void error(String res, String param)
          Logs an error message
 void error(String res, String param1, String param2)
          Logs an error message
 void error(String res, Throwable error)
          Logs an error message
 void fatal(String res)
          Log a message with level fatal
 void fatal(String res, Object param)
          Log a message with level fatal
 void fatal(String res, Object[] params)
          Log a message with level fatal
 void fatal(String res, Object param, Throwable err)
          Log a message with level fatal
 void fatal(String res, Throwable err)
          Log a message with level fatal
 void fine(String res)
          Logs a debug message if logging is enabled
 void fine(String res, Object param)
          Logs a debug message if logging is enabled
 void fine(String res, Object[] params)
          Logs a debug message if logging is enabled
 void fine(String res, Object param1, Object param2)
          Logs a debug message if logging is enabled
 boolean getDebug()
          Return the value of the debug parameter.
 Log getLog()
          Gets the server logger
 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.
 void info(String res)
          Log a message with level info
 void info(String res, Object param)
          Log a message with level info
 void info(String res, Object[] params)
          Log a message with level info
 void info(String res, Object param1, Object param2)
          Log a message with level info
 void log(String level, String msg)
          Log a message with the specified level
 void logdebug(String msg)
          Log a message with debug level
 void logerror(String msg)
          Log a message with error level
 void logerror(String msg, Throwable error)
          Log a message with error level
 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)
          Logs a message to the output stream.
 void logwarn(String msg)
          Logs a message to the output stream.
 void setDebug(boolean debug)
          Sets debug parameter.
 void setPrefix(String prefix)
          Sets a prefix to be prepended to all messages.
 void warn(String res)
          Log a message with level warning
 void warn(String res, Object param)
          Log a message with level warning
 void warn(String res, Object[] params)
          Log a message with level warning
 void warn(String res, Object param1, Object param2)
          Log a message with level warning
 

Method Detail

close

void close()
Close the output logger


debug

void debug(String res)
Logs a debug message

Parameters:
res - Text of the message

debug

void debug(String res,
           Object param)
Logs a debug message

Parameters:
res - Text of the message
param - parameter of the message

debug

void debug(String res,
           Object[] params)
Logs a debug message

Parameters:
res - Text of the message
params - parameters of the message

debug

void debug(String res,
           Object param1,
           Object param2)
Logs a debug message

Parameters:
res - Text of the message
param1 - First parameter of the message
param2 - Second parameter of the message

dump

void dump(Object o)
This methods dumps an Object to the log file.

Parameters:
o - Object

dumpEntry

void dumpEntry(Entry e)
Dumps a formatted message to the logfile from the contents of an Entry.

Parameters:
e - Entry

error

void error(String res)
Logs an error message

Parameters:
res - Text of the message

error

void error(String res,
           Object[] params)
Logs an error message

Parameters:
res - Text of the message
params - parameters of the message

error

void error(String res,
           Object[] params,
           Throwable error)
Logs an error message

Parameters:
res - Text of the message
params - parameters of the message
error - Throwable error

error

void error(String res,
           Object param,
           Throwable error)
Logs an error message

Parameters:
res - Text of the message
param - parameter of the message
error - Throwable error

error

void error(String res,
           String param)
Logs an error message

Parameters:
res - Text of the message
param - parameter of the message

error

void error(String res,
           String param1,
           String param2)
Logs an error message

Parameters:
res - Text of the message
param1 - first parameters of the message
param2 - second parameters of the message

error

void error(String res,
           Throwable error)
Logs an error message

Parameters:
res - Text of the message
error - Throwable error

fatal

void fatal(String res)
Log a message with level fatal

Parameters:
res - Text of the message

fatal

void fatal(String res,
           Object param)
Log a message with level fatal

Parameters:
res - Text of the message
param - parameter of the message

fatal

void fatal(String res,
           Object[] params)
Log a message with level fatal

Parameters:
res - Text of the message
params - parameters of the message

fatal

void fatal(String res,
           Object param,
           Throwable err)
Log a message with level fatal

Parameters:
res - Text of the message
param - parameter of the message
err - Throwable error

fatal

void fatal(String res,
           Throwable err)
Log a message with level fatal

Parameters:
res - Text of the message
err - Throwable error

fine

void fine(String res)
Logs a debug message if logging is enabled

Parameters:
res - Text of the message

fine

void fine(String res,
          Object param)
Logs a debug message if logging is enabled

Parameters:
res - Text of the message
param - parameter of the message

fine

void fine(String res,
          Object[] params)
Logs a debug message if logging is enabled

Parameters:
res - Text of the message
params - parameters of the message

fine

void fine(String res,
          Object param1,
          Object param2)
Logs a debug message if logging is enabled

Parameters:
res - Text of the message
param1 - first parameter of the message
param2 - second parameter of the message

getDebug

boolean getDebug()
Return the value of the debug parameter.

Returns:
the value of the debug parameter

getPrefix

String getPrefix()
Returns the prefix to be prepended to all messages.

Returns:
prefix

getString

String getString(String resource)
Return the NLS string given the resource.

Parameters:
resource - String
Returns:
NLS String

getString

String getString(String resource,
                 Object param)
Return the NLS string given the resource and a parameter.

Parameters:
resource - String
param - parameter
Returns:
NLS String

getString

String getString(String resource,
                 Object[] params)
Return the NLS string given the resource and an array of parameters.

Parameters:
resource - String
params - Array of parameters
Returns:
NLS String

getString

String getString(String resource,
                 Object param1,
                 Object param2)
Return the NLS string given the resource and two parameters.

Parameters:
resource - String
param1 - first parameter
param2 - second parameter
Returns:
NLS String

info

void info(String res)
Log a message with level info

Parameters:
res - Text of the message

info

void info(String res,
          Object param)
Log a message with level info

Parameters:
res - Text of the message
param - parameter of the message

info

void info(String res,
          Object[] params)
Log a message with level info

Parameters:
res - Text of the message
params - parameters of the message

info

void info(String res,
          Object param1,
          Object param2)
Log a message with level info

Parameters:
res - Text of the message
param1 - first parameter of the message
param2 - second parameter of the message

log

void log(String level,
         String msg)
Log a message with the specified level

Parameters:
level - the level of the message
msg - Text of the message

logdebug

void logdebug(String msg)
Log a message with debug level

Parameters:
msg - Text of the message

logerror

void logerror(String msg)
Log a message with error level

Parameters:
msg - Text of the message

logerror

void logerror(String msg,
              Throwable error)
Log a message with error level

Parameters:
msg - Text of the message
error - Throwable error

logfatal

void logfatal(String msg)
Log a message with fatal level

Parameters:
msg - Text of the message

logfine

void logfine(String msg)
Logs a message to the output stream.

Parameters:
msg - Text of the message

loginfo

void loginfo(String msg)
Logs a message to the output stream.

Parameters:
msg - Text of the message

logwarn

void logwarn(String msg)
Logs a message to the output stream.

Parameters:
msg - Text of the message

setDebug

void setDebug(boolean debug)
Sets debug parameter.

Parameters:
debug - true or false

setPrefix

void setPrefix(String prefix)
Sets a prefix to be prepended to all messages.

Parameters:
prefix -

warn

void warn(String res)
Log a message with level warning

Parameters:
res - Text of the message

warn

void warn(String res,
          Object param)
Log a message with level warning

Parameters:
res - Text of the message
param - parameter of the message

warn

void warn(String res,
          Object[] params)
Log a message with level warning

Parameters:
res - Text of the message
params - parameters of the message

warn

void warn(String res,
          Object param1,
          Object param2)
Log a message with level warning

Parameters:
res - Text of the message
param1 - first parameter of the message
param2 - second parameter of the message

getLog

Log getLog()
Gets the server logger

Returns:
the Log object