Package ch.qos.logback.classic.util

Class LogbackMDCAdapter

java.lang.Object
ch.qos.logback.classic.util.LogbackMDCAdapter
All Implemented Interfaces:
MDCAdapter
@Deprecated(since="2022-01-27") public class LogbackMDCAdapter extends Object implements MDCAdapter
Deprecated.
This internal logback API is not supported by AEM as a Cloud Service.
A Mapped Diagnostic Context, or MDC in short, is an instrument for distinguishing interleaved log output from different sources. Log output is typically interleaved when a server handles multiple clients near-simultaneously.

The MDC is managed on a per thread basis. A child thread automatically inherits a copy of the mapped diagnostic context of its parent.

For more information about MDC, please refer to the online manual at http://logback.qos.ch/manual/mdc.html

  • Constructor Details

    • LogbackMDCAdapter

      public LogbackMDCAdapter()
      Deprecated.

  • Method Details

    • put

      public void put(String key, String val) throws IllegalArgumentException
      Deprecated.
      Put a context value (the val parameter) as identified with the key parameter into the current thread's context map. Note that contrary to log4j, the val parameter can be null.

      If the current thread does not have a context map it is created as a side effect of this call.

      Specified by:
      put in interface MDCAdapter
      Throws:
      IllegalArgumentException - in case the "key" parameter is null

    • remove

      public void remove(String key)
      Deprecated.
      Remove the the context identified by the key parameter.

      Specified by:
      remove in interface MDCAdapter

    • clear

      public void clear()
      Deprecated.
      Clear all entries in the MDC.
      Specified by:
      clear in interface MDCAdapter

    • get

      public String get(String key)
      Deprecated.
      Get the context identified by the key parameter.

      Specified by:
      get in interface MDCAdapter
      Returns:
      the string value identified by the key parameter.

    • getPropertyMap

      public Map<String,String> getPropertyMap()
      Deprecated.
      Get the current thread's MDC as a map. This method is intended to be used internally.

    • getKeys

      public Set<String> getKeys()
      Deprecated.
      Returns the keys in the MDC as a Set. The returned value can be null.

    • getCopyOfContextMap

      public Map<String,String> getCopyOfContextMap()
      Deprecated.
      Return a copy of the current thread's context map. Returned value may be null.
      Specified by:
      getCopyOfContextMap in interface MDCAdapter
      Returns:
      A copy of the current thread's context map. May be null.

    • setContextMap

      public void setContextMap(Map<String,String> contextMap)
      Deprecated.
      Description copied from interface: MDCAdapter
      Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter. The context map parameter must only contain keys and values of type String.
      Specified by:
      setContextMap in interface MDCAdapter
      Parameters:
      contextMap - must contain only keys and values of type String