Package com.simplicite.util

Class AppLog

  • public final class AppLog
extends java.lang.Object
    Logger in console, file and/or m_log table.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String APP
      Application code
      static org.apache.logging.log4j.MarkerManager.Log4jMarker APP_MARKER
      Log4j marker
      static java.lang.String CODE_DEBUG
      Debug code
      static java.lang.String CODE_ERROR
      Error code
      static java.lang.String CODE_FATAL
      Fatal error code
      static java.lang.String CODE_INFO
      Information code
      static java.lang.String CODE_WARN
      Warning code
      static java.lang.String CONSOLE_APPENDER_NAME
      Default console appender name
      static boolean EXPLAIN_PLAN
      Explain plan?
      static java.lang.String FILE_APPENDER_NAME
      Default file appender name
      static java.lang.String REDO_LOGGER_NAME
      Default redo logger name
      static java.lang.String SESSION_LOGGER_NAME
      Default session logger name

    • Constructor Summary

      Constructors 
      Constructor Description
      AppLog()  

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static void clearAllLogs​(java.lang.String platform)
      Clean all logs
      static void clearLogs​(java.lang.String code, java.lang.String platform)
      Clean logs
      static java.lang.String debug​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str)
      Debug log (generic event DEBUG)
      static java.lang.String debug​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str, Grant g)
      Debug log (generic event DEBUG)
      static java.lang.String debug​(java.lang.String str)
      Debug log (generic event DEBUG)
      static java.lang.String debug​(java.lang.String str, Grant g)
      Debug log (generic event DEBUG)
      static java.lang.String deprecation​(java.lang.Class<?> cls, java.lang.String oldmethod, java.lang.String newmethod, boolean outdated)
      Deprecation warning
      static java.lang.String deprecation​(java.lang.String newmethod, boolean outdated)
      Deprecation warning
      static java.lang.String deprecation​(java.lang.String className, java.lang.String oldmethod, java.lang.String newmethod, boolean outdated)
      Deprecation warning
      static java.lang.String error​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str, java.lang.Throwable e, Grant g)
      Error log (generic event ERROR)
      static java.lang.String error​(java.lang.String str, java.lang.Throwable e, Grant g)
      Error log (generic event ERROR)
      static java.lang.String error​(java.lang.Throwable e, Grant g)
      Error log (generic event ERROR)
      static java.lang.String fatal​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str, java.lang.Throwable e, Grant g)
      Fatal log (generic event FATAL)
      static java.lang.String fatal​(java.lang.String str, java.lang.Throwable e, Grant g)
      Fatal log (generic event FATAL)
      static java.lang.String fatal​(java.lang.Throwable e, Grant g)
      Fatal log (generic event FATAL)
      static java.lang.String format​(char level, long lineNumber, java.lang.String log)
      Log line formatter with datetime, level and message
      Sample: 2010-03-12 10:25:06,703 ERROR [/<contextroot>] line 234: log message
      static java.lang.String format​(java.lang.String eventCode, java.lang.String className, java.lang.String method, java.lang.String rowId, java.lang.String desc, Grant g)
      Format as string
      static java.lang.String formatAsJSON​(java.lang.String level, java.lang.String eventCode, java.lang.String className, java.lang.String method, java.lang.String rowId, java.lang.String desc, Grant g, boolean limitSize)
      Format as JSON
      static java.text.SimpleDateFormat getDatetimeFormat()
      Date time format for logs
      static java.lang.String getLogFileName()
      Get default log file name
      static java.lang.String getLogFileName​(java.lang.String appenderName)
      Get log file name
      static org.apache.logging.log4j.Logger getLogger​(java.lang.String name)
      Get logger
      static void globalDebug​(java.lang.String message)
      Log debug message to global logger if possible
      static void globalError​(java.lang.String message)
      Log error to global logger if possible
      static void globalError​(java.lang.String message, java.lang.Throwable throwable)
      Log error to global logger if possible
      static void globalError​(java.lang.Throwable throwable)
      Log error to global logger if possible
      static void globalInfo​(java.lang.String message)
      Log info message to global logger if possible (alias to globalLog)
      static void globalLog​(java.lang.String message)
      Log to global logger if possible
      static void globalLog​(java.lang.String message, java.lang.Throwable throwable)
      Log to global logger if possible
      static void globalWarning​(java.lang.String message)
      Log warning to global logger if possible
      static void globalWarning​(java.lang.String message, java.lang.Throwable throwable)
      Log warning to global logger if possible
      static void globalWarning​(java.lang.Throwable throwable)
      Log warning to global logger if possible
      static java.lang.String info​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str, Grant g)
      Info log (generic event INFO)
      static java.lang.String info​(java.lang.String str, Grant g)
      Info log (generic event INFO)
      static boolean isDebug()
      Is in global debug mode?
      static boolean isEventCodeEnabled​(Grant g, java.lang.String code)
      Check whether a log event code is enabled for specified grant
      static boolean isEventCodeEnabled​(java.lang.String code)
      Check whether a log event code is enabled for system admin grant
      static java.lang.String[] listPlatforms()
      List platforms with logs
      static java.lang.String[] listPlatforms​(java.lang.String beginDate, java.lang.String endDate)
      List platforms with log
      static void log​(Grant g, java.io.PrintWriter out, java.lang.String code, long lineNumber, java.lang.String message)
      Log message for specified event code to print writer
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String param)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String[] param)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String[] param, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String[] param, java.lang.Throwable e)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String[] param, java.lang.Throwable e, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String param, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String rowId, java.lang.String[] param, java.lang.Throwable e, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String param, java.lang.Throwable e)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.Class<?> cls, java.lang.String method, java.lang.String param, java.lang.Throwable e, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.String param, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.String className, java.lang.String method, java.lang.String rowId, java.lang.String[] param, java.lang.Throwable e, Grant g)
      Log a code event
      static java.lang.String log​(java.lang.String code, java.lang.String param, java.lang.Throwable e, Grant g)
      Log a code event
      static void logDocumentDelete​(Grant g, java.lang.String path)
      Log a document deletion
      static void logDocumentDownload​(Grant g, java.lang.String path, long size)
      Log a document download
      static void logDocumentUpload​(Grant g, java.lang.String path, long size)
      Log a document upload
      static java.lang.String logJDBC​(java.lang.String datasource)
      Log JDBC pool size
      static java.lang.String logMemory()
      Log JVM memory
      static java.lang.String logMemoryCache()
      Log Cache memory
      static java.lang.String logMemoryDisk()
      Log Local disk sizes
      static java.lang.String logMemoryDoc()
      Log DBDoc sizes
      static java.lang.String logMemorySession()
      Log sessions volumes
      static void logObject​(Grant g, ObjectDB object, java.lang.String method, java.lang.String rowId, java.lang.String sql, java.util.List<ObjectField> host, java.lang.String msg)
      Log an object manipulation (SQL + host values)
      static void logSessionIn​(Grant g, java.lang.String type)
      Deprecated. 
      static void logSessionOut​(Grant g, long dt)
      Deprecated. 
      static java.lang.String logSQL()
      Log SQL count and total duration
      static void logSQL​(java.lang.String login, java.lang.String datasource, java.lang.String sql, java.util.List<ObjectField> host)
      Log a SQL request
      static java.lang.String logSystem()
      Log Class count, Threads CPU, Snapshot and pages
      static java.lang.String notimplemented()
      Not implemented in this version warning
      static java.lang.String notimplemented​(java.lang.Class<?> cls, java.lang.String method)
      Not implemented in this version warning
      static java.lang.String notimplemented​(java.lang.String className, java.lang.String method)
      Not implemented in this version warning
      static java.lang.String readLogContent()
      Read log file content
      static java.lang.String readLogContent​(java.lang.String appenderName)
      Read log file content
      static void setDebug​(boolean debug)
      Enable/disable global debug mode
      static void simpleDebug​(java.lang.String message)
      Simple debug to root logger if possible
      static void simpleError​(java.lang.String message)
      Simple error to root logger if possible
      static void simpleError​(java.lang.String message, java.lang.Throwable throwable)
      Simple error to root logger possible
      static void simpleError​(java.lang.Throwable throwable)
      Simple error to root logger possible
      static void simpleFatal​(java.lang.String message)
      Simple error to root logger if possible
      static void simpleFatal​(java.lang.String message, java.lang.Throwable throwable)
      Simple fatal error to root logger possible
      static void simpleFatal​(java.lang.Throwable throwable)
      Simple fatal error to root logger possible
      static void simpleInfo​(java.lang.String message)
      Simple info to root logger if possible
      static void simpleLog​(java.lang.String message, java.lang.Throwable throwable)
      Simple log to root logger if possible
      static void simpleTrace​(java.lang.String message)
      Simple trace to root logger if possible
      static void simpleWarning​(java.lang.String message)
      Simple warning to root logger if possible
      static void simpleWarning​(java.lang.String message, java.lang.Throwable throwable)
      Simple warning to root logger if possible
      static void simpleWarning​(java.lang.Throwable throwable)
      Simple warning to root logger if possible
      static java.lang.String warning​(java.lang.Class<?> cls, java.lang.String method, java.lang.String str, java.lang.Throwable e, Grant g)
      Warning log (generic event WARN)
      static java.lang.String warning​(java.lang.String str, java.lang.Throwable e, Grant g)
      Warning log (generic event WARN)
      static java.lang.String warning​(java.lang.Throwable e, Grant g)
      Warning log (generic event WARN)

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • APP_MARKER

        public static final org.apache.logging.log4j.MarkerManager.Log4jMarker APP_MARKER
        Log4j marker

      • CONSOLE_APPENDER_NAME

        public static final java.lang.String CONSOLE_APPENDER_NAME
        Default console appender name
        See Also:
        Constant Field Values

      • FILE_APPENDER_NAME

        public static final java.lang.String FILE_APPENDER_NAME
        Default file appender name
        See Also:
        Constant Field Values

      • REDO_LOGGER_NAME

        public static final java.lang.String REDO_LOGGER_NAME
        Default redo logger name
        See Also:
        Constant Field Values

      • SESSION_LOGGER_NAME

        public static final java.lang.String SESSION_LOGGER_NAME
        Default session logger name
        See Also:
        Constant Field Values

      • CODE_INFO

        public static final java.lang.String CODE_INFO
        Information code
        See Also:
        Constant Field Values

      • CODE_FATAL

        public static final java.lang.String CODE_FATAL
        Fatal error code
        See Also:
        Constant Field Values

    • Constructor Detail

      • AppLog

        public AppLog()

    • Method Detail

      • getLogger

        public static org.apache.logging.log4j.Logger getLogger​(java.lang.String name)
        Get logger
        Parameters:
        name - Logger name (null means root logger)
        Returns:
        Logger

      • getLogFileName

        public static java.lang.String getLogFileName()
        Get default log file name
        Returns:
        Default log file name

      • getLogFileName

        public static java.lang.String getLogFileName​(java.lang.String appenderName)
        Get log file name
        Parameters:
        appenderName - Appender name (null means using AppLog.FILE_APPENDER_NAME)
        Returns:
        Log file name

      • readLogContent

        public static java.lang.String readLogContent()
        Read log file content
        Returns:
        Log file content

      • readLogContent

        public static java.lang.String readLogContent​(java.lang.String appenderName)
        Read log file content
        Parameters:
        appenderName - Appender name (null means using AppLog.FILE_APPENDER_NAME)
        Returns:
        Log file content

      • globalLog

        public static void globalLog​(java.lang.String message)
        Log to global logger if possible
        Parameters:
        message - Message to log

      • globalLog

        public static void globalLog​(java.lang.String message,
                             java.lang.Throwable throwable)
        Log to global logger if possible
        Parameters:
        message - Message
        throwable - Throwable

      • globalDebug

        public static void globalDebug​(java.lang.String message)
        Log debug message to global logger if possible
        Parameters:
        message - Debug message to log

      • globalInfo

        public static void globalInfo​(java.lang.String message)
        Log info message to global logger if possible (alias to globalLog)
        Parameters:
        message - Info message to log

      • globalError

        public static void globalError​(java.lang.String message)
        Log error to global logger if possible
        Parameters:
        message - Error message to log

      • globalError

        public static void globalError​(java.lang.Throwable throwable)
        Log error to global logger if possible
        Parameters:
        throwable - Throwable

      • globalError

        public static void globalError​(java.lang.String message,
                               java.lang.Throwable throwable)
        Log error to global logger if possible
        Parameters:
        message - Error message to log
        throwable - Throwable

      • globalWarning

        public static void globalWarning​(java.lang.String message)
        Log warning to global logger if possible
        Parameters:
        message - Error message to log

      • globalWarning

        public static void globalWarning​(java.lang.Throwable throwable)
        Log warning to global logger if possible
        Parameters:
        throwable - Throwable

      • globalWarning

        public static void globalWarning​(java.lang.String message,
                                 java.lang.Throwable throwable)
        Log warning to global logger if possible
        Parameters:
        message - Error message to log
        throwable - Throwable

      • simpleTrace

        public static void simpleTrace​(java.lang.String message)
        Simple trace to root logger if possible
        Parameters:
        message - Debug message to log

      • simpleDebug

        public static void simpleDebug​(java.lang.String message)
        Simple debug to root logger if possible
        Parameters:
        message - Debug message to log

      • simpleInfo

        public static void simpleInfo​(java.lang.String message)
        Simple info to root logger if possible
        Parameters:
        message - Message to log

      • simpleWarning

        public static void simpleWarning​(java.lang.String message)
        Simple warning to root logger if possible
        Parameters:
        message - Error message to log

      • simpleWarning

        public static void simpleWarning​(java.lang.Throwable throwable)
        Simple warning to root logger if possible
        Parameters:
        throwable - Throwable

      • simpleWarning

        public static void simpleWarning​(java.lang.String message,
                                 java.lang.Throwable throwable)
        Simple warning to root logger if possible
        Parameters:
        message - Error message to log
        throwable - Throwable

      • simpleError

        public static void simpleError​(java.lang.String message)
        Simple error to root logger if possible
        Parameters:
        message - Error message to log

      • simpleError

        public static void simpleError​(java.lang.Throwable throwable)
        Simple error to root logger possible
        Parameters:
        throwable - Throwable

      • simpleError

        public static void simpleError​(java.lang.String message,
                               java.lang.Throwable throwable)
        Simple error to root logger possible
        Parameters:
        message - Error message to log
        throwable - Throwable

      • simpleFatal

        public static void simpleFatal​(java.lang.String message)
        Simple error to root logger if possible
        Parameters:
        message - Error message to log

      • simpleFatal

        public static void simpleFatal​(java.lang.Throwable throwable)
        Simple fatal error to root logger possible
        Parameters:
        throwable - Throwable

      • simpleFatal

        public static void simpleFatal​(java.lang.String message,
                               java.lang.Throwable throwable)
        Simple fatal error to root logger possible
        Parameters:
        message - Error message to log
        throwable - Throwable

      • simpleLog

        public static void simpleLog​(java.lang.String message,
                             java.lang.Throwable throwable)
        Simple log to root logger if possible
        Parameters:
        message - Message
        throwable - Throwable

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String rowId,
                                   java.lang.String[] param,
                                   java.lang.Throwable e,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        rowId - Optional row ID
        param - Optional parameters to replace in text [n]
        e - Optional throwable
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String[] param,
                                   java.lang.Throwable e,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameters to replace in text [n]
        e - Optional throwable
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.String className,
                                   java.lang.String method,
                                   java.lang.String rowId,
                                   java.lang.String[] param,
                                   java.lang.Throwable e,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        className - Class name
        method - Method name
        rowId - Optional row ID
        param - Optional parameters to replace in text [n]
        e - Optional throwable
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String[] param,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameters to replace in text [n]
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String[] param,
                                   java.lang.Throwable e)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameters to replace in text [n]
        e - Optional throwable
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String[] param)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameters to replace in text [n]
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String param)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameter to replace in text [1]
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String param,
                                   java.lang.Throwable e)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameter to replace in text [1]
        e - Optional throwable
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String param,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameter to replace in text [1]
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.String param,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        param - Optional parameter to replace in text [1]
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.Class<?> cls,
                                   java.lang.String method,
                                   java.lang.String param,
                                   java.lang.Throwable e,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        cls - Class
        method - Method name
        param - Optional parameter to replace in text [1]
        e - Optional throwable
        g - Grant
        Returns:
        Log ID

      • log

        public static java.lang.String log​(java.lang.String code,
                                   java.lang.String param,
                                   java.lang.Throwable e,
                                   Grant g)
        Log a code event
        Parameters:
        code - Event code
        param - Optional parameter to replace in text [1]
        e - Optional throwable
        g - Grant
        Returns:
        Log ID

      • debug

        public static java.lang.String debug​(java.lang.String str)
        Debug log (generic event DEBUG)
        Parameters:
        str - Message
        Returns:
        Log ID

      • debug

        public static java.lang.String debug​(java.lang.String str,
                                     Grant g)
        Debug log (generic event DEBUG)
        Parameters:
        str - Message
        g - Grant
        Returns:
        Log ID

      • debug

        public static java.lang.String debug​(java.lang.Class<?> cls,
                                     java.lang.String method,
                                     java.lang.String str)
        Debug log (generic event DEBUG)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        Returns:
        Log ID

      • debug

        public static java.lang.String debug​(java.lang.Class<?> cls,
                                     java.lang.String method,
                                     java.lang.String str,
                                     Grant g)
        Debug log (generic event DEBUG)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        g - Grant
        Returns:
        Log ID

      • info

        public static java.lang.String info​(java.lang.String str,
                                    Grant g)
        Info log (generic event INFO)
        Parameters:
        str - Message
        g - Grant
        Returns:
        Log ID

      • info

        public static java.lang.String info​(java.lang.Class<?> cls,
                                    java.lang.String method,
                                    java.lang.String str,
                                    Grant g)
        Info log (generic event INFO)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        g - Grant
        Returns:
        Log ID

      • warning

        public static java.lang.String warning​(java.lang.String str,
                                       java.lang.Throwable e,
                                       Grant g)
        Warning log (generic event WARN)
        Parameters:
        str - Message
        e - Exception
        g - Grant
        Returns:
        Log ID

      • warning

        public static java.lang.String warning​(java.lang.Throwable e,
                                       Grant g)
        Warning log (generic event WARN)
        Parameters:
        e - Exception
        g - Grant
        Returns:
        Log ID

      • warning

        public static java.lang.String warning​(java.lang.Class<?> cls,
                                       java.lang.String method,
                                       java.lang.String str,
                                       java.lang.Throwable e,
                                       Grant g)
        Warning log (generic event WARN)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        e - Exception
        g - Grant
        Returns:
        Log ID

      • error

        public static java.lang.String error​(java.lang.String str,
                                     java.lang.Throwable e,
                                     Grant g)
        Error log (generic event ERROR)
        Parameters:
        str - Message
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • error

        public static java.lang.String error​(java.lang.Throwable e,
                                     Grant g)
        Error log (generic event ERROR)
        Parameters:
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • error

        public static java.lang.String error​(java.lang.Class<?> cls,
                                     java.lang.String method,
                                     java.lang.String str,
                                     java.lang.Throwable e,
                                     Grant g)
        Error log (generic event ERROR)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • fatal

        public static java.lang.String fatal​(java.lang.String str,
                                     java.lang.Throwable e,
                                     Grant g)
        Fatal log (generic event FATAL)
        Parameters:
        str - Message
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • fatal

        public static java.lang.String fatal​(java.lang.Throwable e,
                                     Grant g)
        Fatal log (generic event FATAL)
        Parameters:
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • fatal

        public static java.lang.String fatal​(java.lang.Class<?> cls,
                                     java.lang.String method,
                                     java.lang.String str,
                                     java.lang.Throwable e,
                                     Grant g)
        Fatal log (generic event FATAL)
        Parameters:
        cls - Class
        method - Method name
        str - Message
        e - Throwable
        g - Grant
        Returns:
        Log ID

      • deprecation

        public static java.lang.String deprecation​(java.lang.String newmethod,
                                           boolean outdated)
        Deprecation warning
        Parameters:
        newmethod - New method
        outdated - Outdated method (does not do anything anymore) ? Generates an error instead of a warning
        Returns:
        Deprecation warning

      • deprecation

        public static java.lang.String deprecation​(java.lang.Class<?> cls,
                                           java.lang.String oldmethod,
                                           java.lang.String newmethod,
                                           boolean outdated)
        Deprecation warning
        Parameters:
        cls - Class
        oldmethod - Old deprecated method
        newmethod - New method
        outdated - Outdated method (does not do anything anymore) ? Generates an error instead of a warning
        Returns:
        Deprecation warning

      • deprecation

        public static java.lang.String deprecation​(java.lang.String className,
                                           java.lang.String oldmethod,
                                           java.lang.String newmethod,
                                           boolean outdated)
        Deprecation warning
        Parameters:
        className - Class name
        oldmethod - Old deprecated method
        newmethod - New method
        outdated - Outdated method (does not do anything anymore) ? Generates an error instead of a warning
        Returns:
        Deprecation warning

      • notimplemented

        public static java.lang.String notimplemented()
        Not implemented in this version warning
        Returns:
        Not implemented warning

      • notimplemented

        public static java.lang.String notimplemented​(java.lang.Class<?> cls,
                                              java.lang.String method)
        Not implemented in this version warning
        Parameters:
        cls - Class
        method - Method
        Returns:
        Not implemented warning

      • notimplemented

        public static java.lang.String notimplemented​(java.lang.String className,
                                              java.lang.String method)
        Not implemented in this version warning
        Parameters:
        className - Class name
        method - Method
        Returns:
        Not implemented warning

      • isDebug

        public static boolean isDebug()
        Is in global debug mode?
        Returns:
        True if debug mode is enabled

      • setDebug

        public static void setDebug​(boolean debug)
        Enable/disable global debug mode
        Parameters:
        debug - Debug mode enabled?

      • logSessionIn

        @Deprecated(forRemoval=false,
            since="4.0")
public static void logSessionIn​(Grant g,
                                java.lang.String type)
        Deprecated.

      • logSessionOut

        @Deprecated(forRemoval=false,
            since="4.0")
public static void logSessionOut​(Grant g,
                                 long dt)
        Deprecated.

      • logDocumentUpload

        public static void logDocumentUpload​(Grant g,
                                     java.lang.String path,
                                     long size)
        Log a document upload
        Parameters:
        g - Grant
        path - File path
        size - File size

      • logDocumentDownload

        public static void logDocumentDownload​(Grant g,
                                       java.lang.String path,
                                       long size)
        Log a document download
        Parameters:
        g - Grant
        path - File path
        size - File size

      • logDocumentDelete

        public static void logDocumentDelete​(Grant g,
                                     java.lang.String path)
        Log a document deletion
        Parameters:
        g - Grant
        path - File path

      • logObject

        public static void logObject​(Grant g,
                             ObjectDB object,
                             java.lang.String method,
                             java.lang.String rowId,
                             java.lang.String sql,
                             java.util.List<ObjectField> host,
                             java.lang.String msg)
        Log an object manipulation (SQL + host values)
        Parameters:
        g - Grant
        object - Object
        method - Method name
        rowId - Record row_id
        sql - SQL statement
        host - Host values
        msg - Message

      • logSQL

        public static void logSQL​(java.lang.String login,
                          java.lang.String datasource,
                          java.lang.String sql,
                          java.util.List<ObjectField> host)
        Log a SQL request
        Parameters:
        login - User (business request) or null (core system request)
        datasource - DataSource name
        sql - SQL statement
        host - Host values

      • format

        public static java.lang.String format​(java.lang.String eventCode,
                                      java.lang.String className,
                                      java.lang.String method,
                                      java.lang.String rowId,
                                      java.lang.String desc,
                                      Grant g)
        Format as string
        Parameters:
        eventCode - Event code
        className - Class name
        method - Method
        rowId - Row ID
        desc - Description
        g - Grant
        Returns:
        Formatted string

      • formatAsJSON

        public static java.lang.String formatAsJSON​(java.lang.String level,
                                            java.lang.String eventCode,
                                            java.lang.String className,
                                            java.lang.String method,
                                            java.lang.String rowId,
                                            java.lang.String desc,
                                            Grant g,
                                            boolean limitSize)
        Format as JSON
        Parameters:
        level - Level
        eventCode - Event code
        className - Class name
        method - Method
        rowId - Row ID
        desc - Description
        g - Grant
        limitSize - Size limit
        Returns:
        Formatted JSON string

      • isEventCodeEnabled

        public static boolean isEventCodeEnabled​(Grant g,
                                         java.lang.String code)
        Check whether a log event code is enabled for specified grant
        Parameters:
        g - Grant (use system admin grant if null)
        code - Event code

      • isEventCodeEnabled

        public static boolean isEventCodeEnabled​(java.lang.String code)
        Check whether a log event code is enabled for system admin grant
        Parameters:
        code - Event code

      • log

        public static void log​(Grant g,
                       java.io.PrintWriter out,
                       java.lang.String code,
                       long lineNumber,
                       java.lang.String message)
        Log message for specified event code to print writer
        Parameters:
        g -
        out - Print writer
        code - Event code
        lineNumber - Line number
        message - Log message

      • getDatetimeFormat

        public static java.text.SimpleDateFormat getDatetimeFormat()
        Date time format for logs
        Returns:
        Date time format for logs

      • format

        public static java.lang.String format​(char level,
                                      long lineNumber,
                                      java.lang.String log)
        Log line formatter with datetime, level and message
        Sample: 2010-03-12 10:25:06,703 ERROR [/<contextroot>] line 234: log message
        Parameters:
        level - Trace level from AppLogEvent
        lineNumber - Optional line number (for adapters)
        log - Message
        Returns:
        Formatted log

      • logMemory

        public static java.lang.String logMemory()
        Log JVM memory
        Returns:
        Log JVM memory

      • logMemoryCache

        public static java.lang.String logMemoryCache()
        Log Cache memory
        Returns:
        Log Cache memory

      • logMemoryDisk

        public static java.lang.String logMemoryDisk()
        Log Local disk sizes
        Returns:
        Log Local disk sizes

      • logMemoryDoc

        public static java.lang.String logMemoryDoc()
        Log DBDoc sizes
        Returns:
        Log DBDoc sizes

      • logMemorySession

        public static java.lang.String logMemorySession()
        Log sessions volumes
        Returns:
        Log sessions volumes

      • logSystem

        public static java.lang.String logSystem()
        Log Class count, Threads CPU, Snapshot and pages
        Returns:
        Log System

      • logSQL

        public static java.lang.String logSQL()
        Log SQL count and total duration
        Returns:
        Log SQL

      • logJDBC

        public static java.lang.String logJDBC​(java.lang.String datasource)
        Log JDBC pool size
        Parameters:
        datasource -
        Returns:
        Log JDBC

      • clearLogs

        public static void clearLogs​(java.lang.String code,
                             java.lang.String platform)
        Clean logs
        Parameters:
        code - Event code
        platform - optional platform

      • clearAllLogs

        public static void clearAllLogs​(java.lang.String platform)
        Clean all logs
        Parameters:
        platform - optional platform

      • listPlatforms

        public static java.lang.String[] listPlatforms()
        List platforms with logs
        Returns:
        list platforms

      • listPlatforms

        public static java.lang.String[] listPlatforms​(java.lang.String beginDate,
                                               java.lang.String endDate)
        List platforms with log
        Parameters:
        beginDate - begin Date
        endDate - end Date
        Returns:
        list platforms