001/**
002 * Copyright (c) 2004-2011 QOS.ch
003 * All rights reserved.
004 *
005 * Permission is hereby granted, free  of charge, to any person obtaining
006 * a  copy  of this  software  and  associated  documentation files  (the
007 * "Software"), to  deal in  the Software without  restriction, including
008 * without limitation  the rights to  use, copy, modify,  merge, publish,
009 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
010 * permit persons to whom the Software  is furnished to do so, subject to
011 * the following conditions:
012 *
013 * The  above  copyright  notice  and  this permission  notice  shall  be
014 * included in all copies or substantial portions of the Software.
015 *
016 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
017 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
018 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
020 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
021 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
022 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
023 *
024 */
025package org.slf4j.bridge;
026
027import java.text.MessageFormat;
028import java.util.MissingResourceException;
029import java.util.ResourceBundle;
030import java.util.logging.Handler;
031import java.util.logging.Level;
032import java.util.logging.LogManager;
033import java.util.logging.LogRecord;
034
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037import org.slf4j.spi.LocationAwareLogger;
038
039// Based on http://jira.qos.ch/browse/SLF4J-30
040
041/**
042 * <p>Bridge/route all JUL log records to the SLF4J API.
043 * <p>Essentially, the idea is to install on the root logger an instance of
044 * <code>SLF4JBridgeHandler</code> as the sole JUL handler in the system. Subsequently, the
045 * SLF4JBridgeHandler instance will redirect all JUL log records are redirected
046 * to the SLF4J API based on the following mapping of levels:
047 * 
048 * <pre>
049 * FINEST  -&gt; TRACE
050 * FINER   -&gt; DEBUG
051 * FINE    -&gt; DEBUG
052 * INFO    -&gt; INFO
053 * WARNING -&gt; WARN
054 * SEVERE  -&gt; ERROR</pre>
055 * <p><b>Programmatic installation:</b>
056 * <pre>
057 * // Optionally remove existing handlers attached to j.u.l root logger
058 * SLF4JBridgeHandler.removeHandlersForRootLogger();  // (since SLF4J 1.6.5)
059
060 * // add SLF4JBridgeHandler to j.u.l's root logger, should be done once during
061 * // the initialization phase of your application
062 * SLF4JBridgeHandler.install();</pre>
063 * <p><b>Installation via <em>logging.properties</em> configuration file:</b>
064 * <pre>
065 * // register SLF4JBridgeHandler as handler for the j.u.l. root logger
066 * handlers = org.slf4j.bridge.SLF4JBridgeHandler</pre>
067 * <p>Once SLF4JBridgeHandler is installed, logging by j.u.l. loggers will be directed to
068 * SLF4J. Example: 
069 * <pre>
070 * import  java.util.logging.Logger;
071 * ...
072 * // usual pattern: get a Logger and then log a message
073 * Logger julLogger = Logger.getLogger(&quot;org.wombat&quot;);
074 * julLogger.fine(&quot;hello world&quot;); // this will get redirected to SLF4J</pre>
075 *
076 * <p>Please note that translating a java.util.logging event into SLF4J incurs the
077 * cost of constructing {@link LogRecord} instance regardless of whether the
078 * SLF4J logger is disabled for the given level. <b>Consequently, j.u.l. to
079 * SLF4J translation can seriously increase the cost of disabled logging
080 * statements (60 fold or 6000% increase) and measurably impact the performance of enabled log
081 * statements (20% overall increase).</b> Please note that as of logback-version 0.9.25,
082 * it is possible to completely eliminate the 60 fold translation overhead for disabled
083 * log statements with the help of <a href="http://logback.qos.ch/manual/configuration.html#LevelChangePropagator">LevelChangePropagator</a>.
084 * 
085 *
086 * <p>If you are concerned about application performance, then use of <code>SLF4JBridgeHandler</code>
087 * is appropriate only if any one the following two conditions is true:
088 * <ol>
089 * <li>few j.u.l. logging statements are in play</li>
090 * <li>LevelChangePropagator has been installed</li>
091 * </ol>
092 *
093 * <h2>As a Java 9/Jigsaw module</h2>
094 * 
095 * <p>Given that <b>to</b> is a reserved keyword under Java 9 within module productions, 
096 * the MAFIFEST.MF file in <em>jul-to-slf4j.jar</em> declares <b>jul_to_slf4j</b> as 
097 * its Automatic Module Name. Thus, if your application is Jigsaw modularized, the requires 
098 * statement in your <em>module-info.java</em> needs to be <b>jul_to_slf4j</b> 
099 * (note the two underscores).
100 *
101 * 
102 * @author Christian Stein
103 * @author Joern Huxhorn
104 * @author Ceki G&uuml;lc&uuml;
105 * @author Darryl Smith
106 * @since 1.5.1
107 */
108public class SLF4JBridgeHandler extends Handler {
109
110    // The caller is java.util.logging.Logger
111    private static final String FQCN = java.util.logging.Logger.class.getName();
112    private static final String UNKNOWN_LOGGER_NAME = "unknown.jul.logger";
113
114    private static final int TRACE_LEVEL_THRESHOLD = Level.FINEST.intValue();
115    private static final int DEBUG_LEVEL_THRESHOLD = Level.FINE.intValue();
116    private static final int INFO_LEVEL_THRESHOLD = Level.INFO.intValue();
117    private static final int WARN_LEVEL_THRESHOLD = Level.WARNING.intValue();
118
119    /**
120     * Adds a SLF4JBridgeHandler instance to jul's root logger.
121     * 
122     * <p>This handler will redirect j.u.l. logging to SLF4J. However, only logs enabled
123     * in j.u.l. will be redirected. For example, if a log statement invoking a
124     * j.u.l. logger is disabled, then the corresponding non-event will <em>not</em>
125     * reach SLF4JBridgeHandler and cannot be redirected.
126     */
127    public static void install() {
128        LogManager.getLogManager().getLogger("").addHandler(new SLF4JBridgeHandler());
129    }
130
131    private static java.util.logging.Logger getRootLogger() {
132        return LogManager.getLogManager().getLogger("");
133    }
134
135    /**
136     * Removes previously installed SLF4JBridgeHandler instances. See also
137     * {@link #install()}.
138     *
139     * @throws SecurityException A <code>SecurityException</code> is thrown, if a security manager
140     *                           exists and if the caller does not have
141     *                           LoggingPermission("control").
142     */
143    public static void uninstall() throws SecurityException {
144        java.util.logging.Logger rootLogger = getRootLogger();
145        Handler[] handlers = rootLogger.getHandlers();
146        for (int i = 0; i < handlers.length; i++) {
147            if (handlers[i] instanceof SLF4JBridgeHandler) {
148                rootLogger.removeHandler(handlers[i]);
149            }
150        }
151    }
152
153    /**
154     * Returns true if SLF4JBridgeHandler has been previously installed, returns false otherwise.
155     *
156     * @return true if SLF4JBridgeHandler is already installed, false other wise
157     *
158     */
159    public static boolean isInstalled()  {
160        java.util.logging.Logger rootLogger = getRootLogger();
161        Handler[] handlers = rootLogger.getHandlers();
162        for (int i = 0; i < handlers.length; i++) {
163            if (handlers[i] instanceof SLF4JBridgeHandler) {
164                return true;
165            }
166        }
167        return false;
168    }
169
170    /**
171     * Invoking this method removes/unregisters/detaches all handlers currently attached to the root logger
172     * @since 1.6.5
173     */
174    public static void removeHandlersForRootLogger() {
175        java.util.logging.Logger rootLogger = getRootLogger();
176        java.util.logging.Handler[] handlers = rootLogger.getHandlers();
177        for (int i = 0; i < handlers.length; i++) {
178            rootLogger.removeHandler(handlers[i]);
179        }
180    }
181
182    /**
183     * Initialize this handler.
184     */
185    public SLF4JBridgeHandler() {
186    }
187
188    /**
189     * No-op implementation.
190     */
191    public void close() {
192        // empty
193    }
194
195    /**
196     * No-op implementation.
197     */
198    public void flush() {
199        // empty
200    }
201
202    /**
203     * Return the Logger instance that will be used for logging.
204     * 
205     * @param record a LogRecord
206     * @return an SLF4J logger corresponding to the record parameter's logger name
207     */
208    protected Logger getSLF4JLogger(LogRecord record) {
209        String name = record.getLoggerName();
210        if (name == null) {
211            name = UNKNOWN_LOGGER_NAME;
212        }
213        return LoggerFactory.getLogger(name);
214    }
215
216    protected void callLocationAwareLogger(LocationAwareLogger lal, LogRecord record) {
217        int julLevelValue = record.getLevel().intValue();
218        int slf4jLevel;
219
220        if (julLevelValue <= TRACE_LEVEL_THRESHOLD) {
221            slf4jLevel = LocationAwareLogger.TRACE_INT;
222        } else if (julLevelValue <= DEBUG_LEVEL_THRESHOLD) {
223            slf4jLevel = LocationAwareLogger.DEBUG_INT;
224        } else if (julLevelValue <= INFO_LEVEL_THRESHOLD) {
225            slf4jLevel = LocationAwareLogger.INFO_INT;
226        } else if (julLevelValue <= WARN_LEVEL_THRESHOLD) {
227            slf4jLevel = LocationAwareLogger.WARN_INT;
228        } else {
229            slf4jLevel = LocationAwareLogger.ERROR_INT;
230        }
231        String i18nMessage = getMessageI18N(record);
232        lal.log(null, FQCN, slf4jLevel, i18nMessage, null, record.getThrown());
233    }
234
235    protected void callPlainSLF4JLogger(Logger slf4jLogger, LogRecord record) {
236        String i18nMessage = getMessageI18N(record);
237        int julLevelValue = record.getLevel().intValue();
238        if (julLevelValue <= TRACE_LEVEL_THRESHOLD) {
239            slf4jLogger.trace(i18nMessage, record.getThrown());
240        } else if (julLevelValue <= DEBUG_LEVEL_THRESHOLD) {
241            slf4jLogger.debug(i18nMessage, record.getThrown());
242        } else if (julLevelValue <= INFO_LEVEL_THRESHOLD) {
243            slf4jLogger.info(i18nMessage, record.getThrown());
244        } else if (julLevelValue <= WARN_LEVEL_THRESHOLD) {
245            slf4jLogger.warn(i18nMessage, record.getThrown());
246        } else {
247            slf4jLogger.error(i18nMessage, record.getThrown());
248        }
249    }
250
251    /**
252     * Get the record's message, possibly via a resource bundle.
253     *
254     * @param record
255     * @return
256     */
257    private String getMessageI18N(LogRecord record) {
258        String message = record.getMessage();
259
260        if (message == null) {
261            return null;
262        }
263
264        ResourceBundle bundle = record.getResourceBundle();
265        if (bundle != null) {
266            try {
267                message = bundle.getString(message);
268            } catch (MissingResourceException e) {
269            }
270        }
271        Object[] params = record.getParameters();
272        // avoid formatting when there are no or 0 parameters. see also
273        // http://jira.qos.ch/browse/SLF4J-203
274        if (params != null && params.length > 0) {
275            try {
276                message = MessageFormat.format(message, params);
277            } catch (IllegalArgumentException e) {
278                // default to the same behavior as in java.util.logging.Formatter.formatMessage(LogRecord)
279                // see also http://jira.qos.ch/browse/SLF4J-337
280                return message;
281            }
282        }
283        return message;
284    }
285
286    /**
287     * Publish a LogRecord.
288     * <p>
289     * The logging request was made initially to a Logger object, which
290     * initialized the LogRecord and forwarded it here.
291     * <p>
292     * This handler ignores the Level attached to the LogRecord, as SLF4J cares
293     * about discarding log statements.
294     *
295     * @param record Description of the log event. A null record is silently ignored
296     *               and is not published.
297     */
298    public void publish(LogRecord record) {
299        // Silently ignore null records.
300        if (record == null) {
301            return;
302        }
303
304        Logger slf4jLogger = getSLF4JLogger(record);
305        // this is a check to avoid calling the underlying logging system
306        // with a null message. While it is legitimate to invoke j.u.l. with
307        // a null message, other logging frameworks do not support this.
308        // see also http://jira.qos.ch/browse/SLF4J-99
309        if (record.getMessage() == null) {
310            record.setMessage("");
311        }
312        if (slf4jLogger instanceof LocationAwareLogger) {
313            callLocationAwareLogger((LocationAwareLogger) slf4jLogger, record);
314        } else {
315            callPlainSLF4JLogger(slf4jLogger, record);
316        }
317    }
318
319}