blob: 640d6ba40bc5da70c17a095c5e1928b99ef0b797 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.jul;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Collections;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Enumeration;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashSet;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.logging.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.LoggingException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Log4j implementation of {@link java.util.logging.LogManager}. Note that the system property<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@code java.util.logging.manager} must be set to {@code org.apache.logging.log4j.jul.LogManager} in order to use<a name="line.32"></a>
<span class="sourceLineNo">033</span> * this adaptor. This LogManager requires the {@code log4j-api} library to be available. If {@code log4j-core} is<a name="line.33"></a>
<span class="sourceLineNo">034</span> * also available, then more features of {@link java.util.logging.Logger} are supported.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;To override the default {@link AbstractLoggerAdapter} that is used, specify the Log4j property<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@code log4j.jul.LoggerAdapter} and set it to the fully qualified class name of a custom<a name="line.37"></a>
<span class="sourceLineNo">038</span> * implementation. All implementations must have a default constructor.&lt;/p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 2.1<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class LogManager extends java.util.logging.LogManager {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final org.apache.logging.log4j.Logger LOGGER = StatusLogger.getLogger();<a name="line.44"></a>
<span class="sourceLineNo">045</span> private final AbstractLoggerAdapter loggerAdapter;<a name="line.45"></a>
<span class="sourceLineNo">046</span> // Contains the set of logger names that are actively being requested using getLogger.<a name="line.46"></a>
<span class="sourceLineNo">047</span> private final ThreadLocal&lt;Set&lt;String&gt;&gt; recursive = ThreadLocal.withInitial(HashSet::new);<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public LogManager() {<a name="line.49"></a>
<span class="sourceLineNo">050</span> super();<a name="line.50"></a>
<span class="sourceLineNo">051</span> AbstractLoggerAdapter adapter = null;<a name="line.51"></a>
<span class="sourceLineNo">052</span> final String overrideAdaptorClassName =<a name="line.52"></a>
<span class="sourceLineNo">053</span> PropertiesUtil.getProperties().getStringProperty(Constants.LOGGER_ADAPTOR_PROPERTY);<a name="line.53"></a>
<span class="sourceLineNo">054</span> if (overrideAdaptorClassName != null) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> try {<a name="line.55"></a>
<span class="sourceLineNo">056</span> LOGGER.info("Trying to use LoggerAdaptor [{}] specified by Log4j property.", overrideAdaptorClassName);<a name="line.56"></a>
<span class="sourceLineNo">057</span> adapter = LoaderUtil.newCheckedInstanceOf(overrideAdaptorClassName, AbstractLoggerAdapter.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span> } catch (final Exception e) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> LOGGER.error("Specified LoggerAdapter [{}] is incompatible.", overrideAdaptorClassName, e);<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span> if (adapter == null) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> // default adapter<a name="line.63"></a>
<span class="sourceLineNo">064</span> String adapterClassName;<a name="line.64"></a>
<span class="sourceLineNo">065</span> try {<a name="line.65"></a>
<span class="sourceLineNo">066</span> // find out if log4j-core is available<a name="line.66"></a>
<span class="sourceLineNo">067</span> LoaderUtil.loadClass(Constants.CORE_LOGGER_CLASS_NAME);<a name="line.67"></a>
<span class="sourceLineNo">068</span> adapterClassName = Constants.CORE_LOGGER_ADAPTER_CLASS_NAME;<a name="line.68"></a>
<span class="sourceLineNo">069</span> } catch (final ClassNotFoundException ignored) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> adapterClassName = Constants.API_LOGGER_ADAPTER_CLASS_NAME;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span> LOGGER.debug("Attempting to use {}", adapterClassName);<a name="line.72"></a>
<span class="sourceLineNo">073</span> try {<a name="line.73"></a>
<span class="sourceLineNo">074</span> adapter = LoaderUtil.newCheckedInstanceOf(adapterClassName, AbstractLoggerAdapter.class);<a name="line.74"></a>
<span class="sourceLineNo">075</span> } catch (final Exception e) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> throw LOGGER.throwing(new LoggingException(e));<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> loggerAdapter = adapter;<a name="line.79"></a>
<span class="sourceLineNo">080</span> LOGGER.info("Registered Log4j as the java.util.logging.LogManager.");<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> @Override<a name="line.83"></a>
<span class="sourceLineNo">084</span> public boolean addLogger(final Logger logger) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> // in order to prevent non-bridged loggers from being registered, we always return false to indicate that<a name="line.85"></a>
<span class="sourceLineNo">086</span> // the named logger should be obtained through getLogger(name)<a name="line.86"></a>
<span class="sourceLineNo">087</span> return false;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span> public Logger getLogger(final String name) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> LOGGER.trace("Call to LogManager.getLogger({})", name);<a name="line.92"></a>
<span class="sourceLineNo">093</span> Set&lt;String&gt; activeRequests = recursive.get();<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (activeRequests.add(name)) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> try {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return loggerAdapter.getLogger(name);<a name="line.96"></a>
<span class="sourceLineNo">097</span> } finally {<a name="line.97"></a>
<span class="sourceLineNo">098</span> activeRequests.remove(name);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> } else {<a name="line.100"></a>
<span class="sourceLineNo">101</span> LOGGER.warn("Recursive call to getLogger for {} ignored.", name);<a name="line.101"></a>
<span class="sourceLineNo">102</span> return new NoOpLogger(name);<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public Enumeration&lt;String&gt; getLoggerNames() {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return Collections.enumeration(loggerAdapter.getLoggersInContext(loggerAdapter.getContext()).keySet());<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>}<a name="line.111"></a>
</pre>
</div>
</body>
</html>