Class PropertiesConfigurationBuilder

java.lang.Object

org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory

org.apache.logging.log4j.core.config.properties.PropertiesConfigurationBuilder

All Implemented Interfaces:

Builder<PropertiesConfiguration>

public class PropertiesConfigurationBuilder
extends ConfigurationBuilderFactory
implements Builder<PropertiesConfiguration>

Helper builder for parsing properties files into a PropertiesConfiguration.

Since:

2.6

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ADVERTISER_KEY
private final ConfigurationBuilder<PropertiesConfiguration>	builder
private static final String	CONFIG_NAME
private static final String	CONFIG_TYPE
private static final String	DEST
private LoggerContext	loggerContext
private static final String	MONITOR_INTERVAL
private static final String	PACKAGES
private Properties	rootProperties
private static final String	SHUTDOWN_HOOK
private static final String	SHUTDOWN_TIMEOUT
private static final String	STATUS_KEY
private static final String	VERBOSE

Constructor Summary

Constructors

Constructor	Description
PropertiesConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
private <B extends FilterableComponentBuilder<? extends ComponentBuilder<?>>> B	addFiltersToComponent(B componentBuilder, Properties properties)
private <B extends LoggableComponentBuilder<? extends ComponentBuilder<?>>> B	addLoggersToComponent(B loggerBuilder, Properties properties)
PropertiesConfiguration	build()	Builds the object after all configuration has been set.
private AppenderComponentBuilder	createAppender(String key, Properties properties)
private AppenderRefComponentBuilder	createAppenderRef(String key, Properties properties)
private static <B extends ComponentBuilder<B>> ComponentBuilder<B>	createComponent(ComponentBuilder<?> parent, String key, Properties properties)
private FilterComponentBuilder	createFilter(String key, Properties properties)
private LayoutComponentBuilder	createLayout(String appenderName, Properties properties)
private LoggerComponentBuilder	createLogger(String key, Properties properties)
private RootLoggerComponentBuilder	createRootLogger(Properties properties)
private ScriptComponentBuilder	createScript(Properties properties)
private ScriptFileComponentBuilder	createScriptFile(Properties properties)
LoggerContext	getLoggerContext()
private static <B extends ComponentBuilder<?>> B	processRemainingProperties(B builder, Properties properties)
PropertiesConfigurationBuilder	setConfigurationSource(ConfigurationSource source)
PropertiesConfigurationBuilder	setLoggerContext(LoggerContext loggerContext)
PropertiesConfigurationBuilder	setRootProperties(Properties rootProperties)

Methods inherited from class ConfigurationBuilderFactory

newConfigurationBuilder, newConfigurationBuilder

Methods inherited from class Object

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

Methods inherited from interface Builder

getErrorPrefix, isValid

Field Details

ADVERTISER_KEY

private static final String ADVERTISER_KEY

See Also:

• Constant Field Values

STATUS_KEY

private static final String STATUS_KEY

See Also:

• Constant Field Values

SHUTDOWN_HOOK

private static final String SHUTDOWN_HOOK

See Also:

• Constant Field Values

SHUTDOWN_TIMEOUT

private static final String SHUTDOWN_TIMEOUT

See Also:

• Constant Field Values

VERBOSE

private static final String VERBOSE

See Also:

• Constant Field Values

DEST

private static final String DEST

See Also:

• Constant Field Values

PACKAGES

private static final String PACKAGES

See Also:

• Constant Field Values

CONFIG_NAME

private static final String CONFIG_NAME

See Also:

• Constant Field Values

MONITOR_INTERVAL

private static final String MONITOR_INTERVAL

See Also:

• Constant Field Values

CONFIG_TYPE

private static final String CONFIG_TYPE

See Also:

• Constant Field Values

builder

private final ConfigurationBuilder<PropertiesConfiguration> builder

loggerContext

private LoggerContext loggerContext

rootProperties

private Properties rootProperties

Constructor Details

PropertiesConfigurationBuilder

public PropertiesConfigurationBuilder()

Method Details

setRootProperties

public PropertiesConfigurationBuilder setRootProperties(Properties rootProperties)

setConfigurationSource

public PropertiesConfigurationBuilder setConfigurationSource(ConfigurationSource source)

build

public PropertiesConfiguration build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<PropertiesConfiguration>

Returns:

the configured instance.

createScript

private ScriptComponentBuilder createScript(Properties properties)

createScriptFile

private ScriptFileComponentBuilder createScriptFile(Properties properties)

createAppender

private AppenderComponentBuilder createAppender(String key,
 Properties properties)

createFilter

private FilterComponentBuilder createFilter(String key,
 Properties properties)

createAppenderRef

private AppenderRefComponentBuilder createAppenderRef(String key,
 Properties properties)

createLogger

private LoggerComponentBuilder createLogger(String key,
 Properties properties)

createRootLogger

private RootLoggerComponentBuilder createRootLogger(Properties properties)

createLayout

private LayoutComponentBuilder createLayout(String appenderName,
 Properties properties)

createComponent

private static <B extends ComponentBuilder<B>>
ComponentBuilder<B> createComponent(ComponentBuilder<?> parent,
 String key,
 Properties properties)

processRemainingProperties

private static <B extends ComponentBuilder<?>> B processRemainingProperties(B builder,
 Properties properties)

addFiltersToComponent

private <B extends FilterableComponentBuilder<? extends ComponentBuilder<?>>>
B addFiltersToComponent(B componentBuilder,
 Properties properties)

addLoggersToComponent

private <B extends LoggableComponentBuilder<? extends ComponentBuilder<?>>>
B addLoggersToComponent(B loggerBuilder,
 Properties properties)

setLoggerContext

public PropertiesConfigurationBuilder setLoggerContext(LoggerContext loggerContext)

getLoggerContext

public LoggerContext getLoggerContext()