Package org.jboss.logmanager
Class PropertyConfigurator
- java.lang.Object
-
- org.jboss.logmanager.PropertyConfigurator
-
- All Implemented Interfaces:
Configurator
public final class PropertyConfigurator extends Object implements Configurator
A configurator which uses a simple property file format.
-
-
Field Summary
-
Fields inherited from interface org.jboss.logmanager.Configurator
ATTACHMENT_KEY
-
-
Constructor Summary
Constructors Constructor Description PropertyConfigurator()
Construct an instance.PropertyConfigurator(LogContext context)
Construct a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
configure(InputStream inputStream)
Configure the logmanager.void
configure(Properties properties)
Configure the log manager from the given properties.LogContextConfiguration
getLogContextConfiguration()
Get the log context configuration.void
writeConfiguration(OutputStream outputStream)
Writes the current configuration to the output stream.void
writeConfiguration(OutputStream outputStream, boolean writeExpressions)
Writes the current configuration to the output stream.
-
-
-
Constructor Detail
-
PropertyConfigurator
public PropertyConfigurator()
Construct an instance.
-
PropertyConfigurator
public PropertyConfigurator(LogContext context)
Construct a new instance.- Parameters:
context
- the log context to be configured
-
-
Method Detail
-
getLogContextConfiguration
public LogContextConfiguration getLogContextConfiguration()
Get the log context configuration. WARNING: this instance is not thread safe in any way. The returned object should never be used from more than one thread at a time; furthermore thewriteConfiguration(java.io.OutputStream)
method also accesses this object directly.- Returns:
- the log context configuration instance
-
configure
public void configure(InputStream inputStream) throws IOException
Configure the logmanager.- Specified by:
configure
in interfaceConfigurator
- Parameters:
inputStream
- the input stream to read- Throws:
IOException
- if an error occurs
-
writeConfiguration
public void writeConfiguration(OutputStream outputStream) throws IOException
Writes the current configuration to the output stream. Note: the output stream will be closed.- Parameters:
outputStream
- the output stream to write to.- Throws:
IOException
- if an error occurs while writing the configuration.
-
writeConfiguration
public void writeConfiguration(OutputStream outputStream, boolean writeExpressions) throws IOException
Writes the current configuration to the output stream. Note: the output stream will be closed.- Parameters:
outputStream
- the output stream to write to.writeExpressions
-true
if expressions should be written,false
if the resolved value should be written- Throws:
IOException
- if an error occurs while writing the configuration.
-
configure
public void configure(Properties properties) throws IOException
Configure the log manager from the given properties. The following values read in from a configuration will be trimmed of prefixed and trailing whitespace:- logger.NAME.filter
- logger.NAME.level
- logger.NAME.useParentHandlers
- handler.NAME.filter
- handler.NAME.formatter
- handler.NAME.level
- handler.NAME.encoding
- handler.NAME.errorManager
written
the trimmed values will be written for the above properties.- Parameters:
properties
- the properties- Throws:
IOException
- if an error occurs
-
-