Package ch.qos.logback.classic.spi

Class LoggingEvent

  • All Implemented Interfaces:
    ILoggingEvent, DeferredProcessingAware
    @Deprecated(since="2022-01-27")
public class LoggingEvent
extends java.lang.Object
implements ILoggingEvent
    Deprecated.
    This internal logback API is not supported by AEM as a Cloud Service.
    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.

    • Constructor Detail

      • LoggingEvent

        public LoggingEvent()
        Deprecated.

      • LoggingEvent

        public LoggingEvent​(java.lang.String fqcn,
                    Logger logger,
                    Level level,
                    java.lang.String message,
                    java.lang.Throwable throwable,
                    java.lang.Object[] argArray)
        Deprecated.

    • Method Detail

      • setArgumentArray

        public void setArgumentArray​(java.lang.Object[] argArray)
        Deprecated.

      • setLoggerName

        public void setLoggerName​(java.lang.String loggerName)
        Deprecated.

      • setThreadName

        public void setThreadName​(java.lang.String threadName)
                   throws java.lang.IllegalStateException
        Deprecated.
        Parameters:
        threadName - The threadName to set.
        Throws:
        java.lang.IllegalStateException - If threadName has been already set.

      • getThrowableProxy

        public IThrowableProxy getThrowableProxy()
        Deprecated.
        Returns the throwable information contained within this event. May be null if there is no such information.
        Specified by:
        getThrowableProxy in interface ILoggingEvent

      • setThrowableProxy

        public void setThrowableProxy​(ThrowableProxy tp)
        Deprecated.
        Set this event's throwable information.

      • prepareForDeferredProcessing

        public void prepareForDeferredProcessing()
        Deprecated.
        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 interface DeferredProcessingAware
        Specified by:
        prepareForDeferredProcessing in interface ILoggingEvent

      • setLoggerContextRemoteView

        public void setLoggerContextRemoteView​(LoggerContextVO loggerContextVO)
        Deprecated.

      • getMessage

        public java.lang.String getMessage()
        Deprecated.
        Specified by:
        getMessage in interface ILoggingEvent

      • setMessage

        public void setMessage​(java.lang.String message)
        Deprecated.

      • setTimeStamp

        public void setTimeStamp​(long timeStamp)
        Deprecated.

      • setLevel

        public void setLevel​(Level level)
        Deprecated.

      • getCallerData

        public java.lang.StackTraceElement[] getCallerData()
        Deprecated.
        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 interface ILoggingEvent
        Returns:
        the caller data associated with this event.
        See Also:
        ILoggingEvent.hasCallerData()

      • hasCallerData

        public boolean hasCallerData()
        Deprecated.
        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 interface ILoggingEvent
        Returns:
        whether this event has caller data

      • setCallerData

        public void setCallerData​(java.lang.StackTraceElement[] callerDataArray)
        Deprecated.

      • setMarker

        public void setMarker​(Marker marker)
        Deprecated.

      • getContextBirthTime

        public long getContextBirthTime()
        Deprecated.

      • getMDCPropertyMap

        public java.util.Map<java.lang.String,​java.lang.String> getMDCPropertyMap()
        Deprecated.
        Description copied from interface: ILoggingEvent
        Returns the MDC map. The returned value can be an empty map but not null.
        Specified by:
        getMDCPropertyMap in interface ILoggingEvent

      • setMDCPropertyMap

        public void setMDCPropertyMap​(java.util.Map<java.lang.String,​java.lang.String> map)
        Deprecated.
        Set the MDC map for this event.
        Parameters:
        map -
        Since:
        1.0.8

      • getMdc

        public java.util.Map<java.lang.String,​java.lang.String> getMdc()
        Deprecated.
        Replaced by [@link #getMDCPropertyMap}
        Synonym for [@link #getMDCPropertyMap}.
        Specified by:
        getMdc in interface ILoggingEvent

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object