Class PropertiesConfiguration
- java.lang.Object
-
- org.apache.logging.log4j.core.AbstractLifeCycle
-
- org.apache.logging.log4j.core.filter.AbstractFilterable
-
- org.apache.logging.log4j.core.config.AbstractConfiguration
-
- org.apache.log4j.config.Log4j1Configuration
-
- org.apache.log4j.config.PropertiesConfiguration
-
- All Implemented Interfaces:
Configuration
,Reconfigurable
,Filterable
,LifeCycle
,LifeCycle2
public class PropertiesConfiguration extends Log4j1Configuration
Construct a configuration based on Log4j 1 properties.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
PropertiesConfiguration.NameValue
-
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
AbstractFilterable.Builder<B extends AbstractFilterable.Builder<B>>
-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
ADDITIVITY_PREFIX
private static java.lang.String
APPENDER_PREFIX
private static java.lang.String
APPENDER_REF_TAG
private static java.lang.String
CATEGORY_PREFIX
static java.lang.String
DEBUG_KEY
static long
DEFAULT_DELAY
private static java.lang.String
INTERNAL_ROOT_NAME
private static java.lang.String
LOGGER_PREFIX
private static java.lang.String
LOGGER_REF
private java.util.Map<java.lang.String,Appender>
registry
private static java.lang.String
ROOT_CATEGORY_PREFIX
private static java.lang.String
ROOT_LOGGER_PREFIX
private static java.lang.String
ROOT_REF
-
Fields inherited from class org.apache.log4j.config.Log4j1Configuration
INHERITED, manager, MONITOR_INTERVAL, NULL, THRESHOLD_PARAM
-
Fields inherited from class org.apache.logging.log4j.core.config.AbstractConfiguration
isShutdownHookEnabled, listeners, pluginManager, pluginPackages, rootNode, scriptManager, shutdownTimeoutMillis
-
Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.config.Configuration
CONTEXT_PROPERTIES
-
-
Constructor Summary
Constructors Constructor Description PropertiesConfiguration(LoggerContext loggerContext, ConfigurationSource source, int monitorIntervalSeconds)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProperties(java.lang.Object obj, java.lang.String[] keys, java.util.Properties props, java.lang.String prefix)
private Appender
buildAppender(java.lang.String appenderName, java.lang.String className, java.lang.String prefix, java.lang.String layoutPrefix, java.lang.String filterPrefix, java.util.Properties props)
private Filter
buildFilter(java.lang.String className, java.lang.String appenderName, java.util.List<PropertiesConfiguration.NameValue> props)
private Layout
buildLayout(java.lang.String layoutPrefix, java.lang.String className, java.lang.String appenderName, java.util.Properties props)
private void
configureRoot(java.util.Properties props)
void
doConfigure()
private void
doConfigure(java.util.Properties properties)
Read configuration from a file.private boolean
getAdditivityForLogger(java.util.Properties props, java.lang.String loggerName)
Parse the additivity option for a non-root category.private static <T> T
newInstanceOf(java.lang.String className, java.lang.String type)
Appender
parseAppender(java.util.Properties props, java.lang.String appenderName)
Filter
parseAppenderFilters(java.util.Properties props, java.lang.String filterPrefix, java.lang.String appenderName)
ErrorHandler
parseErrorHandler(java.util.Properties props, java.lang.String errorHandlerPrefix, java.lang.String errorHandlerClass, Appender appender)
Layout
parseLayout(java.lang.String layoutPrefix, java.lang.String appenderName, java.util.Properties props)
private void
parseLogger(java.util.Properties props, LoggerConfig logger, java.lang.String optionKey, java.lang.String loggerName, java.lang.String value)
This method must work for the root category as well.private void
parseLoggers(java.util.Properties props)
Parse non-root elements, such non-root categories and renderers.-
Methods inherited from class org.apache.log4j.config.Log4j1Configuration
getBuilderManager, initialize, reconfigure
-
Methods inherited from class org.apache.logging.log4j.core.config.AbstractConfiguration
addAppender, addComponent, addListener, addLogger, addLoggerAppender, addLoggerFilter, createAdvertiser, createConfiguration, getAdvertiser, getAppender, getAppenders, getAsyncLoggerConfigDelegate, getComponent, getConfigurationSource, getCustomLevels, getDefaultStatus, getLogger, getLoggerConfig, getLoggerContext, getLoggers, getName, getNanoClock, getPluginManager, getPluginPackages, getProperties, getReliabilityStrategy, getRootLogger, getRootNode, getScheduler, getScriptManager, getShutdownTimeoutMillis, getStrSubstitutor, getWatchManager, initializeWatchers, isShutdownHookEnabled, preConfigure, removeAppender, removeListener, removeLogger, setAdvertiser, setLoggerAdditive, setName, setNanoClock, setPluginManager, setScriptManager, setToDefault, setup, start, stop, toByteArray
-
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, stop
-
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equalsImpl, getState, getStatusLogger, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
-
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.filter.Filterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter
-
-
-
-
Field Detail
-
CATEGORY_PREFIX
private static final java.lang.String CATEGORY_PREFIX
- See Also:
- Constant Field Values
-
LOGGER_PREFIX
private static final java.lang.String LOGGER_PREFIX
- See Also:
- Constant Field Values
-
ADDITIVITY_PREFIX
private static final java.lang.String ADDITIVITY_PREFIX
- See Also:
- Constant Field Values
-
ROOT_CATEGORY_PREFIX
private static final java.lang.String ROOT_CATEGORY_PREFIX
- See Also:
- Constant Field Values
-
ROOT_LOGGER_PREFIX
private static final java.lang.String ROOT_LOGGER_PREFIX
- See Also:
- Constant Field Values
-
APPENDER_PREFIX
private static final java.lang.String APPENDER_PREFIX
- See Also:
- Constant Field Values
-
LOGGER_REF
private static final java.lang.String LOGGER_REF
- See Also:
- Constant Field Values
-
ROOT_REF
private static final java.lang.String ROOT_REF
- See Also:
- Constant Field Values
-
APPENDER_REF_TAG
private static final java.lang.String APPENDER_REF_TAG
- See Also:
- Constant Field Values
-
DEFAULT_DELAY
public static final long DEFAULT_DELAY
- See Also:
- Constant Field Values
-
DEBUG_KEY
public static final java.lang.String DEBUG_KEY
- See Also:
- Constant Field Values
-
INTERNAL_ROOT_NAME
private static final java.lang.String INTERNAL_ROOT_NAME
- See Also:
- Constant Field Values
-
registry
private final java.util.Map<java.lang.String,Appender> registry
-
-
Constructor Detail
-
PropertiesConfiguration
public PropertiesConfiguration(LoggerContext loggerContext, ConfigurationSource source, int monitorIntervalSeconds)
Constructor.- Parameters:
loggerContext
- The LoggerContext.source
- The ConfigurationSource.monitorIntervalSeconds
- The monitoring interval in seconds.
-
-
Method Detail
-
doConfigure
public void doConfigure()
- Overrides:
doConfigure
in classAbstractConfiguration
-
doConfigure
private void doConfigure(java.util.Properties properties)
Read configuration from a file. The existing configuration is not cleared nor reset. If you require a different behavior, then callresetConfiguration
method before callingdoConfigure
.The configuration file consists of statements in the format
key=value
. The syntax of different configuration elements are discussed below.The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a custom level value. A custom level value can be specified in the form level#classname. By default the repository-wide threshold is set to the lowest possible value, namely the level
ALL
.Appender configuration
Appender configuration syntax is:
# For appender named appenderName, set its class. # Note: The appender name can contain dots. log4j.appender.appenderName=fully.qualified.name.of.appender.class # Set appender specific options. log4j.appender.appenderName.option1=value1 ... log4j.appender.appenderName.optionN=valueN
For each named appender you can configure its
Layout
. The syntax for configuring an appender's layout is:log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class log4j.appender.appenderName.layout.option1=value1 .... log4j.appender.appenderName.layout.optionN=valueN
The syntax for adding
Filter
s to an appender is:log4j.appender.appenderName.filter.ID=fully.qualified.name.of.filter.class log4j.appender.appenderName.filter.ID.option1=value1 ... log4j.appender.appenderName.filter.ID.optionN=valueN
The first line defines the class name of the filter identified by ID; subsequent lines with the same ID specify filter option - value pairs. Multiple filters are added to the appender in the lexicographic order of IDs.The syntax for adding an
ErrorHandler
to an appender is:log4j.appender.appenderName.errorhandler=fully.qualified.name.of.errorhandler.class log4j.appender.appenderName.errorhandler.appender-ref=appenderName log4j.appender.appenderName.errorhandler.option1=value1 ... log4j.appender.appenderName.errorhandler.optionN=valueN
Configuring loggers
The syntax for configuring the root logger is:
log4j.rootLogger=[level], appenderName, appenderName, ...
This syntax means that an optional level can be supplied followed by appender names separated by commas.
The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a custom level value. A custom level value can be specified in the form
level#classname
.If a level value is specified, then the root level is set to the corresponding level. If no level value is specified, then the root level remains untouched.
The root logger can be assigned multiple appenders.
Each appenderName (separated by commas) will be added to the root logger. The named appender is defined using the appender syntax defined above.
For non-root categories the syntax is almost the same:
log4j.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName, ...
The meaning of the optional level value is discussed above in relation to the root logger. In addition however, the value INHERITED can be specified meaning that the named logger should inherit its level from the logger hierarchy.
If no level value is supplied, then the level of the named logger remains untouched.
By default categories inherit their level from the hierarchy. However, if you set the level of a logger and later decide that that logger should inherit its level, then you should specify INHERITED as the value for the level value. NULL is a synonym for INHERITED.
Similar to the root logger syntax, each appenderName (separated by commas) will be attached to the named logger.
See the appender additivity rule in the user manual for the meaning of the
additivity
flag. # Set options for appender named "A1". # Appender "A1" will be a SyslogAppender log4j.appender.A1=org.apache.log4j.net.SyslogAppender # The syslog daemon resides on www.abc.net log4j.appender.A1.SyslogHost=www.abc.net # A1's layout is a PatternLayout, using the conversion pattern # %r %-5p %c{2} %M.%L %x - %m\n. Thus, the log output will # include # the relative time since the start of the application in # milliseconds, followed by the level of the log request, # followed by the two rightmost components of the logger name, # followed by the callers method name, followed by the line number, # the nested diagnostic context and finally the message itself. # Refer to the documentation ofPatternLayout
for further information # on the syntax of the ConversionPattern key. log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %c{2} %M.%L %x - %m\n # Set options for appender named "A2" # A2 should be a RollingFileAppender, with maximum file size of 10 MB # using at most one backup file. A2's layout is TTCC, using the # ISO8061 date format with context printing enabled. log4j.appender.A2=org.apache.log4j.RollingFileAppender log4j.appender.A2.MaxFileSize=10MB log4j.appender.A2.MaxBackupIndex=1 log4j.appender.A2.layout=org.apache.log4j.TTCCLayout log4j.appender.A2.layout.ContextPrinting=enabled log4j.appender.A2.layout.DateFormat=ISO8601 # Root logger set to DEBUG using the A2 appender defined above. log4j.rootLogger=DEBUG, A2 # Logger definitions: # The SECURITY logger inherits is level from root. However, it's output # will go to A1 appender defined above. It's additivity is non-cumulative. log4j.logger.SECURITY=INHERIT, A1 log4j.additivity.SECURITY=false # Only warnings or above will be logged for the logger "SECURITY.access". # Output will go to A1. log4j.logger.SECURITY.access=WARN # The logger "class.of.the.day" inherits its level from the # logger hierarchy. Output will go to the appender's of the root # logger, A2 in this case. log4j.logger.class.of.the.day=INHERITRefer to the setOption method in each Appender and Layout for class specific options.
Use the
#
or!
characters at the beginning of a line for comments.
-
configureRoot
private void configureRoot(java.util.Properties props)
-
parseLoggers
private void parseLoggers(java.util.Properties props)
Parse non-root elements, such non-root categories and renderers.
-
getAdditivityForLogger
private boolean getAdditivityForLogger(java.util.Properties props, java.lang.String loggerName)
Parse the additivity option for a non-root category.
-
parseLogger
private void parseLogger(java.util.Properties props, LoggerConfig logger, java.lang.String optionKey, java.lang.String loggerName, java.lang.String value)
This method must work for the root category as well.
-
parseAppender
public Appender parseAppender(java.util.Properties props, java.lang.String appenderName)
-
buildAppender
private Appender buildAppender(java.lang.String appenderName, java.lang.String className, java.lang.String prefix, java.lang.String layoutPrefix, java.lang.String filterPrefix, java.util.Properties props)
-
parseLayout
public Layout parseLayout(java.lang.String layoutPrefix, java.lang.String appenderName, java.util.Properties props)
-
buildLayout
private Layout buildLayout(java.lang.String layoutPrefix, java.lang.String className, java.lang.String appenderName, java.util.Properties props)
-
parseErrorHandler
public ErrorHandler parseErrorHandler(java.util.Properties props, java.lang.String errorHandlerPrefix, java.lang.String errorHandlerClass, Appender appender)
-
addProperties
public void addProperties(java.lang.Object obj, java.lang.String[] keys, java.util.Properties props, java.lang.String prefix)
-
parseAppenderFilters
public Filter parseAppenderFilters(java.util.Properties props, java.lang.String filterPrefix, java.lang.String appenderName)
-
buildFilter
private Filter buildFilter(java.lang.String className, java.lang.String appenderName, java.util.List<PropertiesConfiguration.NameValue> props)
-
newInstanceOf
private static <T> T newInstanceOf(java.lang.String className, java.lang.String type)
-
-