Class MDCContextMap

java.lang.Object
org.apache.logging.slf4j.MDCContextMap
All Implemented Interfaces:
CleanableThreadContextMap, ThreadContextMap, ThreadContextMap2

public class MDCContextMap extends Object implements CleanableThreadContextMap
Bind the ThreadContextMap to the SLF4J MDC.
  • Field Details

    • EMPTY_CONTEXT_DATA

      private static final StringMap EMPTY_CONTEXT_DATA
  • Constructor Details

    • MDCContextMap

      public MDCContextMap()
  • Method Details

    • put

      public void put(String key, String value)
      Description copied from interface: ThreadContextMap
      Puts a context value (the o parameter) as identified with the key parameter into the current thread's context map.

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

      Specified by:
      put in interface ThreadContextMap
      Parameters:
      key - The key name.
      value - The key value.
    • putAll

      public void putAll(Map<String,String> m)
      Description copied from interface: ThreadContextMap2
      Puts all given context map entries into the current thread's context map.

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

      Specified by:
      putAll in interface ThreadContextMap2
      Parameters:
      m - The map.
    • get

      public String get(String key)
      Description copied from interface: ThreadContextMap
      Gets the context identified by the key parameter.

      This method has no side effects.

      Specified by:
      get in interface ThreadContextMap
      Parameters:
      key - The key to locate.
      Returns:
      The value associated with the key or null.
    • remove

      public void remove(String key)
      Description copied from interface: ThreadContextMap
      Removes the context identified by the key parameter.
      Specified by:
      remove in interface ThreadContextMap
      Parameters:
      key - The key to remove.
    • removeAll

      public void removeAll(Iterable<String> keys)
      Description copied from interface: CleanableThreadContextMap
      Removes all given context map keys from the current thread's context map.

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

      Specified by:
      removeAll in interface CleanableThreadContextMap
      Parameters:
      keys - The keys.
    • clear

      public void clear()
      Description copied from interface: ThreadContextMap
      Clears the context.
      Specified by:
      clear in interface ThreadContextMap
    • containsKey

      public boolean containsKey(String key)
      Description copied from interface: ThreadContextMap
      Determines if the key is in the context.
      Specified by:
      containsKey in interface ThreadContextMap
      Parameters:
      key - The key to locate.
      Returns:
      True if the key is in the context, false otherwise.
    • getCopy

      public Map<String,String> getCopy()
      Description copied from interface: ThreadContextMap
      Gets a non-null mutable copy of current thread's context Map.
      Specified by:
      getCopy in interface ThreadContextMap
      Returns:
      a mutable copy of the context.
    • getImmutableMapOrNull

      public Map<String,String> getImmutableMapOrNull()
      Description copied from interface: ThreadContextMap
      Returns an immutable view on the context Map or null if the context map is empty.
      Specified by:
      getImmutableMapOrNull in interface ThreadContextMap
      Returns:
      an immutable context Map or null.
    • isEmpty

      public boolean isEmpty()
      Description copied from interface: ThreadContextMap
      Returns true if the Map is empty.
      Specified by:
      isEmpty in interface ThreadContextMap
      Returns:
      true if the Map is empty, false otherwise.
    • getReadOnlyContextData

      public StringMap getReadOnlyContextData()
      Description copied from interface: ThreadContextMap2
      Returns the context data for reading. Note that regardless of whether the returned context data has been frozen (made read-only) or not, callers should not attempt to modify the returned data structure.
      Specified by:
      getReadOnlyContextData in interface ThreadContextMap2
      Returns:
      the StringMap