org.apache.log4j.spi
public class LoggingEvent extends Object implements Serializable
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
Field Summary | |
---|---|
String | categoryName The category (logger) name. |
String | fqnOfCategoryClass Fully qualified name of the calling category class. |
Priority | level
Level of logging event. |
long | timeStamp The number of milliseconds elapsed from 1/1/1970 until logging event
was created. |
Constructor Summary | |
---|---|
LoggingEvent(String fqnOfCategoryClass, Category logger, Priority level, Object message, Throwable throwable)
Instantiate a LoggingEvent from the supplied parameters.
| |
LoggingEvent(String fqnOfCategoryClass, Category logger, long timeStamp, Priority level, Object message, Throwable throwable)
Instantiate a LoggingEvent from the supplied parameters.
|
Method Summary | |
---|---|
Level | getLevel()
Return the level of this event. |
LocationInfo | getLocationInformation()
Set the location information for this logging event. |
String | getLoggerName()
Return the name of the logger. |
Object | getMDC(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. |
Object | getMessage()
Return the message for this logging event.
|
String | getNDC()
This method returns the NDC for this event. |
String | getRenderedMessage() |
static long | getStartTime()
Returns the time when the application started, in milliseconds
elapsed since 01.01.1970. |
String | getThreadName() |
ThrowableInformation | getThrowableInformation()
Returns the throwable information contained within this
event. |
String[] | getThrowableStrRep()
Return this event's throwable's string[] representaion. |
Deprecated: This field will be marked as private in future releases. Please do not access it directly. Use the LoggingEvent method instead.
The category (logger) name.
Deprecated: This field will be marked as private in future releases. Please do not access it directly. Use the LoggingEvent 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 LoggingEvent method instead.
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.
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.
level
field.categoryName
field.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.
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
null
if there is no such information.
Note that the Throwable object contained within a ThrowableInformation does not survive serialization.
Since: 1.1