Package org.slf4j.impl
Class Log4jMDCAdapter
- java.lang.Object
-
- org.slf4j.impl.Log4jMDCAdapter
-
- All Implemented Interfaces:
MDCAdapter
public class Log4jMDCAdapter extends Object implements MDCAdapter
-
-
Constructor Summary
Constructors Constructor Description Log4jMDCAdapter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear all entries in the MDC.String
get(String key)
Get the context identified by thekey
parameter.Map
getCopyOfContextMap()
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 (theval
parameter) as identified with thekey
parameter into the current thread's context map.void
remove(String key)
Remove the the context identified by thekey
parameter.void
setContextMap(Map contextMap)
Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter.
-
-
-
Method Detail
-
clear
public void clear()
Description copied from interface:MDCAdapter
Clear all entries in the MDC.- Specified by:
clear
in interfaceMDCAdapter
-
get
public String get(String key)
Description copied from interface:MDCAdapter
Get the context identified by thekey
parameter. Thekey
parameter cannot be null.- Specified by:
get
in interfaceMDCAdapter
- Returns:
- the string value identified by the
key
parameter.
-
put
public void put(String key, String val)
Put a context value (theval
parameter) as identified with thekey
parameter into the current thread's context map. Thekey
parameter cannot be null. Log4j does not support null for theval
parameter.This method delegates all work to log4j's MDC.
- Specified by:
put
in interfaceMDCAdapter
- 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 thekey
parameter. Thekey
parameter cannot be null.This method does nothing if there is no previous value associated with
key
.- Specified by:
remove
in interfaceMDCAdapter
-
getCopyOfContextMap
public Map 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 interfaceMDCAdapter
- Returns:
- A copy of the current thread's context map. May be null.
-
setContextMap
public void setContextMap(Map 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.- Specified by:
setContextMap
in interfaceMDCAdapter
- Parameters:
contextMap
- must contain only keys and values of type String
-
-