Package ch.qos.logback.classic.spi
Class LoggingEvent
java.lang.Object
ch.qos.logback.classic.spi.LoggingEvent
- All Implemented Interfaces:
ILoggingEvent
,DeferredProcessingAware
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 logback-classic components.
Writers of logback-classic components such as appenders should be aware of
that some of the LoggingEvent fields are initialized lazily. Therefore, an
appender wishing to output data to be later correctly read by a receiver,
must initialize "lazy" fields prior to writing them out. See the
prepareForDeferredProcessing()
method for the exact list.
- Author:
- Ceki Gülcü, Sébastien Pennec
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionObject[]
Get the caller information for this logging event.long
getLevel()
org.slf4j.Marker
getMdc()
Deprecated.Replaced by [@link #getMDCPropertyMap}Returns the MDC map.long
The sequence number associated with this event.Returns the throwable information contained within this event.long
boolean
If this event has caller data, then true is returned.void
This method should be called prior to serializing an event.void
setArgumentArray(Object[] argArray)
void
setCallerData(StackTraceElement[] callerDataArray)
void
void
setLoggerContextRemoteView(LoggerContextVO loggerContextVO)
void
setLoggerName(String loggerName)
void
setMarker(org.slf4j.Marker marker)
void
setMDCPropertyMap(Map<String,String> map)
Set the MDC map for this event.void
setMessage(String message)
void
setSquenceNumber(long sn)
void
setThreadName(String threadName)
void
Set this event's throwable information.void
setTimeStamp(long timeStamp)
toString()
-
Constructor Details
-
LoggingEvent
public LoggingEvent() -
LoggingEvent
-
-
Method Details
-
setArgumentArray
-
getArgumentArray
- Specified by:
getArgumentArray
in interfaceILoggingEvent
-
getLevel
- Specified by:
getLevel
in interfaceILoggingEvent
-
getLoggerName
- Specified by:
getLoggerName
in interfaceILoggingEvent
-
setLoggerName
-
getThreadName
- Specified by:
getThreadName
in interfaceILoggingEvent
-
setThreadName
- Parameters:
threadName
- The threadName to set.- Throws:
IllegalStateException
- If threadName has been already set.
-
getThrowableProxy
Returns the throwable information contained within this event. May benull
if there is no such information.- Specified by:
getThrowableProxy
in interfaceILoggingEvent
-
setThrowableProxy
Set this event's throwable information. -
prepareForDeferredProcessing
public void prepareForDeferredProcessing()This method should be called prior to serializing an event. It should also be called when using asynchronous or deferred logging. Note that due to performance concerns, this method does NOT extract caller data. It is the responsibility of the caller to extract caller information.- Specified by:
prepareForDeferredProcessing
in interfaceDeferredProcessingAware
- Specified by:
prepareForDeferredProcessing
in interfaceILoggingEvent
-
getLoggerContextVO
- Specified by:
getLoggerContextVO
in interfaceILoggingEvent
-
setLoggerContextRemoteView
-
getMessage
- Specified by:
getMessage
in interfaceILoggingEvent
-
setMessage
-
getTimeStamp
public long getTimeStamp()- Specified by:
getTimeStamp
in interfaceILoggingEvent
-
setTimeStamp
public void setTimeStamp(long timeStamp) -
getSequenceNumber
public long getSequenceNumber()Description copied from interface:ILoggingEvent
The sequence number associated with this event.Sequence numbers, if present, should be increasing monotonically.
- Specified by:
getSequenceNumber
in interfaceILoggingEvent
-
setSquenceNumber
public void setSquenceNumber(long sn) -
setLevel
-
getCallerData
Get the caller information for this logging event. If caller information is null at the time of its invocation, this method extracts location information. The collected information is cached for future use.Note that after serialization it is impossible to correctly extract caller information.
- Specified by:
getCallerData
in interfaceILoggingEvent
- Returns:
- the caller data associated with this event.
- See Also:
ILoggingEvent.hasCallerData()
-
hasCallerData
public boolean hasCallerData()Description copied from interface:ILoggingEvent
If this event has caller data, then true is returned. Otherwise the returned value is null.Logback components wishing to use caller data if available without causing it to be computed can invoke this method before invoking
ILoggingEvent.getCallerData()
.- Specified by:
hasCallerData
in interfaceILoggingEvent
- Returns:
- whether this event has caller data
-
setCallerData
-
getMarker
public org.slf4j.Marker getMarker()- Specified by:
getMarker
in interfaceILoggingEvent
-
setMarker
public void setMarker(org.slf4j.Marker marker) -
getContextBirthTime
public long getContextBirthTime() -
getFormattedMessage
- Specified by:
getFormattedMessage
in interfaceILoggingEvent
-
getMDCPropertyMap
Description copied from interface:ILoggingEvent
Returns the MDC map. The returned value can be an empty map but not null.- Specified by:
getMDCPropertyMap
in interfaceILoggingEvent
-
setMDCPropertyMap
Set the MDC map for this event.- Parameters:
map
-- Since:
- 1.0.8
-
getMdc
Deprecated.Replaced by [@link #getMDCPropertyMap}Synonym for [@link #getMDCPropertyMap}.- Specified by:
getMdc
in interfaceILoggingEvent
-
toString
-