org.apache.log4j.spi
Class LoggingEvent

java.lang.Object
  org.apache.log4j.spi.LoggingEvent

All Implemented Interfaces:

Serializable

public class LoggingEvent

extends Object

implements 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

See Also:

Serialized Form

fqnOfCategoryClass

public final transient String fqnOfCategoryClass

Fully qualified name of the calling category class.

logger

public transient Category logger

The category of the logging event. This field is not serialized for performance reasons.

It is set by the LoggingEvent constructor or set by a remote entity after deserialization.

categoryName

public final String categoryName

The category (logger) name.

level

public transient Priority level

Level of logging event. Level cannot be serializable because it is a flyweight. Due to its special seralization it cannot be declared final either.

timeStamp

public final long timeStamp

The number of milliseconds elapsed from 1/1/1970 until logging event was created.

LoggingEvent

public LoggingEvent(String fqnOfCategoryClass,
                    Category logger,
                    Priority priority,
                    Object message,
                    Throwable throwable)

Instantiate a LoggingEvent from the supplied parameters.

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

Parameters:

message - The message of this event.

throwable - The throwable of this event.

LoggingEvent

public LoggingEvent(String fqnOfCategoryClass,
                    Category logger,
                    long timeStamp,
                    Priority priority,
                    Object message,
                    Throwable throwable)

Instantiate a LoggingEvent from the supplied parameters.

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

Parameters:

timeStamp - the timestamp of this logging event

message - The message of this event.

throwable - The throwable of this event.

getLocationInformation

public LocationInfo getLocationInformation()

Set the location information for this logging event. The collected information is cached for future use.

getMessage

public 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 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 Object getMDC(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 String getRenderedMessage()

getStartTime

public static long getStartTime()

Returns the time when the application started, in milliseconds elapsed since 01.01.1970.

getThreadName

public 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 String[] getThrowableStrRep()

Return this event's throwable's string[] representaion.