org.nuxeo.log4j

Class Log4JHelper

java.lang.Object

org.nuxeo.log4j.Log4JHelper

public class Log4JHelper
extends Object

Provides helper methods for working with log4j

Since:

5.4.2

Author:

jcarsique

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSOLE_APPENDER_NAME

Constructor Summary

Constructors

Constructor and Description
Log4JHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static ArrayList<String>	getFileAppendersFiles(File log4jConfigurationFile)
static ArrayList<String>	getFileAppendersFiles(org.apache.log4j.spi.LoggerRepository loggerRepository) Returns list of files produced by FileAppenders defined in a given LoggerRepository.
static org.apache.log4j.spi.LoggerRepository	getNewLoggerRepository(File log4jConfigurationFile) Creates a LoggerRepository initialized with given log4j configuration file without making this configuration active.
static void	setDebug(String category, boolean debug) Set DEBUG level on the given category and change pattern layout of CONSOLE_APPENDER_NAME if defined.
static void	setDebug(String categories, boolean debug, boolean includeChildren, String[] appenderNames) Set DEBUG level on the given category and the children categories.
static void	setQuiet(String appenderName) Set "quiet" mode: set log level to WARN for the given Log4J appender.

Methods inherited from class java.lang.Object

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

Field Detail

CONSOLE_APPENDER_NAME

public static final String CONSOLE_APPENDER_NAME

See Also:

Constant Field Values

Constructor Detail

Log4JHelper

public Log4JHelper()

Method Detail

getFileAppendersFiles

public static ArrayList<String> getFileAppendersFiles(org.apache.log4j.spi.LoggerRepository loggerRepository)

Returns list of files produced by FileAppenders defined in a given LoggerRepository. There's no need for the log4j configuration corresponding to this repository of being active.

Parameters:

loggerRepository - LoggerRepository to browse looking for FileAppender

Returns:

FileAppenders configured in loggerRepository

getNewLoggerRepository

public static org.apache.log4j.spi.LoggerRepository getNewLoggerRepository(File log4jConfigurationFile)

Creates a LoggerRepository initialized with given log4j configuration file without making this configuration active.

Parameters:

log4jConfigurationFile - XML Log4J configuration file to load.

Returns:

LoggerRepository initialized with log4jConfigurationFile

getFileAppendersFiles

public static ArrayList<String> getFileAppendersFiles(File log4jConfigurationFile)

Parameters:

log4jConfigurationFile -

Returns:

FileAppenders defined in log4jConfigurationFile

See Also:

getFileAppendersFiles(LoggerRepository)

setDebug

public static void setDebug(String categories,
            boolean debug,
            boolean includeChildren,
            String[] appenderNames)

Set DEBUG level on the given category and the children categories. Also change the pattern layout of the given appenderName.

Parameters:

categories - Log4J categories for which to switch debug log level (comma separated values)

debug - set debug log level to true or false

includeChildren - Also set/unset debug mode on children categories

appenderNames - Appender names on which to set a detailed pattern layout. Ignored if null.

Since:

5.6

setDebug

public static void setDebug(String category,
            boolean debug)

Set DEBUG level on the given category and change pattern layout of CONSOLE_APPENDER_NAME if defined. Children categories are unchanged.

Parameters:

category - Log4J category for which to switch debug log level

debug - set debug log level to true or false

Since:

5.5

See Also:

#setDebug(String, boolean, boolean, String)

setQuiet

public static void setQuiet(String appenderName)

Set "quiet" mode: set log level to WARN for the given Log4J appender.

Parameters:

appenderName - Log4J appender to switch to WARN

Since:

5.5