org.apache.logging.log4j.core.lookup

Class Log4jLookup

java.lang.Object

org.apache.logging.log4j.core.lookup.AbstractLookup

org.apache.logging.log4j.core.lookup.AbstractConfigurationAwareLookup

org.apache.logging.log4j.core.lookup.Log4jLookup

All Implemented Interfaces:

ConfigurationAware, StrLookup

@Plugin(name="log4j",
        category="Lookup")
public class Log4jLookup
extends AbstractConfigurationAwareLookup

Lookup properties of Log4j

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CONFIG_LOCATION
static String	KEY_CONFIG_PARENT_LOCATION

Fields inherited from class org.apache.logging.log4j.core.lookup.AbstractConfigurationAwareLookup

configuration

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

CATEGORY

Constructor Summary

Constructors

Constructor and Description
Log4jLookup()

Method Summary

Modifier and Type	Method and Description
String	lookup(LogEvent event, String key) Looks up a String key to a String value possibly using the current LogEvent.

Methods inherited from class org.apache.logging.log4j.core.lookup.AbstractConfigurationAwareLookup

setConfiguration

Methods inherited from class org.apache.logging.log4j.core.lookup.AbstractLookup

lookup

Methods inherited from class java.lang.Object

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

Field Detail

KEY_CONFIG_LOCATION

public static final String KEY_CONFIG_LOCATION

See Also:

Constant Field Values

KEY_CONFIG_PARENT_LOCATION

public static final String KEY_CONFIG_PARENT_LOCATION

See Also:

Constant Field Values

Constructor Detail

Log4jLookup

public Log4jLookup()

Method Detail

lookup

public String lookup(LogEvent event,
                     String key)

Description copied from interface: StrLookup

Looks up a String key to a String value possibly using the current LogEvent.

The internal implementation may use any mechanism to return the value. The simplest implementation is to use a Map. However, virtually any implementation is possible.

For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value on demand from the database Or, a numeric based implementation could be created that treats the key as an integer, increments the value and return the result as a string - converting 1 to 2, 15 to 16 etc.

This method always returns a String, regardless of the underlying data, by converting it as necessary. For example:

 Map<String, Object> map = new HashMap<String, Object>();
 map.put("number", new Integer(2));
 assertEquals("2", StrLookup.mapLookup(map).lookup("number"));
 

Parameters:

event - The current LogEvent.

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

Returns:

the matching value, null if no match