com.ibm.integration.admin.logger

Class Logger

  • java.lang.Object
    • com.ibm.integration.admin.logger.Logger


  • public abstract class Logger
    extends java.lang.Object
    Handles the logging functions for the IBM Integration API. Based on the Java 1.4 logging API.

    This logger is able to direct its output to a selected subclass of this one.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String NO_LOGGER
      The "empty" logger's class-name (that is, the logger that swallows all output)
    • Constructor Summary

      Constructors 
      Constructor and Description
      Logger() 
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void config(java.lang.String msg)
      Log a CONFIG message.
      static boolean configOn() 
      void entering(java.lang.String sourceClass, java.lang.String sourceMethod)
      Log a method entry.
      void entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object param1)
      Log a method entry, with one parameter.
      void entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object[] params)
      Log a method entry, with multiple parameters.
      static boolean enteringOn() 
      void exiting(java.lang.String sourceClass, java.lang.String sourceMethod)
      Log a method exit
      void exiting(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object result)
      Log a method exit and its return value.
      static boolean exitingOn() 
      void fine(java.lang.String msg)
      Log a FINE message.
      static boolean fineOn() 
      void finer(java.lang.String msg)
      Log a FINER message.
      static boolean finerOn() 
      void finest(java.lang.String msg)
      Log a FINEST message.
      static boolean finestOn() 
      static Logger getLogger(java.lang.String name)
      Find or create a logger with the supplied class name.
      void info(java.lang.String msg)
      Log an INFO message.
      static boolean infoOn() 
      boolean isLoggable(com.ibm.integration.admin.logger.Logger.Level level)
      Returns true if and only if messages of the supplied level are actually logged by this logger
      static void logConfig(java.lang.String msg)
      Log a CONFIG message using the active logger.
      static void logEntering(java.lang.String sourceClass, java.lang.String sourceMethod)
      Log a method entry using the active logger
      static void logEntering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object param1)
      Log a method entry, with one parameter, using the active logger.
      static void logEntering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object[] params)
      Log a method entry, with multiple parameters, using the active logger.
      static void logExiting(java.lang.String sourceClass, java.lang.String sourceMethod)
      Log a method exit using the active logger.
      static void logExiting(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object result)
      Log a method exit and its return value using the active logger.
      static void logFine(java.lang.String msg)
      Log a FINE message using the active logger.
      static void logFiner(java.lang.String msg)
      Log a FINER message using the active logger.
      static void logFinest(java.lang.String msg)
      Log a FINEST message using the active logger.
      static void logInfo(java.lang.String msg)
      Log a INFO message using the active logger.
      static void logSevere(java.lang.String msg)
      Log a SEVERE message using the active logger.
      static void logThrowing(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Throwable thrown)
      Log throwing an exception.
      static void logWarning(java.lang.String msg)
      Log a WARNING message using the active logger.
      void severe(java.lang.String msg)
      Log a SEVERE message.
      static boolean severeOn() 
      void throwing(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Throwable thrown)
      Log throwing an exception.
      static boolean throwingOn() 
      void warning(java.lang.String msg)
      Log a WARNING message.
      static boolean warningOn() 
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NO_LOGGER

        public static final java.lang.String NO_LOGGER
        The "empty" logger's class-name (that is, the logger that swallows all output)
        See Also:
        Constant Field Values
    • Constructor Detail

      • Logger

        public Logger()
    • Method Detail

      • getLogger

        public static Logger getLogger(java.lang.String name)
                                throws IntegrationAdminException
        Find or create a logger with the supplied class name.
        Parameters:
        name - Fully qualified classname for the logger.
        Returns:
        Logger a suitable Logger
        Throws:
        IntegrationAdminLoggedException - if the logger could not be instantiated.
        IntegrationAdminException
      • entering

        public void entering(java.lang.String sourceClass,
                             java.lang.String sourceMethod)
        Log a method entry.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
      • entering

        public void entering(java.lang.String sourceClass,
                             java.lang.String sourceMethod,
                             java.lang.Object param1)
        Log a method entry, with one parameter.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        param1 - parameter
      • entering

        public void entering(java.lang.String sourceClass,
                             java.lang.String sourceMethod,
                             java.lang.Object[] params)
        Log a method entry, with multiple parameters.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        params - parameters
      • exiting

        public void exiting(java.lang.String sourceClass,
                            java.lang.String sourceMethod)
        Log a method exit
        Parameters:
        sourceClass - class name
        sourceMethod - method name
      • exiting

        public void exiting(java.lang.String sourceClass,
                            java.lang.String sourceMethod,
                            java.lang.Object result)
        Log a method exit and its return value.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        result - Return value
      • throwing

        public void throwing(java.lang.String sourceClass,
                             java.lang.String sourceMethod,
                             java.lang.Throwable thrown)
        Log throwing an exception.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        thrown -
      • severe

        public void severe(java.lang.String msg)
        Log a SEVERE message.
        Parameters:
        msg - The string message
      • warning

        public void warning(java.lang.String msg)
        Log a WARNING message.
        Parameters:
        msg - The string message
      • info

        public void info(java.lang.String msg)
        Log an INFO message.
        Parameters:
        msg - The String message
      • config

        public void config(java.lang.String msg)
        Log a CONFIG message.
        Parameters:
        msg - The string message
      • fine

        public void fine(java.lang.String msg)
        Log a FINE message.
        Parameters:
        msg - The string message
      • finer

        public void finer(java.lang.String msg)
        Log a FINER message.
        Parameters:
        msg - The string message
      • finest

        public void finest(java.lang.String msg)
        Log a FINEST message.
        Parameters:
        msg - The string message
      • isLoggable

        public boolean isLoggable(com.ibm.integration.admin.logger.Logger.Level level)
        Returns true if and only if messages of the supplied level are actually logged by this logger
        Parameters:
        level -
        Returns:
        boolean true if and only if logging at this level is enabled
      • logEntering

        public static void logEntering(java.lang.String sourceClass,
                                       java.lang.String sourceMethod)
        Log a method entry using the active logger
        Parameters:
        sourceClass - class name
        sourceMethod - method name
      • logEntering

        public static void logEntering(java.lang.String sourceClass,
                                       java.lang.String sourceMethod,
                                       java.lang.Object param1)
        Log a method entry, with one parameter, using the active logger.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        param1 - parameter
      • logEntering

        public static void logEntering(java.lang.String sourceClass,
                                       java.lang.String sourceMethod,
                                       java.lang.Object[] params)
        Log a method entry, with multiple parameters, using the active logger.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        params - parameters
      • logExiting

        public static void logExiting(java.lang.String sourceClass,
                                      java.lang.String sourceMethod)
        Log a method exit using the active logger.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
      • logExiting

        public static void logExiting(java.lang.String sourceClass,
                                      java.lang.String sourceMethod,
                                      java.lang.Object result)
        Log a method exit and its return value using the active logger.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        result - Return value
      • logThrowing

        public static void logThrowing(java.lang.String sourceClass,
                                       java.lang.String sourceMethod,
                                       java.lang.Throwable thrown)
        Log throwing an exception.
        Parameters:
        sourceClass - class name
        sourceMethod - method name
        thrown -
      • logSevere

        public static void logSevere(java.lang.String msg)
        Log a SEVERE message using the active logger.
        Parameters:
        msg - The string message
      • logWarning

        public static void logWarning(java.lang.String msg)
        Log a WARNING message using the active logger.
        Parameters:
        msg - The string message
      • logInfo

        public static void logInfo(java.lang.String msg)
        Log a INFO message using the active logger.
        Parameters:
        msg - The string message
      • logConfig

        public static void logConfig(java.lang.String msg)
        Log a CONFIG message using the active logger.
        Parameters:
        msg - The string message
      • logFine

        public static void logFine(java.lang.String msg)
        Log a FINE message using the active logger.
        Parameters:
        msg - The string message
      • logFiner

        public static void logFiner(java.lang.String msg)
        Log a FINER message using the active logger.
        Parameters:
        msg - The string message
      • logFinest

        public static void logFinest(java.lang.String msg)
        Log a FINEST message using the active logger.
        Parameters:
        msg - The string message
      • severeOn

        public static boolean severeOn()
        Returns:
        true if and only if SEVERE logging is enabled.
      • warningOn

        public static boolean warningOn()
        Returns:
        true if and only if WARNING logging is enabled.
      • infoOn

        public static boolean infoOn()
        Returns:
        true if and only if INFO logging is enabled.
      • configOn

        public static boolean configOn()
        Returns:
        true if and only if CONFIG logging is enabled.
      • fineOn

        public static boolean fineOn()
        Returns:
        true if and only if FINE logging is enabled.
      • finerOn

        public static boolean finerOn()
        Returns:
        true if and only if FINER logging is enabled.
      • finestOn

        public static boolean finestOn()
        Returns:
        true if and only if FINEST logging is enabled.
      • throwingOn

        public static boolean throwingOn()
        Returns:
        true if and only if exception logging is enabled.
      • enteringOn

        public static boolean enteringOn()
        Returns:
        true if and only if method entry logging is enabled.
      • exitingOn

        public static boolean exitingOn()
        Returns:
        true if and only if method exit logging is enabled.