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 final String
    ACTIVITY_LOG
     
    static final int
    DEBUG
    The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
    static final int
    ERROR
    The ERROR level designates error events that might still allow the application to continue running.
    static final int
    FATAL
    The FATAL level designates very severe error events that will presumably lead the application to abort.
    static final int
    INFO
    The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
    static final String
    INSTANCE_LOG
     
    static final String
    SESSION_LOG
     
    static final String
    SOLUTION_LOG
     
    static final int
    TRACE
    The TRACE has the lowest possible rank and is intended to turn on all logging.
    static final int
    UNKNOWN
     
    static final int
    WARN
    The WARN level designates potentially harmful situations.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    debug(String message)
    Log a message object with the DEBUG Level.
    void
    debug(String message, Throwable error)
    Log a message with the DEBUG level including the stack trace of the Throwable error passed as parameter.
    void
    error(String message)
    Log a message object with the ERROR Level.
    void
    error(String message, Throwable error)
    Log a message with the ERROR level including the stack trace of the Throwable error passed as parameter.
    void
    fatal(String message)
    Log a message object with the FATAL Level.
    void
    fatal(String message, Throwable error)
    Log a message with the FATAL 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 the INFO Level.
    void
    info(String message, Throwable error)
    Log a message with the INFO 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 the TRACE Level.
    void
    trace(String message, Throwable error)
    Log a message with the TRACE level including the stack trace of the Throwable error passed as parameter.
    void
    warn(String message)
    Log a message object with the WARN Level.
    void
    warn(String message, Throwable error)
    Log a message with the WARN level including the stack trace of the Throwable error passed as parameter.

  • Field Details

    • TRACE

      static final int TRACE
      The TRACE has the lowest possible rank and is intended to turn on all logging.
      See Also:

    • DEBUG

      static final int DEBUG
      The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
      See Also:

    • INFO

      static final int INFO
      The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
      See Also:

    • WARN

      static final int WARN
      The WARN level designates potentially harmful situations.
      See Also:

    • ERROR

      static final int ERROR
      The ERROR level designates error events that might still allow the application to continue running.
      See Also:

    • FATAL

      static final int FATAL
      The FATAL level designates very severe error events that will presumably lead the application to abort.
      See Also:

    • UNKNOWN

      static final int UNKNOWN
      See Also:

    • SOLUTION_LOG

      static final String SOLUTION_LOG
      See Also:

    • ACTIVITY_LOG

      static final String ACTIVITY_LOG
      See Also:

    • INSTANCE_LOG

      static final String INSTANCE_LOG
      See Also:

    • SESSION_LOG

      static final String SESSION_LOG
      See Also:

  • Method Details

    • 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, and FATAL.

      Parameters:
      loggingLevel -

    • trace

      void trace(String message)
      Log a message object with the TRACE Level.
      Parameters:
      message - the message object to log.

    • debug

      void debug(String message)
      Log a message object with the DEBUG Level.
      Parameters:
      message - the message object to log.

    • info

      void info(String message)
      Log a message object with the INFO Level.
      Parameters:
      message - the message object to log.

    • warn

      void warn(String message)
      Log a message object with the WARN Level.
      Parameters:
      message - the message object to log.

    • error

      void error(String message)
      Log a message object with the ERROR Level.
      Parameters:
      message - the message object to log.

    • fatal

      void fatal(String message)
      Log a message object with the FATAL Level.
      Parameters:
      message - the message object to log.

    • trace

      void trace(String message, Throwable error)
      Log a message with the TRACE 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 the DEBUG 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 the INFO 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 the WARN 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 the ERROR 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.

    • fatal

      void fatal(String message, Throwable error)
      Log a message with the FATAL 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.