Class AppLogEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class AppLogEvent
    extends java.lang.Object
    implements java.io.Serializable
    Event log definition
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      AppLogEvent​(java.lang.String id, java.lang.String code, char type, char level, char[] canal, java.util.Map<java.lang.String,​java.lang.String> labels, boolean enabled, int depth)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getCode()
      Get code
      int getDepth()
      Get depth
      java.lang.String getDisplay​(java.lang.String lang, java.lang.String[] params)
      Get display label
      java.lang.String getId()
      Get ID
      java.lang.String getLabel​(java.lang.String lang, java.lang.String[] params)
      Get display label (same as getDisplay)
      char getLevel()
      Get level
      char getType()
      Get type
      boolean isEnabled()
      Is enabled?
      boolean isLimitedbyCount()
      Is limited by count
      boolean isLimitedByDays()
      Is limited by days
      boolean isUnlimited()
      Is unlimited
      void setDepth​(int depth)
      Set depth
      void setDisplay​(java.lang.String lang, java.lang.String text)
      Set display label
      void setEnabled​(boolean enabled)
      Set enabled
      void setLabel​(java.lang.String lang, java.lang.String text)
      Set display lble (same as setDIsplay)
      void setLevel​(char level)
      Set level
      boolean toDB()
      To database?
      org.json.JSONObject toJSONObject()
      Generates a JSON object representation of the log event
      boolean toLog4j()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use toLogger
      boolean toLogger()
      To logger?
      java.lang.String toString()
      Generates a string representation of the log event
      • Methods inherited from class java.lang.Object

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

      • ERROR_LEVEL_FATAL

        public static final java.lang.String ERROR_LEVEL_FATAL
        Fatal error level string
        See Also:
        Constant Field Values
      • ERROR_LEVEL_ERROR

        public static final java.lang.String ERROR_LEVEL_ERROR
        Error level string
        See Also:
        Constant Field Values
      • ERROR_LEVEL_WARN

        public static final java.lang.String ERROR_LEVEL_WARN
        Warning level string
        See Also:
        Constant Field Values
      • ERROR_LEVEL_INFO

        public static final java.lang.String ERROR_LEVEL_INFO
        Information level string
        See Also:
        Constant Field Values
      • ERROR_LEVEL_DEBUG

        public static final java.lang.String ERROR_LEVEL_DEBUG
        Debug level string
        See Also:
        Constant Field Values
      • LEVEL_FATAL

        public static final char LEVEL_FATAL
        Fatal error level code
        See Also:
        Constant Field Values
      • TYPE_REPOSITORY

        public static final char TYPE_REPOSITORY
        Repository type
        See Also:
        Constant Field Values
      • TYPE_SQL_SYSTEM

        public static final char TYPE_SQL_SYSTEM
        System SQL type
        See Also:
        Constant Field Values
      • CANAL_LOG4J

        @Deprecated(forRemoval=true,
                    since="4.0")
        public static final char CANAL_LOG4J
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use CANAL_LOGGER
        See Also:
        Constant Field Values
      • DEPTH_UNLIMITED

        public static final int DEPTH_UNLIMITED
        Infinite depth
        See Also:
        Constant Field Values
    • Constructor Detail

      • AppLogEvent

        public AppLogEvent​(java.lang.String id,
                           java.lang.String code,
                           char type,
                           char level,
                           char[] canal,
                           java.util.Map<java.lang.String,​java.lang.String> labels,
                           boolean enabled,
                           int depth)
        Constructor
        Parameters:
        id - Event id
        code - Event code
        type - log type
        level - Level Fatal Error Warn Info Debug
        canal - Output table: Stdout, File, DB
        labels - Message to display with [n] to be replaced with contextual data
        enabled - Enabled ?
        depth - Logs depth AppLogEvent.DEPTH_*
    • Method Detail

      • toLogger

        public boolean toLogger()
        To logger?
        Returns:
        True if logging to logger
      • toDB

        public boolean toDB()
        To database?
        Returns:
        True if logging to database
      • toLog4j

        @Deprecated(forRemoval=true,
                    since="4.0")
        public final boolean toLog4j()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use toLogger
      • getId

        public java.lang.String getId()
        Get ID
        Returns:
        ID
      • getCode

        public java.lang.String getCode()
        Get code
        Returns:
        Code
      • getType

        public char getType()
        Get type
        Returns:
        Type
      • getLevel

        public char getLevel()
        Get level
        Returns:
        Level
      • setLevel

        public void setLevel​(char level)
        Set level
        Parameters:
        level - Level
      • isEnabled

        public boolean isEnabled()
        Is enabled?
        Returns:
        True if enabled
      • setEnabled

        public void setEnabled​(boolean enabled)
        Set enabled
        Parameters:
        enabled - True if enabled
      • getDepth

        public int getDepth()
        Get depth
        Returns:
        Depth
      • setDepth

        public void setDepth​(int depth)
        Set depth
        Parameters:
        depth - Depth
      • isLimitedByDays

        public boolean isLimitedByDays()
        Is limited by days
        Returns:
        True if limited by days
      • isLimitedbyCount

        public boolean isLimitedbyCount()
        Is limited by count
        Returns:
        True if limited by count
      • isUnlimited

        public boolean isUnlimited()
        Is unlimited
        Returns:
        True if unlimited
      • getDisplay

        public java.lang.String getDisplay​(java.lang.String lang,
                                           java.lang.String[] params)
        Get display label
        Parameters:
        lang - Language
        params - Parameters
        Returns:
        Display label
      • getLabel

        public java.lang.String getLabel​(java.lang.String lang,
                                         java.lang.String[] params)
        Get display label (same as getDisplay)
        Parameters:
        lang - Language
        params - Parameters
        Returns:
        Display label
      • setDisplay

        public void setDisplay​(java.lang.String lang,
                               java.lang.String text)
        Set display label
        Parameters:
        lang - Language
        text - Text
      • setLabel

        public void setLabel​(java.lang.String lang,
                             java.lang.String text)
        Set display lble (same as setDIsplay)
        Parameters:
        lang - Language
        text - Text
      • toJSONObject

        public org.json.JSONObject toJSONObject()
        Generates a JSON object representation of the log event
        Returns:
        Log event object as JSON object
      • toString

        public java.lang.String toString()
        Generates a string representation of the log event
        Overrides:
        toString in class java.lang.Object
        Returns:
        Log event object as string