Package icc.logging

Class LoggingUtil


  • public class LoggingUtil
    extends java.lang.Object
    Util Class used to log custom method calls and custom scripts. For Scripts use SANDE_RuleLibrary_LoggingLibrary (which is calling this class) as a RuleLibrary for your XML Object Logmessage Format depending on the enabled loglevel:
    Info: Prefix (Entering, Exiting, Exception)
    Debug: Prefix and parameters/return value as String
    Trace: Prefix and parameters/return value as XML Objects (SailpoibtObject) or String
    Author:
    Felix Hill iC Consult
    • Constructor Summary

      Constructors 
      Constructor Description
      LoggingUtil()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void forceDebugLog​(org.apache.log4j.Logger logger, java.lang.String loggingString, java.lang.Object... variables)  
      static void forceTraceLog​(org.apache.log4j.Logger logger, java.lang.String loggingString, java.lang.Object... variables)  
      static java.lang.String getMethodParameterString​(org.apache.log4j.Logger logger, java.lang.Object[] variables)
      Returns a String representation of the method parameters.
      The format depends on the logger setting if trace is enabled.
      static java.lang.String getMethodResultString​(org.apache.log4j.Logger logger, java.lang.Object returnValue)
      Returns a String representation of the method return value.
      The format depends on the enabled logging level, see class javadoc.
      static java.lang.String getParameterValue​(java.lang.Object value, boolean traceEnabled, int depth)
      Returns a String representation of the input Object value.
      The format depends on the logger setting if trace is enabled.
      static void logMethodEntry​(org.apache.log4j.Logger logger, java.lang.Object... variables)
      Method to trace the start of custom java methods including parameters.
      See class javadoc for format and logger names.
      static void logMethodError​(org.apache.log4j.Logger logger, java.lang.String loggingString)
      Method to log the given loggingString as error
      static void logMethodExit​(org.apache.log4j.Logger logger, java.lang.Object returnValue, java.lang.Object... variables)
      Method to trace the end of custom java methods including parameters and return value.
      See class javadoc for format and logger names.
      static void logMethodProgress​(org.apache.log4j.Logger logger, java.lang.String loggingString, java.lang.Object... variables)
      Logs the progress within java methods including parameters.
      static void logMethodWarn​(org.apache.log4j.Logger logger, java.lang.String loggingString)
      Method to log the given loggingString as warn
      static void saveLogmessage​(org.apache.log4j.Logger logger, java.lang.String loggingString)
      Method to log a message with the given logger.
      The loglevel is chosen dynamically depending on which loglevel is enabled.
      • Methods inherited from class java.lang.Object

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

      • LoggingUtil

        public LoggingUtil()
    • Method Detail

      • logMethodEntry

        public static void logMethodEntry​(org.apache.log4j.Logger logger,
                                          java.lang.Object... variables)
        Method to trace the start of custom java methods including parameters.
        See class javadoc for format and logger names.
        Parameters:
        logger -
        variables -
      • logMethodExit

        public static void logMethodExit​(org.apache.log4j.Logger logger,
                                         java.lang.Object returnValue,
                                         java.lang.Object... variables)
        Method to trace the end of custom java methods including parameters and return value.
        See class javadoc for format and logger names.
        Parameters:
        logger -
        returnValue -
      • logMethodError

        public static void logMethodError​(org.apache.log4j.Logger logger,
                                          java.lang.String loggingString)
        Method to log the given loggingString as error
        Parameters:
        logger -
        loggingString -
      • logMethodWarn

        public static void logMethodWarn​(org.apache.log4j.Logger logger,
                                         java.lang.String loggingString)
        Method to log the given loggingString as warn
        Parameters:
        logger -
        loggingString -
      • getParameterValue

        public static java.lang.String getParameterValue​(java.lang.Object value,
                                                         boolean traceEnabled,
                                                         int depth)
        Returns a String representation of the input Object value.
        The format depends on the logger setting if trace is enabled.

        Collections and maps are iterated to a depth of up to 10.
        Their values are converted with this method as well.

        Parameters:
        value -
        traceEnabled -
        depth -
        Returns:
        value as String representation
      • getMethodParameterString

        public static java.lang.String getMethodParameterString​(org.apache.log4j.Logger logger,
                                                                java.lang.Object[] variables)
        Returns a String representation of the method parameters.
        The format depends on the logger setting if trace is enabled.
        Parameters:
        logger -
        variables -
        Returns:
        returns the method parameters as as String representation
      • saveLogmessage

        public static void saveLogmessage​(org.apache.log4j.Logger logger,
                                          java.lang.String loggingString)
        Method to log a message with the given logger.
        The loglevel is chosen dynamically depending on which loglevel is enabled.

        Loglevels are chosen as follows:
        Trace
        Debug
        Info

        Parameters:
        logger -
        loggingString -
      • getMethodResultString

        public static java.lang.String getMethodResultString​(org.apache.log4j.Logger logger,
                                                             java.lang.Object returnValue)
        Returns a String representation of the method return value.
        The format depends on the enabled logging level, see class javadoc.
        Parameters:
        logger -
        returnValue -
        Returns:
        the method result as String representation
      • logMethodProgress

        public static void logMethodProgress​(org.apache.log4j.Logger logger,
                                             java.lang.String loggingString,
                                             java.lang.Object... variables)
        Logs the progress within java methods including parameters.
        Parameters:
        logger -
        loggingString -
        variables -
      • forceDebugLog

        public static void forceDebugLog​(org.apache.log4j.Logger logger,
                                         java.lang.String loggingString,
                                         java.lang.Object... variables)
      • forceTraceLog

        public static void forceTraceLog​(org.apache.log4j.Logger logger,
                                         java.lang.String loggingString,
                                         java.lang.Object... variables)