Package org.apache.log4j.pattern
Class LogEvent
java.lang.Object
org.apache.log4j.pattern.LogEvent
- All Implemented Interfaces:
Serializable
This class is a copy of o.a.l.spi.LoggingEvent from log4j 1.2.15 which has
been renamed to keep the same overall class name length to allow a
serialization written with a prior instance of o.a.l.spi.LoggingEvent to be
deserialized with this class just by mangling the class name in the byte
stream.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal String
Deprecated.This field will be marked as private in future releases.final String
Fully qualified name of the calling category class.Deprecated.This field will be marked as private in future releases.final long
The number of milliseconds elapsed from 1/1/1970 until logging event was created. -
Constructor Summary
ConstructorsConstructorDescriptionLogEvent
(String fqnOfCategoryClass, Category logger, long timeStamp, Priority level, Object message, Throwable throwable) Instantiate a LoggingEvent from the supplied parameters.LogEvent
(String fqnOfCategoryClass, Category logger, Priority level, Object message, Throwable throwable) Instantiate a LoggingEvent from the supplied parameters.LogEvent
(String fqnOfCategoryClass, Logger logger, long timeStamp, Level level, Object message, String threadName, ThrowableInformation throwable, String ndc, LocationInfo info, Map properties) Create new instance. -
Method Summary
Modifier and TypeMethodDescriptionGet the fully qualified name of the calling logger sub-class/wrapper.getLevel()
Return the level of this event.Set the location information for this logging event.Return the name of the logger.Returns the the context corresponding to thekey
parameter.void
Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.Return the message for this logging event.getNDC()
This method returns the NDC for this event.Returns the set of properties for the event.final String
getProperty
(String key) Return a property for this event.Returns the set of the key values in the properties for the event.static long
Returns the time when the application started, in milliseconds elapsed since 01.01.1970.Returns the throwable information contained within this event.String[]
Return this event's throwable's string[] representaion.final long
Getter for the event's time stamp.final boolean
Check for the existence of location information without creating it (a byproduct of calling getLocationInformation).final void
setProperty
(String propName, String propValue) Set value for MDC property.
-
Field Details
-
fqnOfCategoryClass
Fully qualified name of the calling category class. -
categoryName
Deprecated.This field will be marked as private in future releases. Please do not access it directly. Use thegetLoggerName()
method instead.The category (logger) name.
-
level
Deprecated.This field will be marked as private in future releases. Please do not access it directly. Use thegetLevel()
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 timeStampThe number of milliseconds elapsed from 1/1/1970 until logging event was created.
-
-
Constructor Details
-
LogEvent
public LogEvent(String fqnOfCategoryClass, Category logger, Priority level, Object message, Throwable throwable) Instantiate a LoggingEvent from the supplied parameters.Except
timeStamp
all the other fields ofLoggingEvent
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.
-
LogEvent
public LogEvent(String fqnOfCategoryClass, Category logger, long timeStamp, Priority level, Object message, Throwable throwable) Instantiate a LoggingEvent from the supplied parameters.Except
timeStamp
all the other fields ofLoggingEvent
are filled when actually needed.- Parameters:
logger
- The logger generating this event.timeStamp
- the timestamp of this logging eventlevel
- The level of this event.message
- The message of this event.throwable
- The throwable of this event.
-
LogEvent
public LogEvent(String fqnOfCategoryClass, Logger logger, long timeStamp, Level level, Object message, String threadName, ThrowableInformation throwable, String ndc, LocationInfo info, 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 eventlevel
- The level of this event.message
- The message of this event.threadName
- thread namethrowable
- The throwable of this event.ndc
- Nested diagnostic contextinfo
- Location infoproperties
- MDC properties- Since:
- 1.2.15
-
-
Method Details
-
getLocationInformation
Set the location information for this logging event. The collected information is cached for future use. -
getLevel
Return the level of this event. Use this form instead of directly accessing thelevel
field. -
getLoggerName
Return the name of the logger. Use this form instead of directly accessing thecategoryName
field. -
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
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. TheNDC.get()
method should never be called directly. -
getMDC
Returns the the context corresponding to thekey
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'sMDC
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
-
getStartTime
public static long getStartTime()Returns the time when the application started, in milliseconds elapsed since 01.01.1970. -
getThreadName
-
getThrowableInformation
Returns the throwable information contained within this event. May benull
if there is no such information.Note that the
Throwable
object contained within aThrowableInformation
does not survive serialization.- Since:
- 1.1
-
getThrowableStrRep
Return this event's throwable's string[] representaion. -
setProperty
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
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
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
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
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
-