Class LoggingEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class LoggingEvent
    extends java.lang.Object
    implements java.io.Serializable
    The internal representation of logging events. When an affirmative decision is made to log then a LoggingEvent instance is created. This instance is passed around to the different log4j components.

    This class is of concern to those wishing to extend log4j.

    Since:
    0.8.2
    Author:
    Ceki Gülcü, James P. Cakalic
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String categoryName
      Deprecated.
      This field will be marked as private in future releases.
      java.lang.String fqnOfCategoryClass
      Fully qualified name of the calling category class.
      Priority level
      Deprecated.
      This field will be marked as private in future releases.
      long timeStamp
      The number of milliseconds elapsed from 1/1/1970 until logging event was created.
    • Constructor Summary

      Constructors 
      Constructor Description
      LoggingEvent​(java.lang.String fqnOfCategoryClass, Category logger, long timeStamp, Level level, java.lang.Object message, java.lang.String threadName, ThrowableInformation throwable, java.lang.String ndc, LocationInfo info, java.util.Map properties)
      Create new instance.
      LoggingEvent​(java.lang.String fqnOfCategoryClass, Category logger, long timeStamp, Priority level, java.lang.Object message, java.lang.Throwable throwable)
      Instantiate a LoggingEvent from the supplied parameters.
      LoggingEvent​(java.lang.String fqnOfCategoryClass, Category logger, Priority level, java.lang.Object message, java.lang.Throwable throwable)
      Instantiate a LoggingEvent from the supplied parameters.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFQNOfLoggerClass()
      Get the fully qualified name of the calling logger sub-class/wrapper.
      Level getLevel()
      Return the level of this event.
      LocationInfo getLocationInformation()
      Set the location information for this logging event.
      Category getLogger()
      Gets the logger of the event.
      java.lang.String getLoggerName()
      Return the name of the logger.
      java.lang.Object getMDC​(java.lang.String key)
      Returns the the context corresponding to the key parameter.
      void getMDCCopy()
      Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.
      java.lang.Object getMessage()
      Return the message for this logging event.
      java.lang.String getNDC()
      This method returns the NDC for this event.
      java.util.Map getProperties()
      Returns the set of properties for the event.
      java.lang.String getProperty​(java.lang.String key)
      Return a property for this event.
      java.util.Set getPropertyKeySet()
      Returns the set of the key values in the properties for the event.
      java.lang.String getRenderedMessage()  
      static long getStartTime()
      Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
      java.lang.String getThreadName()  
      ThrowableInformation getThrowableInformation()
      Returns the throwable information contained within this event.
      java.lang.String[] getThrowableStrRep()
      Return this event's throwable's string[] representaion.
      long getTimeStamp()
      Getter for the event's time stamp.
      boolean locationInformationExists()
      Check for the existence of location information without creating it (a byproduct of calling getLocationInformation).
      java.lang.Object removeProperty​(java.lang.String propName)
      This removes the specified MDC property from the event.
      void setProperty​(java.lang.String propName, java.lang.String propValue)
      Set value for MDC property.
      • Methods inherited from class java.lang.Object

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

      • fqnOfCategoryClass

        public final transient java.lang.String fqnOfCategoryClass
        Fully qualified name of the calling category class.
      • categoryName

        public final java.lang.String categoryName
        Deprecated.
        This field will be marked as private in future releases. Please do not access it directly. Use the getLoggerName() method instead.

        The category (logger) name.

      • level

        public transient Priority level
        Deprecated.
        This field will be marked as private in future releases. Please do not access it directly. Use the getLevel() method instead.
        Level of logging event. Level cannot be serializable because it is a flyweight. Due to its special seralization it cannot be declared final either.

        This field should not be accessed directly. You shoud use the getLevel() method instead.

      • timeStamp

        public final long timeStamp
        The number of milliseconds elapsed from 1/1/1970 until logging event was created.
    • Constructor Detail

      • LoggingEvent

        public LoggingEvent​(java.lang.String fqnOfCategoryClass,
                            Category logger,
                            Priority level,
                            java.lang.Object message,
                            java.lang.Throwable throwable)
        Instantiate a LoggingEvent from the supplied parameters.

        Except timeStamp all the other fields of LoggingEvent are filled when actually needed.

        Parameters:
        logger - The logger generating this event.
        level - The level of this event.
        message - The message of this event.
        throwable - The throwable of this event.
      • LoggingEvent

        public LoggingEvent​(java.lang.String fqnOfCategoryClass,
                            Category logger,
                            long timeStamp,
                            Priority level,
                            java.lang.Object message,
                            java.lang.Throwable throwable)
        Instantiate a LoggingEvent from the supplied parameters.

        Except timeStamp all the other fields of LoggingEvent are filled when actually needed.

        Parameters:
        logger - The logger generating this event.
        timeStamp - the timestamp of this logging event
        level - The level of this event.
        message - The message of this event.
        throwable - The throwable of this event.
      • LoggingEvent

        public LoggingEvent​(java.lang.String fqnOfCategoryClass,
                            Category logger,
                            long timeStamp,
                            Level level,
                            java.lang.Object message,
                            java.lang.String threadName,
                            ThrowableInformation throwable,
                            java.lang.String ndc,
                            LocationInfo info,
                            java.util.Map properties)
        Create new instance.
        Parameters:
        fqnOfCategoryClass - Fully qualified class name of Logger implementation.
        logger - The logger generating this event.
        timeStamp - the timestamp of this logging event
        level - The level of this event.
        message - The message of this event.
        threadName - thread name
        throwable - The throwable of this event.
        ndc - Nested diagnostic context
        info - Location info
        properties - MDC properties
        Since:
        1.2.15
    • Method Detail

      • getLocationInformation

        public LocationInfo getLocationInformation()
        Set the location information for this logging event. The collected information is cached for future use.
      • getLevel

        public Level getLevel()
        Return the level of this event. Use this form instead of directly accessing the level field.
      • getLoggerName

        public java.lang.String getLoggerName()
        Return the name of the logger. Use this form instead of directly accessing the categoryName field.
      • getLogger

        public Category getLogger()
        Gets the logger of the event. Use should be restricted to cloning events.
        Since:
        1.2.15
      • getMessage

        public java.lang.Object getMessage()
        Return the message for this logging event.

        Before serialization, the returned object is the message passed by the user to generate the logging event. After serialization, the returned value equals the String form of the message possibly after object rendering.

        Since:
        1.1
      • getNDC

        public java.lang.String getNDC()
        This method returns the NDC for this event. It will return the correct content even if the event was generated in a different thread or even on a different machine. The NDC.get() method should never be called directly.
      • getMDC

        public java.lang.Object getMDC​(java.lang.String key)
        Returns the the context corresponding to the key parameter. If there is a local MDC copy, possibly because we are in a logging server or running inside AsyncAppender, then we search for the key in MDC copy, if a value is found it is returned. Otherwise, if the search in MDC copy returns a null result, then the current thread's MDC is used.

        Note that both the local MDC copy and the current thread's MDC are searched.

      • getMDCCopy

        public void getMDCCopy()
        Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.
      • getRenderedMessage

        public java.lang.String getRenderedMessage()
      • getStartTime

        public static long getStartTime()
        Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
      • getThreadName

        public java.lang.String getThreadName()
      • getThrowableInformation

        public ThrowableInformation getThrowableInformation()
        Returns the throwable information contained within this event. May be null if there is no such information.

        Note that the Throwable object contained within a ThrowableInformation does not survive serialization.

        Since:
        1.1
      • getThrowableStrRep

        public java.lang.String[] getThrowableStrRep()
        Return this event's throwable's string[] representaion.
      • setProperty

        public final void setProperty​(java.lang.String propName,
                                      java.lang.String propValue)
        Set value for MDC property. This adds the specified MDC property to the event. Access to the MDC is not synchronized, so this method should only be called when it is known that no other threads are accessing the MDC.
        Parameters:
        propName -
        propValue -
        Since:
        1.2.15
      • getProperty

        public final java.lang.String getProperty​(java.lang.String key)
        Return a property for this event. The return value can be null.

        Equivalent to getMDC(String) in log4j 1.2. Provided for compatibility with log4j 1.3.

        Parameters:
        key - property name
        Returns:
        property value or null if property not set
        Since:
        1.2.15
      • locationInformationExists

        public final boolean locationInformationExists()
        Check for the existence of location information without creating it (a byproduct of calling getLocationInformation).
        Returns:
        true if location information has been extracted.
        Since:
        1.2.15
      • getTimeStamp

        public final long getTimeStamp()
        Getter for the event's time stamp. The time stamp is calculated starting from 1970-01-01 GMT.
        Returns:
        timestamp
        Since:
        1.2.15
      • getPropertyKeySet

        public java.util.Set getPropertyKeySet()
        Returns the set of the key values in the properties for the event.

        The returned set is unmodifiable by the caller.

        Provided for compatibility with log4j 1.3

        Returns:
        Set an unmodifiable set of the property keys.
        Since:
        1.2.15
      • getProperties

        public java.util.Map getProperties()
        Returns the set of properties for the event.

        The returned set is unmodifiable by the caller.

        Provided for compatibility with log4j 1.3

        Returns:
        Set an unmodifiable map of the properties.
        Since:
        1.2.15
      • getFQNOfLoggerClass

        public java.lang.String getFQNOfLoggerClass()
        Get the fully qualified name of the calling logger sub-class/wrapper. Provided for compatibility with log4j 1.3
        Returns:
        fully qualified class name, may be null.
        Since:
        1.2.15
      • removeProperty

        public java.lang.Object removeProperty​(java.lang.String propName)
        This removes the specified MDC property from the event. Access to the MDC is not synchronized, so this method should only be called when it is known that no other threads are accessing the MDC.
        Parameters:
        propName - the property name to remove
        Since:
        1.2.16