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 Stringprivate static final String(package private) static final String(package private) static final Stringprivate static final Stringstatic final StringKey for specifying theLoggerFactory.(package private) static final Stringprivate static final Stringprotected LoggerFactoryprotected HashtableUsed internally to keep track of configured appenders.(package private) static final Stringprivate LoggerRepositoryprivate static final StringIf property set to true, then hierarchy will be reset before configuration.(package private) static final String(package private) static final Stringprivate static final String(package private) static final Stringprivate static final StringFields inherited from interface org.apache.log4j.spi.Configurator
INHERITED, NULL -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidconfigure(InputStream inputStream) Reads configuration options from an InputStream.static voidReads configuration options from configuration file.static voidReads configuration options from urlconfigURL.static voidconfigure(Properties properties) Reads configuration options fromproperties.static voidconfigureAndWatch(String configFilename) LikeconfigureAndWatch(String, long)except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.static voidconfigureAndWatch(String configFilename, long delayMillis) Reads the configuration fileconfigFilenameif it exists.(package private) static voidconfigureAndWatch(String configFilename, long delay, ClassLoader classLoader) protected voidconfigureLoggerFactory(Properties properties) (package private) voidconfigureRootCategory(Properties properties, LoggerRepository loggerRepository) voiddoConfigure(InputStream inputStream, LoggerRepository loggerRepository) Reads configuration options from an InputStream.(package private) ConfigurationdoConfigure(InputStream inputStream, LoggerRepository loggerRepository, ClassLoader classLoader) voiddoConfigure(String fileName, LoggerRepository loggerRepository) Reads configuration options from configuration file.(package private) ConfigurationdoConfigure(String fileName, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options from configuration file.voiddoConfigure(URL url, LoggerRepository loggerRepository) Read configuration options from urlconfigURL.(package private) ConfigurationdoConfigure(URL url, LoggerRepository loggerRepository, ClassLoader classLoader) voiddoConfigure(Properties properties, LoggerRepository loggerRepository) Reads configuration options fromproperties.(package private) ConfigurationdoConfigure(Properties properties, LoggerRepository loggerRepository, ClassLoader classLoader) Reads configuration options fromproperties.private PropertiesloadProperties(InputStream inputStream) (package private) voidparseAdditivityForLogger(Properties properties, Logger logger, String loggerName) Parse the additivity option for a non-root category.(package private) AppenderparseAppender(Properties properties, String appenderName) (package private) voidparseAppenderFilters(Properties properties, String appenderName, Appender appender) (package private) voidparseCategory(Properties properties, Logger logger, String optionKey, String loggerName, String value) This method must work for the root category as well.protected voidparseCatsAndRenderers(Properties properties, LoggerRepository loggerRepository) Parse non-root elements, such non-root categories and renderers.private voidparseErrorHandler(ErrorHandler errorHandler, String errorHandlerPrefix, Properties props, LoggerRepository loggerRepository) private static Configurationreconfigure(Configuration configuration) (package private) AppenderregistryGet(String name) (package private) voidregistryPut(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 fileconfigFilenameif it exists. Moreover, a thread will be created that will periodically check ifconfigFilenamehas been created or modified. The period is determined by thedelayargument. If a change or file creation is detected, thenconfigFilenameis 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 providedPropertiesobject for aLoggerFactoryentry 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:
doConfigurein 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:
doConfigurein 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
-