com.github.valfirst.slf4jtest

Class TestMDCAdapter

java.lang.Object

org.slf4j.helpers.BasicMDCAdapter

com.github.valfirst.slf4jtest.TestMDCAdapter

All Implemented Interfaces:

MDCAdapter

public class TestMDCAdapter
extends BasicMDCAdapter

Constructor Summary

Constructors

Constructor and Description
TestMDCAdapter()

Method Summary

Modifier and Type	Method and Description
void	clear()
String	get(String key)
boolean	getAllowNullValues() Whether null values are allowed in the MDC.
Map<String,String>	getCopyOfContextMap() Return a copy of the current thread's context map.
boolean	getEnable() Whether the MDC functionality is enabled.
boolean	getInherit() Whether child threads inherit a copy of the MDC from its parent thread.
static TestMDCAdapter	getInstance() Access the current MDC adapter.
boolean	getReturnNullCopyWhenMdcNotSet() Whether getCopyOfContextMap() returns null when no values have been set.
void	put(String key, String val)
void	remove(String key)
void	restoreOptions() Reset the options to values defined by the static configuration.
void	setAllowNullValues(boolean allowNullValues) Define whether null values are allowed in the MDC.
void	setContextMap(Map<String,String> contextMap)
void	setEnable(boolean enable) Enable the MDC functionality for all threads.
void	setInherit(boolean inherit) Define whether child threads inherit a copy of the MDC from its parent thread.
void	setReturnNullCopyWhenMdcNotSet(boolean returnNullCopyWhenMdcNotSet) Define whether getCopyOfContextMap() returns null when no values have been set.

Methods inherited from class org.slf4j.helpers.BasicMDCAdapter

clearDequeByKey, getCopyOfDequeByKey, getKeys, popByKey, pushByKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestMDCAdapter

public TestMDCAdapter()

Method Detail

put

public void put(String key,
                String val)

Specified by:

put in interface MDCAdapter

Overrides:

put in class BasicMDCAdapter

get

public String get(String key)

Specified by:

get in interface MDCAdapter

Overrides:

get in class BasicMDCAdapter

remove

public void remove(String key)

Specified by:

remove in interface MDCAdapter

Overrides:

remove in class BasicMDCAdapter

clear

public void clear()

Specified by:

clear in interface MDCAdapter

Overrides:

clear in class BasicMDCAdapter

getCopyOfContextMap

public Map<String,String> getCopyOfContextMap()

Return a copy of the current thread's context map. null is returned if

• The MDC functionality is disabled, c.f. setEnable, or
• "return null when empty" is enabled, c.f. setReturnNullCopyWhenMdcNotSet, and put has not been called.

Specified by:

getCopyOfContextMap in interface MDCAdapter

Overrides:

getCopyOfContextMap in class BasicMDCAdapter

Returns:

A copy of the current thread's context map.

setContextMap

public void setContextMap(Map<String,String> contextMap)

Specified by:

setContextMap in interface MDCAdapter

Overrides:

setContextMap in class BasicMDCAdapter

setEnable

public void setEnable(boolean enable)

Enable the MDC functionality for all threads.

Parameters:

enable - Whether to enable the MDC functionality. The default value is true.

setInherit

public void setInherit(boolean inherit)

Define whether child threads inherit a copy of the MDC from its parent thread. Note that the copy is taken when the Thread is constructed. This affects all threads.

Parameters:

inherit - Whether to enable inheritance. The default value is false.

setAllowNullValues

public void setAllowNullValues(boolean allowNullValues)

Define whether null values are allowed in the MDC. This affects all threads.

Parameters:

allowNullValues - Whether to allow nulls. The default value is true.

setReturnNullCopyWhenMdcNotSet

public void setReturnNullCopyWhenMdcNotSet(boolean returnNullCopyWhenMdcNotSet)

Define whether getCopyOfContextMap() returns null when no values have been set. This affects all threads.

Parameters:

returnNullCopyWhenMdcNotSet - Whether to return null. The default value is false. If false, an empty map is returned instead.

getEnable

public boolean getEnable()

Whether the MDC functionality is enabled.

Returns:

Whether the MDC functionality is enabled.

getInherit

public boolean getInherit()

Whether child threads inherit a copy of the MDC from its parent thread.

Returns:

Whether inheritance is enabled.

getAllowNullValues

public boolean getAllowNullValues()

Whether null values are allowed in the MDC.

Returns:

Whether nulls are allowed.

getReturnNullCopyWhenMdcNotSet

public boolean getReturnNullCopyWhenMdcNotSet()

Whether getCopyOfContextMap() returns null when no values have been set.

Returns:

Whether to return null.

restoreOptions

public void restoreOptions()

Reset the options to values defined by the static configuration. This undoes to changes made using setEnable(boolean), setInherit(boolean), setAllowNullValues(boolean), and setReturnNullCopyWhenMdcNotSet(boolean).

getInstance

public static TestMDCAdapter getInstance()

Access the current MDC adapter. Used to call the option setting methods.