Package org.apache.log4j
Class PropertyConfigurator
- java.lang.Object
-
- org.apache.log4j.PropertyConfigurator
-
- All Implemented Interfaces:
Configurator
public class PropertyConfigurator extends Object implements Configurator
Configures Log4j from properties.
-
-
Field Summary
Fields Modifier and Type Field Description static String
LOGGER_FACTORY_KEY
Key for specifying theLoggerFactory
.protected LoggerFactory
loggerFactory
protected Hashtable
registry
Used internally to keep track of configured appenders.-
Fields inherited from interface org.apache.log4j.spi.Configurator
INHERITED, NULL
-
-
Constructor Summary
Constructors Constructor Description PropertyConfigurator()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
configure(InputStream inputStream)
Reads configuration options from an InputStream.static void
configure(String fileName)
Reads configuration options from configuration file.static void
configure(URL configURL)
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.protected void
configureLoggerFactory(Properties properties)
void
doConfigure(InputStream inputStream, LoggerRepository loggerRepository)
Reads configuration options from an InputStream.void
doConfigure(String fileName, LoggerRepository loggerRepository)
Reads configuration options from configuration file.void
doConfigure(URL url, LoggerRepository loggerRepository)
Read configuration options from urlconfigURL
.void
doConfigure(Properties properties, LoggerRepository loggerRepository)
Reads configuration options fromproperties
.protected void
parseCatsAndRenderers(Properties properties, LoggerRepository loggerRepository)
Parse non-root elements, such non-root categories and renderers.
-
-
-
Field Detail
-
LOGGER_FACTORY_KEY
public static final String LOGGER_FACTORY_KEY
Key for specifying theLoggerFactory
. Currently set to "log4j.loggerFactory
".- See Also:
- Constant Field Values
-
registry
protected Hashtable registry
Used internally to keep track of configured appenders.
-
loggerFactory
protected LoggerFactory loggerFactory
-
-
Method Detail
-
configure
public static void configure(InputStream inputStream)
Reads configuration options from an InputStream.- Parameters:
inputStream
- The input stream
-
configure
public static void configure(Properties properties)
Reads configuration options fromproperties
. SeedoConfigure(String, LoggerRepository)
for the expected format.- Parameters:
properties
- The properties
-
configure
public static void configure(String fileName)
Reads configuration options from configuration file.- Parameters:
fileName
- The configuration file.
-
configure
public static void configure(URL configURL)
Reads configuration options from urlconfigURL
.- Parameters:
configURL
- The configuration URL
-
configureAndWatch
public static void configureAndWatch(String configFilename)
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
public static void configureAndWatch(String configFilename, long delayMillis)
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.
-
configureLoggerFactory
protected void configureLoggerFactory(Properties properties)
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.
-
doConfigure
public void doConfigure(InputStream inputStream, LoggerRepository loggerRepository)
Reads configuration options from an InputStream.- Specified by:
doConfigure
in interfaceConfigurator
- Parameters:
inputStream
- The input streamloggerRepository
- The hierarchy
-
doConfigure
public void doConfigure(Properties properties, LoggerRepository loggerRepository)
Reads configuration options fromproperties
. SeedoConfigure(String, LoggerRepository)
for the expected format.- Parameters:
properties
- The propertiesloggerRepository
- The hierarchy
-
doConfigure
public void doConfigure(String fileName, LoggerRepository loggerRepository)
Reads configuration options from configuration file.- Parameters:
fileName
- The configuration fileloggerRepository
- The hierarchy
-
doConfigure
public void doConfigure(URL url, LoggerRepository loggerRepository)
Read configuration options from urlconfigURL
.- Specified by:
doConfigure
in interfaceConfigurator
- Parameters:
url
- The configuration URLloggerRepository
- The hierarchy
-
parseCatsAndRenderers
protected void parseCatsAndRenderers(Properties properties, LoggerRepository loggerRepository)
Parse non-root elements, such non-root categories and renderers.
-
-