com.ebmwebsourcing.easycommons.logger.handler

Class ContextualFileHandler

java.lang.Object

java.util.logging.Handler

java.util.logging.StreamHandler

com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler

public class ContextualFileHandler
extends StreamHandler

Contextual file logging Handler.

The ContextualFileHandler writes the log records in different log files depending on the contextual information.

By default the SimpleFormatter class is used for formatting.

Configuration: By default each ContextualFileHandler is initialized using the following LogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used.

• com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler.level specifies the default level for the Handler (defaults to Level.ALL).
• com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler. formatter specifies the name of a Formatter class to use (defaults to java.util.logging.SimpleFormatter)
• com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler.basedir specifies the path of the base directory for all the log files (defaults to the working directory)
• com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler.subdir specifies the relative path from the base directory to a relative subdirectory containing log file, it may contain placeholders resolved against the current contextual information
• com.ebmwebsourcing.easycommons.logger.handler.ContextualFileHandler. logFilename specifies the simple filename (without any path information) containing logs, it may contain placeholders resolved against the current contextual information (defaults to the file "default.log")

Constructor Summary

Constructors

Modifier	Constructor and Description
	ContextualFileHandler() Construct a default ContextualFileHandler.
protected	ContextualFileHandler(String basedir, String subdir, String logFilename, Properties systemProperties)

Method Summary

Modifier and Type	Method and Description
protected static String	getStringProperty(String name, String defaultValue)
void	publish(LogRecord record) This method overrides the method StreamHandler.publish(LogRecord).

Methods inherited from class java.util.logging.StreamHandler

close, flush, isLoggable, setEncoding, setOutputStream

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextualFileHandler

protected ContextualFileHandler(String basedir,
                                String subdir,
                                String logFilename,
                                Properties systemProperties)

ContextualFileHandler

public ContextualFileHandler()
                      throws IOException,
                             com.ebmwebsourcing.easycommons.properties.PropertiesException

Construct a default ContextualFileHandler. This will be configured entirely from LogManager properties (or their default values).

Throws:

IOException - If the base directory is not set and a the temporary directory could not be created to write the logs

com.ebmwebsourcing.easycommons.properties.PropertiesException - If an error occurs when resolving a place holder in the base directory properties

Method Detail

publish

public void publish(LogRecord record)

This method overrides the method StreamHandler.publish(LogRecord). It gets the file to publish the log record by resolving the place holders present in the path pattern according the execution context before calling the inherited method StreamHandler.publish(LogRecord).

Overrides:

publish in class StreamHandler

getStringProperty

protected static final String getStringProperty(String name,
                                                String defaultValue)