Package org.apache.log4j
Class PropertyConfigurator
java.lang.Object
org.apache.log4j.PropertyConfigurator
- All Implemented Interfaces:
Configurator
Configures Log4j from properties.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
(package private) static class
(package private) class
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final String
(package private) static final String
private static final String
(package private) static final String
(package private) static final String
private static final String
static final String
Key for specifying theLoggerFactory
.(package private) static final String
private static final String
protected LoggerFactory
protected Hashtable
Used internally to keep track of configured appenders.(package private) static final String
private LoggerRepository
private static final String
If property set to true, then hierarchy will be reset before configuration.(package private) static final String
(package private) static final String
private static final String
(package private) static final String
private static final String
Fields inherited from interface org.apache.log4j.spi.Configurator
INHERITED, NULL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
configure
(InputStream inputStream) Reads configuration options from an InputStream.static void
Reads configuration options from configuration file.static void
Reads configuration options from urlconfigURL
.static void
configure
(Properties properties) Reads configuration options fromproperties
.static void
configureAndWatch
(String configFilename) LikeconfigureAndWatch(String, long)
except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.static void
configureAndWatch
(String configFilename, long delayMillis) Reads the configuration fileconfigFilename
if it exists.(package private) static void
configureAndWatch
(String configFilename, long delay, ClassLoader classLoader) protected void
configureLoggerFactory
(Properties properties) (package private) void
configureRootCategory
(Properties properties, LoggerRepository loggerRepository) void
doConfigure
(InputStream inputStream, LoggerRepository loggerRepository) Reads configuration options from an InputStream.(package private) Configuration
doConfigure
(InputStream inputStream, LoggerRepository loggerRepository, ClassLoader classLoader) void
doConfigure
(String fileName, LoggerRepository loggerRepository) Reads configuration options from configuration file.(package private) Configuration
doConfigure
(String fileName, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options from configuration file.void
doConfigure
(URL url, LoggerRepository loggerRepository) Read configuration options from urlconfigURL
.(package private) Configuration
doConfigure
(URL url, LoggerRepository loggerRepository, ClassLoader classLoader) void
doConfigure
(Properties properties, LoggerRepository loggerRepository) Reads configuration options fromproperties
.(package private) Configuration
doConfigure
(Properties properties, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options fromproperties
.private Properties
loadProperties
(InputStream inputStream) (package private) void
parseAdditivityForLogger
(Properties properties, Logger logger, String loggerName) Parse the additivity option for a non-root category.(package private) Appender
parseAppender
(Properties properties, String appenderName) (package private) void
parseAppenderFilters
(Properties properties, String appenderName, Appender appender) (package private) void
parseCategory
(Properties properties, Logger logger, String optionKey, String loggerName, String value) This method must work for the root category as well.protected void
parseCatsAndRenderers
(Properties properties, LoggerRepository loggerRepository) Parse non-root elements, such non-root categories and renderers.private void
parseErrorHandler
(ErrorHandler errorHandler, String errorHandlerPrefix, Properties props, LoggerRepository loggerRepository) private static Configuration
reconfigure
(Configuration configuration) (package private) Appender
registryGet
(String name) (package private) void
registryPut
(Appender appender)
-
Field Details
-
CATEGORY_PREFIX
- See Also:
-
LOGGER_PREFIX
- See Also:
-
FACTORY_PREFIX
- See Also:
-
ADDITIVITY_PREFIX
- See Also:
-
ROOT_CATEGORY_PREFIX
- See Also:
-
ROOT_LOGGER_PREFIX
- See Also:
-
APPENDER_PREFIX
- See Also:
-
RENDERER_PREFIX
- See Also:
-
THRESHOLD_PREFIX
- See Also:
-
THROWABLE_RENDERER_PREFIX
- See Also:
-
LOGGER_REF
- See Also:
-
ROOT_REF
- See Also:
-
APPENDER_REF_TAG
- See Also:
-
LOGGER_FACTORY_KEY
Key for specifying theLoggerFactory
. Currently set to "log4j.loggerFactory
".- See Also:
-
RESET_KEY
If property set to true, then hierarchy will be reset before configuration.- See Also:
-
INTERNAL_ROOT_NAME
- See Also:
-
registry
Used internally to keep track of configured appenders. -
repository
-
loggerFactory
-
-
Constructor Details
-
PropertyConfigurator
public PropertyConfigurator()
-
-
Method Details
-
configure
Reads configuration options from an InputStream.- Parameters:
inputStream
- The input stream
-
configure
Reads configuration options fromproperties
. SeedoConfigure(String, LoggerRepository)
for the expected format.- Parameters:
properties
- The properties
-
configure
Reads configuration options from configuration file.- Parameters:
fileName
- The configuration file.
-
configure
Reads configuration options from urlconfigURL
.- Parameters:
configURL
- The configuration URL
-
configureAndWatch
LikeconfigureAndWatch(String, long)
except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.- Parameters:
configFilename
- A file in key=value format.
-
configureAndWatch
Reads the configuration fileconfigFilename
if it exists. Moreover, a thread will be created that will periodically check ifconfigFilename
has been created or modified. The period is determined by thedelay
argument. If a change or file creation is detected, thenconfigFilename
is read to configure log4j.- Parameters:
configFilename
- A file in key=value format.delayMillis
- The delay in milliseconds to wait between each check.
-
configureAndWatch
-
reconfigure
-
configureLoggerFactory
Checks the providedProperties
object for aLoggerFactory
entry specified byLOGGER_FACTORY_KEY
. If such an entry exists, an attempt is made to create an instance using the default constructor. This instance is used for subsequent Category creations within this configurator.- See Also:
-
configureRootCategory
-
doConfigure
Reads configuration options from an InputStream.- Specified by:
doConfigure
in interfaceConfigurator
- Parameters:
inputStream
- The input streamloggerRepository
- The hierarchy
-
doConfigure
Configuration doConfigure(InputStream inputStream, LoggerRepository loggerRepository, ClassLoader classLoader) -
doConfigure
Reads configuration options fromproperties
. SeedoConfigure(String, LoggerRepository)
for the expected format.- Parameters:
properties
- The propertiesloggerRepository
- The hierarchy
-
doConfigure
Configuration doConfigure(Properties properties, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options fromproperties
. SeedoConfigure(String, LoggerRepository)
for the expected format.- Parameters:
properties
- The propertiesloggerRepository
- The hierarchy
-
doConfigure
Reads configuration options from configuration file.- Parameters:
fileName
- The configuration fileloggerRepository
- The hierarchy
-
doConfigure
Configuration doConfigure(String fileName, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options from configuration file.- Parameters:
fileName
- The configuration fileloggerRepository
- The hierarchy
-
doConfigure
Read configuration options from urlconfigURL
.- Specified by:
doConfigure
in interfaceConfigurator
- Parameters:
url
- The configuration URLloggerRepository
- The hierarchy
-
doConfigure
-
loadProperties
-
parseAdditivityForLogger
Parse the additivity option for a non-root category. -
parseAppender
-
parseAppenderFilters
-
parseCategory
void parseCategory(Properties properties, Logger logger, String optionKey, String loggerName, String value) This method must work for the root category as well. -
parseCatsAndRenderers
Parse non-root elements, such non-root categories and renderers. -
parseErrorHandler
private void parseErrorHandler(ErrorHandler errorHandler, String errorHandlerPrefix, Properties props, LoggerRepository loggerRepository) -
registryGet
-
registryPut
-