Package org.pentaho.platform.api.engine
Interface ILogger
- 
- All Known Subinterfaces:
 IComponent,IContentGenerator,IDataComponent,IPentahoSession,IPreparedComponent,IRuntimeContext,IRuntimeRepository,ISolutionEngine
public interface ILoggerThe Logger is the main interface into the platform's logging subsystem.Note: Documentation taken from Log4j Javadoc documentation.
 
- 
- 
Field Summary
Fields Modifier and Type Field Description static StringACTIVITY_LOGstatic intDEBUGThe DEBUG Level designates fine-grained informational events that are most useful to debug an application.static intERRORThe ERROR level designates error events that might still allow the application to continue running.static intFATALThe FATAL level designates very severe error events that will presumably lead the application to abort.static intINFOThe INFO level designates informational messages that highlight the progress of the application at coarse-grained level.static StringINSTANCE_LOGstatic StringSESSION_LOGstatic StringSOLUTION_LOGstatic intTRACEThe TRACE has the lowest possible rank and is intended to turn on all logging.static intUNKNOWNstatic intWARNThe WARN level designates potentially harmful situations. 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddebug(String message)Log a message object with theDEBUGLevel.voiddebug(String message, Throwable error)Log a message with theDEBUGlevel including the stack trace of the Throwable error passed as parameter.voiderror(String message)Log a message object with theERRORLevel.voiderror(String message, Throwable error)Log a message with theERRORlevel including the stack trace of the Throwable error passed as parameter.voidfatal(String message)Log a message object with theFATALLevel.voidfatal(String message, Throwable error)Log a message with theFATALlevel including the stack trace of the Throwable error passed as parameter.intgetLoggingLevel()Return the logging level for this Logger.voidinfo(String message)Log a message object with theINFOLevel.voidinfo(String message, Throwable error)Log a message with theINFOlevel including the stack trace of the Throwable error passed as parameter.voidsetLoggingLevel(int loggingLevel)Set the logging level for this Logger.voidtrace(String message)Log a message object with theTRACELevel.voidtrace(String message, Throwable error)Log a message with theTRACElevel including the stack trace of the Throwable error passed as parameter.voidwarn(String message)Log a message object with theWARNLevel.voidwarn(String message, Throwable error)Log a message with theWARNlevel including the stack trace of the Throwable error passed as parameter. 
 - 
 
- 
- 
Field Detail
- 
TRACE
static final int TRACE
The TRACE has the lowest possible rank and is intended to turn on all logging.- See Also:
 - Constant Field Values
 
 
- 
DEBUG
static final int DEBUG
The DEBUG Level designates fine-grained informational events that are most useful to debug an application.- See Also:
 - Constant Field Values
 
 
- 
INFO
static final int INFO
The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.- See Also:
 - Constant Field Values
 
 
- 
WARN
static final int WARN
The WARN level designates potentially harmful situations.- See Also:
 - Constant Field Values
 
 
- 
ERROR
static final int ERROR
The ERROR level designates error events that might still allow the application to continue running.- See Also:
 - Constant Field Values
 
 
- 
FATAL
static final int FATAL
The FATAL level designates very severe error events that will presumably lead the application to abort.- See Also:
 - Constant Field Values
 
 
- 
UNKNOWN
static final int UNKNOWN
- See Also:
 - Constant Field Values
 
 
- 
SOLUTION_LOG
static final String SOLUTION_LOG
- See Also:
 - Constant Field Values
 
 
- 
ACTIVITY_LOG
static final String ACTIVITY_LOG
- See Also:
 - Constant Field Values
 
 
- 
INSTANCE_LOG
static final String INSTANCE_LOG
- See Also:
 - Constant Field Values
 
 
- 
SESSION_LOG
static final String SESSION_LOG
- See Also:
 - Constant Field Values
 
 
 - 
 
- 
Method Detail
- 
getLoggingLevel
int getLoggingLevel()
Return the logging level for this Logger.- Returns:
 - logging level
 
 
- 
setLoggingLevel
void setLoggingLevel(int loggingLevel)
Set the logging level for this Logger.Valid logging levels are
TRACE,DEBUG,INFO,WARN,ERROR, andFATAL.- Parameters:
 loggingLevel-
 
- 
trace
void trace(String message)
Log a message object with theTRACELevel.- Parameters:
 message- the message object to log.
 
- 
debug
void debug(String message)
Log a message object with theDEBUGLevel.- Parameters:
 message- the message object to log.
 
- 
info
void info(String message)
Log a message object with theINFOLevel.- Parameters:
 message- the message object to log.
 
- 
warn
void warn(String message)
Log a message object with theWARNLevel.- Parameters:
 message- the message object to log.
 
- 
error
void error(String message)
Log a message object with theERRORLevel.- Parameters:
 message- the message object to log.
 
- 
fatal
void fatal(String message)
Log a message object with theFATALLevel.- Parameters:
 message- the message object to log.
 
- 
trace
void trace(String message, Throwable error)
Log a message with theTRACElevel including the stack trace of the Throwable error passed as parameter.- Parameters:
 message- the message object to log.error- the exception to log, including its stack trace.
 
- 
debug
void debug(String message, Throwable error)
Log a message with theDEBUGlevel including the stack trace of the Throwable error passed as parameter.- Parameters:
 message- the message object to log.error- the exception to log, including its stack trace.
 
- 
info
void info(String message, Throwable error)
Log a message with theINFOlevel including the stack trace of the Throwable error passed as parameter.- Parameters:
 message- the message object to log.error- the exception to log, including its stack trace.
 
- 
warn
void warn(String message, Throwable error)
Log a message with theWARNlevel including the stack trace of the Throwable error passed as parameter.- Parameters:
 message- the message object to log.error- the exception to log, including its stack trace.
 
- 
error
void error(String message, Throwable error)
Log a message with theERRORlevel including the stack trace of the Throwable error passed as parameter.- Parameters:
 message- the message object to log.error- the exception to log, including its stack trace.
 
 - 
 
 -