org.slf4j.helpers

Class BasicMDCAdapter

public class BasicMDCAdapter extends Object implements MDCAdapter

Basic MDC implementation, which can be used with logging systems that lack out-of-the-box MDC support. This code is largely based on logback's LogbackMDCAdapter.

Since: 1.5.0

Author: Ceki Gulcu Maarten Bosteels

Method Summary
void	clear() Clear all entries in the MDC.
String	get(String key) Get the context identified by the `key` parameter.
Map	getCopyOfContextMap() Return a copy of the current thread's context map.
Set	getKeys() Returns the keys in the MDC as a Set of Strings The returned value can be null.
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 contextMap)

Method Detail

clear

public void clear()

Clear all entries in the MDC.

get

public String get(String key)

Get the context identified by the key parameter.

getCopyOfContextMap

public Map getCopyOfContextMap()

Return a copy of the current thread's context map. Returned value may be null.

getKeys

public Set getKeys()

Returns the keys in the MDC as a Set of Strings The returned value can be null.

Returns: the keys in the MDC

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. 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.

Throws: IllegalArgumentException in case the "key" parameter is null

remove

public void remove(String key)

Remove the the context identified by the key parameter.

setContextMap

public void setContextMap(Map contextMap)