Class Log4jMDCAdapter

java.lang.Object
org.slf4j.log4j12.Log4jMDCAdapter
All Implemented Interfaces:
MDCAdapter

public class Log4jMDCAdapter extends Object implements MDCAdapter
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Clear all entries in the MDC.
    get​(String key)
    Get the context identified by the key parameter.
    Return a copy of the current thread's context map, with keys and values of type String.
    void
    put​(String key, String val)
    Put a context value (the val parameter) as identified with the key parameter into the current thread's context map.
    void
    remove​(String key)
    Remove the the context identified by the key parameter.
    void
    setContextMap​(Map<String,​String> contextMap)
    Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MDCAdapter
      Clear all entries in the MDC.
      Specified by:
      clear in interface MDCAdapter
    • get

      public String get(String key)
      Description copied from interface: MDCAdapter
      Get the context identified by the key parameter. The key parameter cannot be null.
      Specified by:
      get in interface MDCAdapter
      Returns:
      the string value identified by the key parameter.
    • put

      public void put(String key, String val)
      Put a context value (the val parameter) as identified with the key parameter into the current thread's context map. The key parameter cannot be null. Log4j does not support null for the val parameter.

      This method delegates all work to log4j's MDC.

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

      public void remove(String key)
      Description copied from interface: MDCAdapter
      Remove the the context identified by the key parameter. The key parameter cannot be null.

      This method does nothing if there is no previous value associated with key.

      Specified by:
      remove in interface MDCAdapter
    • getCopyOfContextMap

      Description copied from interface: MDCAdapter
      Return a copy of the current thread's context map, with keys and values of type String. 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)
      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. Implementations must support null valued map passed as parameter.
      Specified by:
      setContextMap in interface MDCAdapter
      Parameters:
      contextMap - must contain only keys and values of type String