broadwick

Class LoggingFacade

java.lang.Object

broadwick.LoggingFacade

public final class LoggingFacade
extends Object

Facade class to the underlying logger to allow the loggers to be configured programmatically.

Field Summary

Fields

Modifier and Type	Field and Description
private String	logFormatThreadMsg
private ch.qos.logback.classic.LoggerContext	loggerContext
private ch.qos.logback.classic.Logger	rootLogger

Constructor Summary

Constructors

Constructor and Description
LoggingFacade() Create the logging facade, by default adding a console logger to output logging info to the screen (console).

Method Summary

Modifier and Type	Method and Description
void	addConsoleLogger(String level, String pattern) Add a console logger to the list of loggers of the project.
void	addFileLogger(String file, String level, String pattern, Boolean overwrite) Add a file logger to the list of loggers of the project.
private ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>	createPatternLayoutEncoder(String pattern) Create a pattern layout encoder for a given pattern.
private ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent>	createThresholdFilter(String level) Create a thresholdFilter for a given level.
private void	setLoggingLevel(String level) Convert the string passed as argument to a Level.

Methods inherited from class java.lang.Object

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

Field Detail

rootLogger

private ch.qos.logback.classic.Logger rootLogger

loggerContext

private ch.qos.logback.classic.LoggerContext loggerContext

logFormatThreadMsg

private String logFormatThreadMsg

Constructor Detail

LoggingFacade

public LoggingFacade()

Create the logging facade, by default adding a console logger to output logging info to the screen (console). A level of 'error' is configured by default, once the configuration file is read the logging level can be changed.

Method Detail

addConsoleLogger

public void addConsoleLogger(String level,
                             String pattern)

Add a console logger to the list of loggers of the project. This will replace all the console loggers already added using this method.

Parameters:

level - the logging level to be applied.

pattern - the pattern for the logger.

addFileLogger

public void addFileLogger(String file,
                          String level,
                          String pattern,
                          Boolean overwrite)

Add a file logger to the list of loggers of the project.

Parameters:

file - the name of the file to which the logging messages will be added.

level - the logging level to be applied.

pattern - the pattern for the logger.

overwrite - if true, the contents of any previous log are overwritten. If false, the logs are appended.

createPatternLayoutEncoder

private ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> createPatternLayoutEncoder(String pattern)

Create a pattern layout encoder for a given pattern.

Parameters:

pattern - the pattern to apply.

Returns:

the created encoder.

createThresholdFilter

private ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent> createThresholdFilter(String level)

Create a thresholdFilter for a given level.

Parameters:

level - the level to set.

Returns:

the created filter.

setLoggingLevel

private void setLoggingLevel(String level)

Convert the string passed as argument to a Level. If the conversion fails, then this method returns Level.DEBUG.

Parameters:

level - the logging level that should be used.