Class PropertiesLookup
java.lang.Object
org.apache.logging.log4j.core.lookup.PropertiesLookup
- All Implemented Interfaces:
StrLookup
A lookup designed for
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.-
Field Summary
-
Constructor Summary
ConstructorDescriptionPropertiesLookup
(Map<String, String> properties) Constructs a new instance for the given map.PropertiesLookup
(Property[] configProperties, Map<String, String> contextProperties) -
Method Summary
Modifier and TypeMethodDescriptionSame asStrLookup.lookup(String)
, but provides additional metadata describing the result.Same asStrLookup.lookup(LogEvent, String)
, but provides additional metadata describing the result.Looks a value from configuration properties.Looks up a String key to a String value possibly using the current LogEvent.toString()
-
Constructor Details
-
PropertiesLookup
-
PropertiesLookup
Constructs a new instance for the given map.- Parameters:
properties
- map these.
-
-
Method Details
-
lookup
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"));
-
lookup
Looks a value from configuration properties.If the property is not defined, then null is returned.
-
evaluate
Description copied from interface:StrLookup
Same asStrLookup.lookup(String)
, but provides additional metadata describing the result. Returns null if the key cannot be evaluated, otherwise aLookupResult
wrapping the non-null string value. -
evaluate
Description copied from interface:StrLookup
Same asStrLookup.lookup(LogEvent, String)
, but provides additional metadata describing the result. Returns null if the key cannot be evaluated, otherwise aLookupResult
wrapping the non-null string value. -
toString
-