public final class PropertiesLookup extends Object implements StrLookup
Properties defined in the configuration. This is similar
to MapLookup without special handling for structured messages.
Note that this lookup is not a plugin, but wired as a default lookup in the configuration.| Constructor and Description |
|---|
PropertiesLookup(Map<String,String> properties)
Constructs a new instance for the given map.
|
PropertiesLookup(Property[] configProperties,
Map<String,String> contextProperties) |
| Modifier and Type | Method and Description |
|---|---|
LookupResult |
evaluate(LogEvent event,
String key)
Same as
StrLookup.lookup(LogEvent, String), but provides additional metadata describing the result. |
LookupResult |
evaluate(String key)
Same as
StrLookup.lookup(String), but provides additional metadata describing the result. |
String |
lookup(LogEvent event,
String key)
Looks up a String key to a String value possibly using the current LogEvent.
|
String |
lookup(String key)
Looks a value from configuration properties.
|
String |
toString() |
public PropertiesLookup(Property[] configProperties, Map<String,String> contextProperties)
public String lookup(LogEvent event, String key)
StrLookupThe 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"));
public String lookup(String key)
If the property is not defined, then null is returned.
public LookupResult evaluate(String key)
StrLookupStrLookup.lookup(String), but provides additional metadata describing the result.
Returns null if the key cannot be evaluated, otherwise a LookupResult wrapping the non-null string value.public LookupResult evaluate(LogEvent event, String key)
StrLookupStrLookup.lookup(LogEvent, String), but provides additional metadata describing the result.
Returns null if the key cannot be evaluated, otherwise a LookupResult wrapping the non-null string value. Copyright © 1999-2023 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.