Package org.identityconnectors.common.logging

Class Log

  • public final class Log
extends java.lang.Object
    Yet another logging abstraction.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Log.Level
      Basic logging levels.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String LOGSPI_PROP
      System property to set the logger class that is most appropriate.
      static java.lang.String LOGSPI_PROPS_FILE
      Filename 'connectors.properties' used to for SPI class in the '$(java.home)/lib/' directory.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void error​(java.lang.String format, java.lang.Object... args)  
      void error​(java.lang.Throwable ex, java.lang.String format, java.lang.Object... args)  
      static Log getLog​(java.lang.Class<?> clazz)
      Get the logger for the particular class.
      static Log getLog​(java.lang.Class<?> clazz, java.lang.String instanceName)
      Get the logger for the particular class.
      void info​(java.lang.String format, java.lang.Object... args)  
      void info​(java.lang.Throwable ex, java.lang.String format, java.lang.Object... args)  
      boolean isError()  
      boolean isInfo()  
      boolean isLoggable​(Log.Level level)
      Determine if its log-able at this level within this class.
      boolean isOk()  
      boolean isWarning()  
      void log​(java.lang.Class<?> clazz, java.lang.String method, Log.Level level, java.lang.String message, java.lang.Throwable ex)
      Lowest level logging method.
      void log​(Log.Level level, java.lang.Throwable ex, java.lang.String format, java.lang.Object... args)
      Logs based on the parameters given.
      void ok​(java.lang.String format, java.lang.Object... args)  
      void ok​(java.lang.Throwable ex, java.lang.String format, java.lang.Object... args)  
      void warn​(java.lang.String format, java.lang.Object... args)  
      void warn​(java.lang.Throwable ex, java.lang.String format, java.lang.Object... args)  

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • LOGSPI_PROP

        public static final java.lang.String LOGSPI_PROP
        System property to set the logger class that is most appropriate.

      • LOGSPI_PROPS_FILE

        public static final java.lang.String LOGSPI_PROPS_FILE
        Filename 'connectors.properties' used to for SPI class in the '$(java.home)/lib/' directory.
        See Also:
        Constant Field Values

    • Method Detail

      • getLog

        public static Log getLog​(java.lang.Class<?> clazz)
        Get the logger for the particular class. private static final Log LOG = Log.getLog(MyClass.class);
        Parameters:
        clazz - class to log information about.
        Returns:
        logger to use for logging.

      • getLog

        public static Log getLog​(java.lang.Class<?> clazz,
                         java.lang.String instanceName)
        Get the logger for the particular class. private static final Log LOG = Log.getLog(MyClass.class, instanceName);
        Parameters:
        clazz - class to log information about.
        instanceName - name of the instance to expose in the log.
        Returns:
        logger to use for logging.

      • isLoggable

        public boolean isLoggable​(Log.Level level)
        Determine if its log-able at this level within this class.

      • log

        public void log​(java.lang.Class<?> clazz,
                java.lang.String method,
                Log.Level level,
                java.lang.String message,
                java.lang.Throwable ex)
        Lowest level logging method.
        Parameters:
        clazz - Class that is being logged.
        method - Method name that is being logged.
        level - Logging level.
        message - Message about the log.
        ex - Exception to use process.

      • log

        public void log​(Log.Level level,
                java.lang.Throwable ex,
                java.lang.String format,
                java.lang.Object... args)
        Logs based on the parameters given. Uses the format parameter inside MessageFormat.
        Parameters:
        level - the logging level at which to write the message.
        ex - [optional] exception stack trace to log.
        format - [optional] create a message of a particular format.
        args - [optional] parameters to the format string.

      • ok

        public void ok​(java.lang.Throwable ex,
               java.lang.String format,
               java.lang.Object... args)

      • info

        public void info​(java.lang.Throwable ex,
                 java.lang.String format,
                 java.lang.Object... args)

      • warn

        public void warn​(java.lang.Throwable ex,
                 java.lang.String format,
                 java.lang.Object... args)

      • error

        public void error​(java.lang.Throwable ex,
                  java.lang.String format,
                  java.lang.Object... args)

      • ok

        public void ok​(java.lang.String format,
               java.lang.Object... args)

      • info

        public void info​(java.lang.String format,
                 java.lang.Object... args)

      • warn

        public void warn​(java.lang.String format,
                 java.lang.Object... args)

      • error

        public void error​(java.lang.String format,
                  java.lang.Object... args)

      • isOk

        public boolean isOk()

      • isInfo

        public boolean isInfo()

      • isWarning

        public boolean isWarning()

      • isError

        public boolean isError()