Package org.pentaho.platform.api.engine
Interface ILogger
-
- All Known Subinterfaces:
IComponent
,IContentGenerator
,IDataComponent
,IPentahoSession
,IPreparedComponent
,IRuntimeContext
,IRuntimeRepository
,ISolutionEngine
public interface ILogger
The 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 String
ACTIVITY_LOG
static int
DEBUG
The DEBUG Level designates fine-grained informational events that are most useful to debug an application.static int
ERROR
The ERROR level designates error events that might still allow the application to continue running.static int
FATAL
The FATAL level designates very severe error events that will presumably lead the application to abort.static int
INFO
The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.static String
INSTANCE_LOG
static String
SESSION_LOG
static String
SOLUTION_LOG
static int
TRACE
The TRACE has the lowest possible rank and is intended to turn on all logging.static int
UNKNOWN
static int
WARN
The WARN level designates potentially harmful situations.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
debug(String message)
Log a message object with theDEBUG
Level.void
debug(String message, Throwable error)
Log a message with theDEBUG
level including the stack trace of the Throwable error passed as parameter.void
error(String message)
Log a message object with theERROR
Level.void
error(String message, Throwable error)
Log a message with theERROR
level including the stack trace of the Throwable error passed as parameter.void
fatal(String message)
Log a message object with theFATAL
Level.void
fatal(String message, Throwable error)
Log a message with theFATAL
level including the stack trace of the Throwable error passed as parameter.int
getLoggingLevel()
Return the logging level for this Logger.void
info(String message)
Log a message object with theINFO
Level.void
info(String message, Throwable error)
Log a message with theINFO
level including the stack trace of the Throwable error passed as parameter.void
setLoggingLevel(int loggingLevel)
Set the logging level for this Logger.void
trace(String message)
Log a message object with theTRACE
Level.void
trace(String message, Throwable error)
Log a message with theTRACE
level including the stack trace of the Throwable error passed as parameter.void
warn(String message)
Log a message object with theWARN
Level.void
warn(String message, Throwable error)
Log a message with theWARN
level 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 theTRACE
Level.- Parameters:
message
- the message object to log.
-
debug
void debug(String message)
Log a message object with theDEBUG
Level.- Parameters:
message
- the message object to log.
-
info
void info(String message)
Log a message object with theINFO
Level.- Parameters:
message
- the message object to log.
-
warn
void warn(String message)
Log a message object with theWARN
Level.- Parameters:
message
- the message object to log.
-
error
void error(String message)
Log a message object with theERROR
Level.- Parameters:
message
- the message object to log.
-
fatal
void fatal(String message)
Log a message object with theFATAL
Level.- Parameters:
message
- the message object to log.
-
trace
void trace(String message, Throwable error)
Log a message with theTRACE
level 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 theDEBUG
level 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 theINFO
level 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 theWARN
level 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 theERROR
level 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.
-
-