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 java.lang.String
ADVERTISER_KEY
private ConfigurationBuilder<PropertiesConfiguration>
builder
private static java.lang.String
CONFIG_NAME
private static java.lang.String
CONFIG_TYPE
private static java.lang.String
DEST
private LoggerContext
loggerContext
private static java.lang.String
MONITOR_INTERVAL
private static java.lang.String
PACKAGES
private java.util.Properties
rootProperties
private static java.lang.String
SHUTDOWN_HOOK
private static java.lang.String
SHUTDOWN_TIMEOUT
private static java.lang.String
STATUS_KEY
private static java.lang.String
VERBOSE
-
Constructor Summary
Constructors Constructor Description PropertiesConfigurationBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private <B extends FilterableComponentBuilder<? extends ComponentBuilder<?>>>
BaddFiltersToComponent(B componentBuilder, java.util.Properties properties)
private <B extends LoggableComponentBuilder<? extends ComponentBuilder<?>>>
BaddLoggersToComponent(B loggerBuilder, java.util.Properties properties)
PropertiesConfiguration
build()
Builds the object after all configuration has been set.private AppenderComponentBuilder
createAppender(java.lang.String key, java.util.Properties properties)
private AppenderRefComponentBuilder
createAppenderRef(java.lang.String key, java.util.Properties properties)
private static <B extends ComponentBuilder<B>>
ComponentBuilder<B>createComponent(ComponentBuilder<?> parent, java.lang.String key, java.util.Properties properties)
private FilterComponentBuilder
createFilter(java.lang.String key, java.util.Properties properties)
private LayoutComponentBuilder
createLayout(java.lang.String appenderName, java.util.Properties properties)
private LoggerComponentBuilder
createLogger(java.lang.String key, java.util.Properties properties)
private RootLoggerComponentBuilder
createRootLogger(java.util.Properties properties)
private ScriptComponentBuilder
createScript(java.util.Properties properties)
private ScriptFileComponentBuilder
createScriptFile(java.util.Properties properties)
LoggerContext
getLoggerContext()
private static <B extends ComponentBuilder<?>>
BprocessRemainingProperties(B builder, java.util.Properties properties)
PropertiesConfigurationBuilder
setConfigurationSource(ConfigurationSource source)
PropertiesConfigurationBuilder
setLoggerContext(LoggerContext loggerContext)
PropertiesConfigurationBuilder
setRootProperties(java.util.Properties rootProperties)
-
Methods inherited from class org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory
newConfigurationBuilder, newConfigurationBuilder
-
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.core.util.Builder
getErrorPrefix, isValid
-
-
-
-
Field Detail
-
ADVERTISER_KEY
private static final java.lang.String ADVERTISER_KEY
- See Also:
- Constant Field Values
-
STATUS_KEY
private static final java.lang.String STATUS_KEY
- See Also:
- Constant Field Values
-
SHUTDOWN_HOOK
private static final java.lang.String SHUTDOWN_HOOK
- See Also:
- Constant Field Values
-
SHUTDOWN_TIMEOUT
private static final java.lang.String SHUTDOWN_TIMEOUT
- See Also:
- Constant Field Values
-
VERBOSE
private static final java.lang.String VERBOSE
- See Also:
- Constant Field Values
-
DEST
private static final java.lang.String DEST
- See Also:
- Constant Field Values
-
PACKAGES
private static final java.lang.String PACKAGES
- See Also:
- Constant Field Values
-
CONFIG_NAME
private static final java.lang.String CONFIG_NAME
- See Also:
- Constant Field Values
-
MONITOR_INTERVAL
private static final java.lang.String MONITOR_INTERVAL
- See Also:
- Constant Field Values
-
CONFIG_TYPE
private static final java.lang.String CONFIG_TYPE
- See Also:
- Constant Field Values
-
builder
private final ConfigurationBuilder<PropertiesConfiguration> builder
-
loggerContext
private LoggerContext loggerContext
-
rootProperties
private java.util.Properties rootProperties
-
-
Method Detail
-
setRootProperties
public PropertiesConfigurationBuilder setRootProperties(java.util.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 interfaceBuilder<PropertiesConfiguration>
- Returns:
- the configured instance.
-
createScript
private ScriptComponentBuilder createScript(java.util.Properties properties)
-
createScriptFile
private ScriptFileComponentBuilder createScriptFile(java.util.Properties properties)
-
createAppender
private AppenderComponentBuilder createAppender(java.lang.String key, java.util.Properties properties)
-
createFilter
private FilterComponentBuilder createFilter(java.lang.String key, java.util.Properties properties)
-
createAppenderRef
private AppenderRefComponentBuilder createAppenderRef(java.lang.String key, java.util.Properties properties)
-
createLogger
private LoggerComponentBuilder createLogger(java.lang.String key, java.util.Properties properties)
-
createRootLogger
private RootLoggerComponentBuilder createRootLogger(java.util.Properties properties)
-
createLayout
private LayoutComponentBuilder createLayout(java.lang.String appenderName, java.util.Properties properties)
-
createComponent
private static <B extends ComponentBuilder<B>> ComponentBuilder<B> createComponent(ComponentBuilder<?> parent, java.lang.String key, java.util.Properties properties)
-
processRemainingProperties
private static <B extends ComponentBuilder<?>> B processRemainingProperties(B builder, java.util.Properties properties)
-
addFiltersToComponent
private <B extends FilterableComponentBuilder<? extends ComponentBuilder<?>>> B addFiltersToComponent(B componentBuilder, java.util.Properties properties)
-
addLoggersToComponent
private <B extends LoggableComponentBuilder<? extends ComponentBuilder<?>>> B addLoggersToComponent(B loggerBuilder, java.util.Properties properties)
-
setLoggerContext
public PropertiesConfigurationBuilder setLoggerContext(LoggerContext loggerContext)
-
getLoggerContext
public LoggerContext getLoggerContext()
-
-