Package fr.gouv.vitam.common.logging

Interface VitamLogger

  • All Known Implementing Classes:
    AbstractVitamLogger
    public interface VitamLogger
    Internal-use-only logger used by VITAM. DO NOT access this class outside of VITAM.

    • 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 format, java.lang.Object arg)
      Log a message at the DEBUG level according to the specified format and argument.
      void debug​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the DEBUG level according to the specified format and arguments.
      void debug​(java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the DEBUG level according to the specified format 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 debug​(java.lang.Throwable t)
      Log an exception (throwable) at the DEBUG level.
      void error​(java.lang.String msg)
      Log a message at the ERROR level.
      void error​(java.lang.String format, java.lang.Object arg)
      Log a message at the ERROR level according to the specified format and argument.
      void error​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the ERROR level according to the specified format and arguments.
      void error​(java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the ERROR level according to the specified format and arguments.
      void error​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the ERROR level with an accompanying message.
      void error​(java.lang.Throwable t)
      Log an exception (throwable) at the ERROR level.
      VitamLogLevel getLevel()
      Get the log level of this logger
      void info​(java.lang.String msg)
      Log a message at the INFO level.
      void info​(java.lang.String format, java.lang.Object arg)
      Log a message at the INFO level according to the specified format and argument.
      void info​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the INFO level according to the specified format and arguments.
      void info​(java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the INFO level according to the specified format and arguments.
      void info​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the INFO level with an accompanying message.
      void info​(java.lang.Throwable t)
      Log an exception (throwable) at the INFO level.
      boolean isDebugEnabled()
      Is the logger instance enabled for the DEBUG level?
      boolean isEnabled​(VitamLogLevel level)
      Is the logger instance enabled for the specified level?
      boolean isErrorEnabled()
      Is the logger instance enabled for the ERROR level?
      boolean isInfoEnabled()
      Is the logger instance enabled for the INFO level?
      boolean isTraceEnabled()
      Is the logger instance enabled for the TRACE level?
      boolean isWarnEnabled()
      Is the logger instance enabled for the WARN level?
      void log​(VitamLogLevel level, java.lang.String msg)
      Log a message at the specified level.
      void log​(VitamLogLevel level, java.lang.String format, java.lang.Object arg)
      Log a message at the specified level according to the specified format and argument.
      void log​(VitamLogLevel level, java.lang.String format, java.lang.Object... arguments)
      Log a message at the specified level according to the specified format and arguments.
      void log​(VitamLogLevel level, java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the specified level according to the specified format and arguments.
      void log​(VitamLogLevel level, java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the specified level with an accompanying message.
      void log​(VitamLogLevel level, java.lang.Throwable t)
      Log an exception (throwable) at the specified level.
      java.lang.String name()
      Return the name of this VitamLogger instance.
      void setLevel​(VitamLogLevel level)
      Change the log level of this logger
      void timeInfo​(java.lang.String msg)
      Time Info
      void timeInfo​(java.lang.String format, java.lang.Object... arguments)
      Time Info
      void trace​(java.lang.String msg)
      Log a message at the TRACE level.
      void trace​(java.lang.String format, java.lang.Object arg)
      Log a message at the TRACE level according to the specified format and argument.
      void trace​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the TRACE level according to the specified format and arguments.
      void trace​(java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the TRACE level according to the specified format and arguments.
      void trace​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the TRACE level with an accompanying message.
      void trace​(java.lang.Throwable t)
      Log an exception (throwable) at the TRACE level.
      void warn​(java.lang.String msg)
      Log a message at the WARN level.
      void warn​(java.lang.String format, java.lang.Object arg)
      Log a message at the WARN level according to the specified format and argument.
      void warn​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the WARN level according to the specified format and arguments.
      void warn​(java.lang.String format, java.lang.Object argA, java.lang.Object argB)
      Log a message at the WARN level according to the specified format and arguments.
      void warn​(java.lang.String msg, java.lang.Throwable t)
      Log an exception (throwable) at the WARN level with an accompanying message.
      void warn​(java.lang.Throwable t)
      Log an exception (throwable) at the WARN level.

    • Method Detail

      • name

        java.lang.String name()
        Return the name of this VitamLogger instance.
        Returns:
        name of this logger instance

      • setLevel

        void setLevel​(VitamLogLevel level)
        Change the log level of this logger
        Parameters:
        level -

      • getLevel

        VitamLogLevel getLevel()
        Get the log level of this logger
        Returns:
        level

      • timeInfo

        void timeInfo​(java.lang.String msg)
        Time Info
        Parameters:
        msg -

      • timeInfo

        void timeInfo​(java.lang.String format,
              java.lang.Object... arguments)
        Time Info
        Parameters:
        format -
        arguments -

      • isTraceEnabled

        boolean isTraceEnabled()
        Is the logger instance enabled for the TRACE level?
        Returns:
        True if this Logger is enabled for the TRACE level, false otherwise.

      • trace

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

      • trace

        void trace​(java.lang.String format,
           java.lang.Object arg)
        Log a message at the TRACE level according to the specified format and argument.

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

        Parameters:
        format - the format string
        arg - the argument

      • trace

        void trace​(java.lang.String format,
           java.lang.Object argA,
           java.lang.Object argB)
        Log a message at the TRACE level according to the specified format and arguments.

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

        Parameters:
        format - the format string
        argA - the first argument
        argB - the second argument

      • trace

        void trace​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the TRACE level according to the specified format and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the TRACE 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 TRACE. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        format - the format string
        arguments - a list of 3 or more arguments

      • trace

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

      • trace

        void trace​(java.lang.Throwable t)
        Log an exception (throwable) at the TRACE level.
        Parameters:
        t - the exception (throwable) to log

      • 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 format,
           java.lang.Object arg)
        Log a message at the DEBUG level according to the specified format and argument.

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

        Parameters:
        format - the format string
        arg - the argument

      • debug

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

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

        Parameters:
        format - the format string
        argA - the first argument
        argB - the second argument

      • debug

        void debug​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the DEBUG level according to the specified format 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:
        format - the format string
        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

      • debug

        void debug​(java.lang.Throwable t)
        Log an exception (throwable) at the DEBUG level.
        Parameters:
        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​(java.lang.String format,
          java.lang.Object arg)
        Log a message at the INFO level according to the specified format and argument.

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

        Parameters:
        format - the format string
        arg - the argument

      • info

        void info​(java.lang.String format,
          java.lang.Object argA,
          java.lang.Object argB)
        Log a message at the INFO level according to the specified format and arguments.

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

        Parameters:
        format - the format string
        argA - the first argument
        argB - the second argument

      • info

        void info​(java.lang.String format,
          java.lang.Object... arguments)
        Log a message at the INFO level according to the specified format 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:
        format - the format string
        arguments - a list of 3 or more arguments

      • info

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

      • info

        void info​(java.lang.Throwable t)
        Log an exception (throwable) at the INFO level.
        Parameters:
        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​(java.lang.String msg)
        Log a message at the WARN level.
        Parameters:
        msg - the message string to be logged

      • warn

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

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

        Parameters:
        format - the format string
        arg - the argument

      • warn

        void warn​(java.lang.String format,
          java.lang.Object... arguments)
        Log a message at the WARN level according to the specified format 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:
        format - the format string
        arguments - a list of 3 or more arguments

      • warn

        void warn​(java.lang.String format,
          java.lang.Object argA,
          java.lang.Object argB)
        Log a message at the WARN level according to the specified format and arguments.

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

        Parameters:
        format - the format string
        argA - the first argument
        argB - the second argument

      • warn

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

      • warn

        void warn​(java.lang.Throwable t)
        Log an exception (throwable) at the WARN level.
        Parameters:
        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​(java.lang.String msg)
        Log a message at the ERROR level.
        Parameters:
        msg - the message string to be logged

      • error

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

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

        Parameters:
        format - the format string
        arg - the argument

      • error

        void error​(java.lang.String format,
           java.lang.Object argA,
           java.lang.Object argB)
        Log a message at the ERROR level according to the specified format and arguments.

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

        Parameters:
        format - the format string
        argA - the first argument
        argB - the second argument

      • error

        void error​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the ERROR level according to the specified format 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:
        format - the format string
        arguments - a list of 3 or more arguments

      • 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

      • error

        void error​(java.lang.Throwable t)
        Log an exception (throwable) at the ERROR level.
        Parameters:
        t - the exception (throwable) to log

      • isEnabled

        boolean isEnabled​(VitamLogLevel level)
        Is the logger instance enabled for the specified level?
        Parameters:
        level -
        Returns:
        True if this Logger is enabled for the specified level, false otherwise.

      • log

        void log​(VitamLogLevel level,
         java.lang.String msg)
        Log a message at the specified level.
        Parameters:
        level -
        msg - the message string to be logged

      • log

        void log​(VitamLogLevel level,
         java.lang.String format,
         java.lang.Object arg)
        Log a message at the specified level according to the specified format and argument.

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

        Parameters:
        level -
        format - the format string
        arg - the argument

      • log

        void log​(VitamLogLevel level,
         java.lang.String format,
         java.lang.Object argA,
         java.lang.Object argB)
        Log a message at the specified level according to the specified format and arguments.

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

        Parameters:
        level -
        format - the format string
        argA - the first argument
        argB - the second argument

      • log

        void log​(VitamLogLevel level,
         java.lang.String format,
         java.lang.Object... arguments)
        Log a message at the specified level according to the specified format and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the specified 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 the specified level. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

        Parameters:
        level -
        format - the format string
        arguments - a list of 3 or more arguments

      • log

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

      • log

        void log​(VitamLogLevel level,
         java.lang.Throwable t)
        Log an exception (throwable) at the specified level.
        Parameters:
        level -
        t - the exception (throwable) to log