Class LogEventWithContextListMixIn

java.lang.Object
org.apache.logging.log4j.core.jackson.LogEventWithContextListMixIn
All Implemented Interfaces:
Serializable, LogEvent

abstract class LogEventWithContextListMixIn extends Object implements LogEvent
  • Field Details

  • Constructor Details

    • LogEventWithContextListMixIn

      LogEventWithContextListMixIn()
  • Method Details

    • getContextMap

      public abstract Map<String,String> getContextMap()
      Description copied from interface: LogEvent
      Gets the context map (also know as Mapped Diagnostic Context or MDC).
      Specified by:
      getContextMap in interface LogEvent
      Returns:
      The context map, never null.
    • getContextData

      public abstract ReadOnlyStringMap getContextData()
      Description copied from interface: LogEvent
      Returns the ReadOnlyStringMap object holding context data key-value pairs.

      Context data (also known as Mapped Diagnostic Context or MDC) is data that is set by the application to be included in all subsequent log events. The default source for context data is the ThreadContext (and properties configured on the Logger that logged the event), but users can configure a custom ContextDataInjector to inject key-value pairs from any arbitrary source.

      Specified by:
      getContextData in interface LogEvent
      Returns:
      the ReadOnlyStringMap object holding context data key-value pairs
      See Also:
    • getContextStack

      public abstract ThreadContext.ContextStack getContextStack()
      Description copied from interface: LogEvent
      Gets the context stack (also known as Nested Diagnostic Context or NDC).
      Specified by:
      getContextStack in interface LogEvent
      Returns:
      The context stack, never null.
    • getLevel

      public abstract Level getLevel()
      Description copied from interface: LogEvent
      Gets the level.
      Specified by:
      getLevel in interface LogEvent
      Returns:
      level.
    • getLoggerFqcn

      public abstract String getLoggerFqcn()
      Description copied from interface: LogEvent
      Returns the fully qualified class name of the caller of the logging API.
      Specified by:
      getLoggerFqcn in interface LogEvent
      Returns:
      The fully qualified class name of the caller.
    • getLoggerName

      public abstract String getLoggerName()
      Description copied from interface: LogEvent
      Gets the logger name.
      Specified by:
      getLoggerName in interface LogEvent
      Returns:
      logger name, may be null.
    • getMarker

      public abstract Marker getMarker()
      Description copied from interface: LogEvent
      Gets the Marker associated with the event.
      Specified by:
      getMarker in interface LogEvent
      Returns:
      Marker or null if no Marker was defined on this LogEvent
    • getMessage

      public abstract Message getMessage()
      Description copied from interface: LogEvent
      Gets the message associated with the event.
      Specified by:
      getMessage in interface LogEvent
      Returns:
      message.
    • getSource

      public abstract StackTraceElement getSource()
      Description copied from interface: LogEvent
      Gets the source of logging request.
      Specified by:
      getSource in interface LogEvent
      Returns:
      source of logging request, may be null.
    • getThreadId

      public abstract long getThreadId()
      Description copied from interface: LogEvent
      Gets the thread ID.
      Specified by:
      getThreadId in interface LogEvent
      Returns:
      thread ID.
    • getThreadName

      public abstract String getThreadName()
      Description copied from interface: LogEvent
      Gets the thread name.
      Specified by:
      getThreadName in interface LogEvent
      Returns:
      thread name, may be null. TODO guess this could go into a thread context object too. (RG) Why?
    • getThreadPriority

      public abstract int getThreadPriority()
      Description copied from interface: LogEvent
      Gets the thread priority.
      Specified by:
      getThreadPriority in interface LogEvent
      Returns:
      thread priority.
    • getThrown

      public abstract Throwable getThrown()
      Description copied from interface: LogEvent
      Gets throwable associated with logging request.

      Convenience method for ThrowableProxy.getThrowable();

      Specified by:
      getThrown in interface LogEvent
      Returns:
      throwable, may be null.
    • getThrownProxy

      public abstract ThrowableProxy getThrownProxy()
      Description copied from interface: LogEvent
      Gets throwable proxy associated with logging request.
      Specified by:
      getThrownProxy in interface LogEvent
      Returns:
      throwable, may be null.
    • getTimeMillis

      public abstract long getTimeMillis()
      Description copied from interface: LogEvent
      Gets event time in milliseconds since midnight, January 1, 1970 UTC. Use LogEvent.getInstant() to get higher precision timestamp information if available on this platform.
      Specified by:
      getTimeMillis in interface LogEvent
      Returns:
      the milliseconds component of this log event's timestamp
      See Also:
    • getInstant

      public abstract Instant getInstant()
      Description copied from interface: LogEvent
      Returns the Instant when the message was logged.

      Caution: if this LogEvent implementation is mutable and reused for multiple consecutive log messages, then the Instant object returned by this method is also mutable and reused. Client code should not keep a reference to the returned object but make a copy instead.

      Specified by:
      getInstant in interface LogEvent
      Returns:
      the Instant holding Instant details for this log event
    • isEndOfBatch

      public abstract boolean isEndOfBatch()
      Description copied from interface: LogEvent
      Returns true if this event is the last one in a batch, false otherwise. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to the immediateFlush=true configuration.
      Specified by:
      isEndOfBatch in interface LogEvent
      Returns:
      whether this event is the last one in a batch.
    • isIncludeLocation

      public abstract boolean isIncludeLocation()
      Description copied from interface: LogEvent
      Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.
      Specified by:
      isIncludeLocation in interface LogEvent
      Returns:
      true if the source of the logging request is required downstream, false otherwise.
      See Also:
    • setEndOfBatch

      public abstract void setEndOfBatch(boolean endOfBatch)
      Description copied from interface: LogEvent
      Sets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to the immediateFlush=true configuration.
      Specified by:
      setEndOfBatch in interface LogEvent
      Parameters:
      endOfBatch - true if this event is the last one in a batch, false otherwise.
    • setIncludeLocation

      public abstract void setIncludeLocation(boolean locationRequired)
      Description copied from interface: LogEvent
      Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.
      Specified by:
      setIncludeLocation in interface LogEvent
      Parameters:
      locationRequired - true if the source of the logging request is required downstream, false otherwise.
      See Also: