org.apache.logging.log4j.core.lookup

Class ContextMapLookup

java.lang.Object

org.apache.logging.log4j.core.lookup.ContextMapLookup

All Implemented Interfaces:

StrLookup

@Plugin(name="ctx",
        category="Lookup")
public class ContextMapLookup
extends java.lang.Object
implements StrLookup

Looks up keys from the context. By default this is the ThreadContext, but users may configure a custom ContextDataInjector which obtains context data from some other source.

Field Summary

Fields

Modifier and Type	Field and Description
private ContextDataInjector	injector

Fields inherited from interface org.apache.logging.log4j.core.lookup.StrLookup

CATEGORY

Constructor Summary

Constructors

Constructor and Description
ContextMapLookup()

Method Summary

Modifier and Type	Method and Description
private ReadOnlyStringMap	currentContextData()
java.lang.String	lookup(LogEvent event, java.lang.String key) Looks up the value from the ThreadContext Map.
java.lang.String	lookup(java.lang.String key) Looks up the value from the ThreadContext Map.

Methods inherited from class java.lang.Object

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

Field Detail

injector

private final ContextDataInjector injector

Constructor Detail

ContextMapLookup

public ContextMapLookup()

Method Detail

lookup

public java.lang.String lookup(java.lang.String key)

Looks up the value from the ThreadContext Map.

Specified by:

lookup in interface StrLookup

Parameters:

key - the key to be looked up, may be null

Returns:

The value associated with the key.

currentContextData

private ReadOnlyStringMap currentContextData()

lookup

public java.lang.String lookup(LogEvent event,
                               java.lang.String key)

Looks up the value from the ThreadContext Map.

Specified by:

lookup in interface StrLookup

Parameters:

event - The current LogEvent.

key - the key to be looked up, may be null

Returns:

The value associated with the key.