Class PropertiesLookup
- java.lang.Object
-
- org.apache.logging.log4j.core.lookup.PropertiesLookup
-
- All Implemented Interfaces:
StrLookup
public final class PropertiesLookup extends java.lang.Object implements StrLookup
A lookup designed forProperties
defined in the configuration. This is similar toMapLookup
without special handling for structured messages. Note that this lookup is not a plugin, but wired as a default lookup in the configuration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
PropertiesLookup.ConfigurationPropertyResult
private static class
PropertiesLookup.ContextPropertyResult
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.String,PropertiesLookup.ConfigurationPropertyResult>
configurationProperties
Configuration properties.private java.util.Map<java.lang.String,java.lang.String>
contextProperties
Logger context properties.
-
Constructor Summary
Constructors Constructor Description PropertiesLookup(java.util.Map<java.lang.String,java.lang.String> properties)
Constructs a new instance for the given map.PropertiesLookup(Property[] configProperties, java.util.Map<java.lang.String,java.lang.String> contextProperties)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static java.util.Map<java.lang.String,PropertiesLookup.ConfigurationPropertyResult>
createConfigurationPropertyMap(Property[] props)
LookupResult
evaluate(java.lang.String key)
Same asStrLookup.lookup(String)
, but provides additional metadata describing the result.LookupResult
evaluate(LogEvent event, java.lang.String key)
Same asStrLookup.lookup(LogEvent, String)
, but provides additional metadata describing the result.java.lang.String
lookup(java.lang.String key)
Looks a value from configuration properties.java.lang.String
lookup(LogEvent event, java.lang.String key)
Looks up a String key to a String value possibly using the current LogEvent.java.lang.String
toString()
-
-
-
Field Detail
-
contextProperties
private final java.util.Map<java.lang.String,java.lang.String> contextProperties
Logger context properties.
-
configurationProperties
private final java.util.Map<java.lang.String,PropertiesLookup.ConfigurationPropertyResult> configurationProperties
Configuration properties.
-
-
Constructor Detail
-
PropertiesLookup
public PropertiesLookup(Property[] configProperties, java.util.Map<java.lang.String,java.lang.String> contextProperties)
-
PropertiesLookup
public PropertiesLookup(java.util.Map<java.lang.String,java.lang.String> properties)
Constructs a new instance for the given map.- Parameters:
properties
- map these.
-
-
Method Detail
-
lookup
public java.lang.String lookup(LogEvent event, java.lang.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"));
-
lookup
public java.lang.String lookup(java.lang.String key)
Looks a value from configuration properties.If the property is not defined, then null is returned.
-
evaluate
public LookupResult evaluate(java.lang.String key)
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
public LookupResult evaluate(LogEvent event, java.lang.String key)
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
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
createConfigurationPropertyMap
private static java.util.Map<java.lang.String,PropertiesLookup.ConfigurationPropertyResult> createConfigurationPropertyMap(Property[] props)
-
-