org.apache.logging.log4j.util

Class EnvironmentPropertySource

java.lang.Object

org.apache.logging.log4j.util.EnvironmentPropertySource

All Implemented Interfaces:

PropertySource

public class EnvironmentPropertySource
extends Object
implements PropertySource

PropertySource implementation that uses environment variables as a source. All environment variables must begin with LOG4J_ so as not to conflict with other variables. Normalized environment variables follow a scheme like this: log4j2.fooBarProperty would normalize to LOG4J_FOO_BAR_PROPERTY.

Since:

2.10.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.util.PropertySource

PropertySource.Comparator, PropertySource.Util

Constructor Summary

Constructors

Constructor and Description
EnvironmentPropertySource()

Method Summary

Modifier and Type	Method and Description
void	forEach(BiConsumer<String,String> action) Iterates over all properties and performs an action for each key/value pair.
CharSequence	getNormalForm(Iterable<? extends CharSequence> tokens) Converts a list of property name tokens into a normal form.
int	getPriority() Returns the order in which this PropertySource has priority.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.util.PropertySource

containsProperty, getProperty

Constructor Detail

EnvironmentPropertySource

public EnvironmentPropertySource()

Method Detail

getPriority

public int getPriority()

Description copied from interface: PropertySource

Returns the order in which this PropertySource has priority. A higher value means that the source will be applied later so as to take precedence over other property sources.

Specified by:

getPriority in interface PropertySource

Returns:

priority value

forEach

public void forEach(BiConsumer<String,String> action)

Description copied from interface: PropertySource

Iterates over all properties and performs an action for each key/value pair.

Specified by:

forEach in interface PropertySource

Parameters:

action - action to perform on each key/value pair

getNormalForm

public CharSequence getNormalForm(Iterable<? extends CharSequence> tokens)

Description copied from interface: PropertySource

Converts a list of property name tokens into a normal form. For example, a list of tokens such as "foo", "bar", "baz", might be normalized into the property name "log4j2.fooBarBaz".

Specified by:

getNormalForm in interface PropertySource

Parameters:

tokens - list of property name tokens

Returns:

a normalized property name using the given tokens