org.apache.logging.log4j.jul

Class Log4jBridgeHandler

java.lang.Object

java.util.logging.Handler

org.apache.logging.log4j.jul.Log4jBridgeHandler

public class Log4jBridgeHandler
extends Handler

Bridge from JUL to log4j2. This is an alternative to log4j.jul.LogManager (running as complete JUL replacement), especially useful for webapps running on a container for which the LogManager can or should not be used. Installation/usage: - programmatically by calling install() method, e.g. inside ServletContextListener static-class-init. or contextInitialized() - declaratively inside JUL's logging.properties: handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler (note: in a webapp running on Tomcat, you may create a WEB-INF/classes/logging.properties file to configure JUL for this webapp only) Configuration (in logging.properties): - Log4jBridgeHandler.suffixToAppend String, suffix to append to JUL logger names, to easily recognize bridged log messages. A dot "." is automatically prepended, so configuration for the basis logger is used Example: suffixToAppend = _JUL - Log4jBridgeHandler.propagateLevels boolean, "true" to automatically propagate log4j log levels to JUL. - Log4jBridgeHandler.sysoutDebug boolean Restrictions: - Manually given source/location info in JUL (e.g. entering(), exiting(), throwing(), logp(), logrb() ) will NOT be considered, i.e. gets lost in log4j logging. TODO: performance note; log level propagation

Author:

Thies Wellpott (twapache@online.de), authors of original org.slf4j.bridge.SLF4JBridgeHandler (ideas and some basis from there), authors of original ch.qos.logback.classic.jul.LevelChangePropagator (ideas and some basis from there)

Constructor Summary

Constructors

Constructor and Description
Log4jBridgeHandler() Initialize this handler.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
protected Logger	getLog4jLogger(LogRecord record) Return the Logger instance that will be used for logging.
static void	install(boolean removeHandlersForRootLogger) Adds a Log4jBridgeHandler instance to JUL's root logger.
void	publish(LogRecord record)

Methods inherited from class java.util.logging.Handler

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4jBridgeHandler

public Log4jBridgeHandler()

Initialize this handler. Read out configuration.

Method Detail

install

public static void install(boolean removeHandlersForRootLogger)

Adds a Log4jBridgeHandler instance to JUL's root logger. This is a programmatic alternative to specify "handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler" in logging.properties. This handler will redirect JUL logging to log4j2. However, only logs enabled in JUL will be redirected. For example, if a log statement invoking a JUL logger is disabled, then the corresponding non-event will not reach Log4jBridgeHandler and cannot be redirected.

Parameters:

removeHandlersForRootLogger - remove all other installed handlers on JUL root level

close

public void close()

Specified by:

close in class Handler

publish

public void publish(LogRecord record)

Specified by:

publish in class Handler

flush

public void flush()

Specified by:

flush in class Handler

getLog4jLogger

protected Logger getLog4jLogger(LogRecord record)

Return the Logger instance that will be used for logging. Handles null name case and appends configured suffix.