Package org.slf4j.spi

Interface MDCAdapter

  • All Known Implementing Classes:
    BasicMDCAdapter, NOPMDCAdapter
    public interface MDCAdapter
    This interface abstracts the service offered by various MDC implementations.
    Since:
    1.4.1
    Author:
    Ceki Gülcü

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()
      Clear all entries in the MDC.
      void clearDequeByKey​(java.lang.String key)
      Clear the deque(stack) referenced by 'key'.
      java.lang.String get​(java.lang.String key)
      Get the context identified by the key parameter.
      java.util.Map<java.lang.String,​java.lang.String> getCopyOfContextMap()
      Return a copy of the current thread's context map, with keys and values of type String.
      java.util.Deque<java.lang.String> getCopyOfDequeByKey​(java.lang.String key)
      Returns a copy of the deque(stack) referenced by 'key'.
      java.lang.String popByKey​(java.lang.String key)
      Pop the stack referenced by 'key' and return the value possibly null.
      void pushByKey​(java.lang.String key, java.lang.String value)
      Push a value into the deque(stack) referenced by 'key'.
      void put​(java.lang.String key, java.lang.String val)
      Put a context value (the val parameter) as identified with the key parameter into the current thread's context map.
      void remove​(java.lang.String key)
      Remove the context identified by the key parameter.
      void setContextMap​(java.util.Map<java.lang.String,​java.lang.String> contextMap)
      Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter.

    • Method Detail

      • put

        void put​(java.lang.String key,
         java.lang.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. The val parameter can be null only if the underlying implementation supports it.

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

      • get

        java.lang.String get​(java.lang.String key)
        Get the context identified by the key parameter. The key parameter cannot be null.
        Returns:
        the string value identified by the key parameter.

      • remove

        void remove​(java.lang.String key)
        Remove 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.

      • clear

        void clear()
        Clear all entries in the MDC.

      • getCopyOfContextMap

        java.util.Map<java.lang.String,​java.lang.String> getCopyOfContextMap()
        Return a copy of the current thread's context map, with keys and values of type String. Returned value may be null.
        Returns:
        A copy of the current thread's context map. May be null.
        Since:
        1.5.1

      • setContextMap

        void setContextMap​(java.util.Map<java.lang.String,​java.lang.String> contextMap)
        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.
        Parameters:
        contextMap - must contain only keys and values of type String
        Since:
        1.5.1

      • pushByKey

        void pushByKey​(java.lang.String key,
               java.lang.String value)
        Push a value into the deque(stack) referenced by 'key'.
        Parameters:
        key - identifies the appropriate stack
        value - the value to push into the stack
        Since:
        2.0.0

      • popByKey

        java.lang.String popByKey​(java.lang.String key)
        Pop the stack referenced by 'key' and return the value possibly null.
        Parameters:
        key - identifies the deque(stack)
        Returns:
        the value just popped. May be null/
        Since:
        2.0.0

      • getCopyOfDequeByKey

        java.util.Deque<java.lang.String> getCopyOfDequeByKey​(java.lang.String key)
        Returns a copy of the deque(stack) referenced by 'key'. May be null.
        Parameters:
        key - identifies the stack
        Returns:
        copy of stack referenced by 'key'. May be null.
        Since:
        2.0.0

      • clearDequeByKey

        void clearDequeByKey​(java.lang.String key)
        Clear the deque(stack) referenced by 'key'.
        Parameters:
        key - identifies the stack
        Since:
        2.0.0