Interface PatchLogger

  • All Known Implementing Classes:
    PatchLoggerImpl

    public interface PatchLogger
    Patch logger class which uses jspContext to log message to HAC and slf4j.Logger to log message in console/file.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  PatchLogger.LoggingMode
      Enumeration defining where the message should be logged
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String msg)
      Log a message at the DEBUG level.
      void debug​(java.lang.String msg, java.lang.Object arg)
      Log a message at the DEBUG level according to the specified message and argument.
      void debug​(java.lang.String msg, java.lang.Object... arguments)
      Log a message at the DEBUG level according to the specified message and arguments.
      void debug​(java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2)
      Log a message at the DEBUG level according to the specified message and arguments.
      void debug​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the DEBUG level with an accompanying message.
      void error​(PatchLogger.LoggingMode loggingMode, java.lang.String msg)
      Log a message at the ERROR level.
      void error​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg)
      Log a message at the ERROR level according to the specified message and argument.
      void error​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object... arguments)
      Log a message at the ERROR level according to the specified message and arguments.
      void error​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2)
      Log a message at the ERROR level according to the specified message and arguments.
      void error​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the ERROR level with an accompanying message.
      void error​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the ERROR level with an accompanying message.
      java.lang.String getName()
      Return the name of this Logger instance.
      void info​(PatchLogger.LoggingMode loggingMode, java.lang.String msg)
      Log a message at the INFO level.
      void info​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg)
      Log a message at the INFO level according to the specified message and argument.
      void info​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object... arguments)
      Log a message at the INFO level according to the specified message and arguments.
      void info​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2)
      Log a message at the INFO level according to the specified message and arguments.
      void info​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the INFO level with an accompanying message.
      void info​(java.lang.String msg)
      Log a message at the INFO level.
      boolean isDebugEnabled()
      Is the logger instance enabled for the DEBUG level?
      boolean isErrorEnabled()
      Is the logger instance enabled for the ERROR level?
      boolean isInfoEnabled()
      Is the logger instance enabled for the INFO level?
      boolean isWarnEnabled()
      Is the logger instance enabled for the WARN level?
      void warn​(PatchLogger.LoggingMode loggingMode, java.lang.String msg)
      Log a message at the WARN level.
      void warn​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg)
      Log a message at the WARN level according to the specified message and argument.
      void warn​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object... arguments)
      Log a message at the WARN level according to the specified message and arguments.
      void warn​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2)
      Log a message at the WARN level according to the specified message and arguments.
      void warn​(PatchLogger.LoggingMode loggingMode, java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the WARN level with an accompanying message.
    • Method Detail

      • getName

        java.lang.String getName()
        Return the name of this Logger instance.
        Returns:
        name of this logger instance
      • isDebugEnabled

        boolean isDebugEnabled()
        Is the logger instance enabled for the DEBUG level?
        Returns:
        True if this Logger is enabled for the DEBUG level, false otherwise.
      • debug

        void debug​(java.lang.String msg)
        Log a message at the DEBUG level.
        Parameters:
        msg - the message string to be logged
      • debug

        void debug​(java.lang.String msg,
                   java.lang.Object arg)
        Log a message at the DEBUG level according to the specified message and argument.

        This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

        Parameters:
        msg - the message string to be logged
        arg - the argument
      • debug

        void debug​(java.lang.String msg,
                   java.lang.Object arg1,
                   java.lang.Object arg2)
        Log a message at the DEBUG level according to the specified message and arguments.

        This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

        Parameters:
        msg - the message string to be logged
        arg1 - the first argument
        arg2 - the second argument
      • debug

        void debug​(java.lang.String msg,
                   java.lang.Object... arguments)
        Log a message at the DEBUG level according to the specified message and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the DEBUG level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for DEBUG. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        msg - the message string to be logged
        arguments - a list of 3 or more arguments
      • debug

        void debug​(java.lang.String msg,
                   java.lang.Throwable t)
        Log an exception (throwable) at the DEBUG level with an accompanying message.
        Parameters:
        msg - the message accompanying the exception
        t - the exception (throwable) to log
      • isInfoEnabled

        boolean isInfoEnabled()
        Is the logger instance enabled for the INFO level?
        Returns:
        True if this Logger is enabled for the INFO level, false otherwise.
      • info

        void info​(java.lang.String msg)
        Log a message at the INFO level.
        Parameters:
        msg - the message string to be logged
      • info

        void info​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg)
        Log a message at the INFO level.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
      • info

        void info​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object arg)
        Log a message at the INFO level according to the specified message and argument.

        This form avoids superfluous object creation when the logger is disabled for the INFO level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg - the argument
      • info

        void info​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object arg1,
                  java.lang.Object arg2)
        Log a message at the INFO level according to the specified message and arguments.

        This form avoids superfluous object creation when the logger is disabled for the INFO level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg1 - the first argument
        arg2 - the second argument
      • info

        void info​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object... arguments)
        Log a message at the INFO level according to the specified message and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the INFO level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for INFO. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arguments - a list of 3 or more arguments
      • info

        void info​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Throwable t)
        Log an exception (throwable) at the INFO level with an accompanying message.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message accompanying the exception
        t - the exception (throwable) to log
      • isWarnEnabled

        boolean isWarnEnabled()
        Is the logger instance enabled for the WARN level?
        Returns:
        True if this Logger is enabled for the WARN level, false otherwise.
      • warn

        void warn​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg)
        Log a message at the WARN level.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
      • warn

        void warn​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object arg)
        Log a message at the WARN level according to the specified message and argument.

        This form avoids superfluous object creation when the logger is disabled for the WARN level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg - the argument
      • warn

        void warn​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object... arguments)
        Log a message at the WARN level according to the specified message and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the WARN level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for WARN. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arguments - a list of 3 or more arguments
      • warn

        void warn​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Object arg1,
                  java.lang.Object arg2)
        Log a message at the WARN level according to the specified message and arguments.

        This form avoids superfluous object creation when the logger is disabled for the WARN level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg1 - the first argument
        arg2 - the second argument
      • warn

        void warn​(PatchLogger.LoggingMode loggingMode,
                  java.lang.String msg,
                  java.lang.Throwable t)
        Log an exception (throwable) at the WARN level with an accompanying message.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message accompanying the exception
        t - the exception (throwable) to log
      • isErrorEnabled

        boolean isErrorEnabled()
        Is the logger instance enabled for the ERROR level?
        Returns:
        True if this Logger is enabled for the ERROR level, false otherwise.
      • error

        void error​(PatchLogger.LoggingMode loggingMode,
                   java.lang.String msg)
        Log a message at the ERROR level.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
      • error

        void error​(PatchLogger.LoggingMode loggingMode,
                   java.lang.String msg,
                   java.lang.Object arg)
        Log a message at the ERROR level according to the specified message and argument.

        This form avoids superfluous object creation when the logger is disabled for the ERROR level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg - the argument
      • error

        void error​(PatchLogger.LoggingMode loggingMode,
                   java.lang.String msg,
                   java.lang.Object arg1,
                   java.lang.Object arg2)
        Log a message at the ERROR level according to the specified message and arguments.

        This form avoids superfluous object creation when the logger is disabled for the ERROR level.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arg1 - the first argument
        arg2 - the second argument
      • error

        void error​(PatchLogger.LoggingMode loggingMode,
                   java.lang.String msg,
                   java.lang.Object... arguments)
        Log a message at the ERROR level according to the specified message and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the ERROR level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for ERROR. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        loggingMode - define where the message should be logged
        msg - the message string to be logged
        arguments - a list of 3 or more arguments
      • error

        void error​(PatchLogger.LoggingMode loggingMode,
                   java.lang.String msg,
                   java.lang.Throwable t)
        Log an exception (throwable) at the ERROR level with an accompanying message.
        Parameters:
        loggingMode - define where the message should be logged
        msg - the message accompanying the exception
        t - the exception (throwable) to log
      • error

        void error​(java.lang.String msg,
                   java.lang.Throwable t)
        Log an exception (throwable) at the ERROR level with an accompanying message.
        Parameters:
        msg - the message accompanying the exception
        t - the exception (throwable) to log