org.apache.logging.log4j.core.impl

Class ThreadContextDataInjector.ForCopyOnWriteThreadContextMap

java.lang.Object

org.apache.logging.log4j.core.impl.ThreadContextDataInjector.ForCopyOnWriteThreadContextMap

All Implemented Interfaces:

ContextDataInjector

Enclosing class:

ThreadContextDataInjector

public static class ThreadContextDataInjector.ForCopyOnWriteThreadContextMap
extends Object
implements ContextDataInjector

The ContextDataInjector used when the ThreadContextMap implementation is a copy-on-write StringMap-based data structure.

If there are no configuration properties, this injector will return the thread context's internal data structure. Otherwise the configuration properties are combined with the thread context key-value pairs into the specified reusable StringMap.

Constructor Summary

Constructors

Constructor and Description
ForCopyOnWriteThreadContextMap()

Method Summary

Modifier and Type	Method and Description
StringMap	injectContextData(List<Property> props, StringMap ignore) If there are no configuration properties, this injector will return the thread context's internal data structure.
ReadOnlyStringMap	rawContextData() Returns a ReadOnlyStringMap object reflecting the current state of the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForCopyOnWriteThreadContextMap

public ForCopyOnWriteThreadContextMap()

Method Detail

injectContextData

public StringMap injectContextData(List<Property> props,
                                   StringMap ignore)

If there are no configuration properties, this injector will return the thread context's internal data structure. Otherwise the configuration properties are combined with the thread context key-value pairs into the specified reusable StringMap.

Specified by:

injectContextData in interface ContextDataInjector

Parameters:

props - list of configuration properties, may be null

ignore - a StringMap instance from the log event

Returns:

a StringMap combining configuration properties with thread context data

See Also:

ThreadContextDataInjector.copyProperties(List, StringMap)

rawContextData

public ReadOnlyStringMap rawContextData()

Description copied from interface: ContextDataInjector

Returns a ReadOnlyStringMap object reflecting the current state of the context. Configuration properties are not included in the result.

This method may be called multiple times for each log event by Filters and Lookups and implementors should take care to make this method as performant as possible while preserving at least the following thread-safety guarantee.

Thread-safety note: The returned object can only be safely used in the current thread. Changes in the underlying context may or may not be reflected in the returned object, depending on the context data source and the implementation of this method. It is not safe to pass the returned object to another thread.

Specified by:

rawContextData in interface ContextDataInjector

Returns:

a ReadOnlyStringMap object reflecting the current state of the context, may not return null