org.apache.logging.log4j.spi

Interface ThreadContextMap2

All Superinterfaces:

ThreadContextMap

All Known Subinterfaces:

CleanableThreadContextMap, ObjectThreadContextMap

All Known Implementing Classes:

CopyOnWriteSortedArrayThreadContextMap, GarbageFreeSortedArrayThreadContextMap, MDCContextMap

public interface ThreadContextMap2
extends ThreadContextMap

Extension service provider interface to implement additional custom MDC behavior for ThreadContext. Consider implementing CleanableThreadContextMap instead.

Since:

2.7

See Also:

ThreadContextMap

Method Summary

Modifier and Type	Method and Description
StringMap	getReadOnlyContextData() Returns the context data for reading.
void	putAll(java.util.Map<java.lang.String,java.lang.String> map) Puts all given context map entries into the current thread's context map.

Methods inherited from interface org.apache.logging.log4j.spi.ThreadContextMap

clear, containsKey, get, getCopy, getImmutableMapOrNull, isEmpty, put, remove

Method Detail

putAll

void putAll(java.util.Map<java.lang.String,java.lang.String> map)

Puts all given context map entries into the current thread's context map.

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

Parameters:

map - The map.

Since:

2.7

getReadOnlyContextData

StringMap getReadOnlyContextData()

Returns the context data for reading. Note that regardless of whether the returned context data has been frozen (made read-only) or not, callers should not attempt to modify the returned data structure.

Returns:

the StringMap