| <!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.core;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import static org.apache.logging.log4j.core.util.ShutdownCallbackRegistry.SHUTDOWN_HOOK_MARKER;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.beans.PropertyChangeEvent;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.beans.PropertyChangeListener;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.File;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.net.URI;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Objects;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentMap;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.concurrent.CopyOnWriteArrayList;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.concurrent.TimeUnit;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.concurrent.locks.Lock;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.concurrent.locks.ReentrantLock;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.LogManager;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.ConfigurationFactory;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.ConfigurationListener;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.ConfigurationSource;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.DefaultConfiguration;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.config.NullConfiguration;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.impl.Log4jLogEvent;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.core.jmx.Server;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.core.util.Cancellable;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.logging.log4j.core.util.ExecutorServices;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.logging.log4j.core.util.NetUtils;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.logging.log4j.core.util.ShutdownCallbackRegistry;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.logging.log4j.message.MessageFactory;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.logging.log4j.spi.AbstractLogger;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.logging.log4j.spi.LoggerContextShutdownAware;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.logging.log4j.spi.LoggerContextShutdownEnabled;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>import org.apache.logging.log4j.spi.LoggerRegistry;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.logging.log4j.spi.Terminable;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.logging.log4j.spi.ThreadContextMapFactory;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span>/**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * The LoggerContext is the anchor for the logging system. It maintains a list of all the loggers requested by<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * applications and a reference to the Configuration. The Configuration will contain the configured loggers, appenders,<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * filters, etc and will be atomically updated whenever a reconfigure occurs.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>public class LoggerContext extends AbstractLifeCycle<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> implements org.apache.logging.log4j.spi.LoggerContext, AutoCloseable, Terminable, ConfigurationListener,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> LoggerContextShutdownEnabled {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> static {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> try {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> // LOG4J2-1642 preload ExecutorServices as it is used in shutdown hook<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> Loader.loadClass(ExecutorServices.class.getName());<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> } catch (final Exception e) {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> LOGGER.error("Failed to preload ExecutorServices class.", e);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> }<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Property name of the property change event fired if the configuration is changed.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static final String PROPERTY_CONFIG = "config";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private static final Configuration NULL_CONFIGURATION = new NullConfiguration();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private final LoggerRegistry<Logger> loggerRegistry = new LoggerRegistry<>();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private final CopyOnWriteArrayList<PropertyChangeListener> propertyChangeListeners = new CopyOnWriteArrayList<>();<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private volatile List<LoggerContextShutdownAware> listeners = null;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * The Configuration is volatile to guarantee that initialization of the Configuration has completed before the<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * reference is updated.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> private volatile Configuration configuration = new DefaultConfiguration();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> private static final String EXTERNAL_CONTEXT_KEY = "__EXTERNAL_CONTEXT_KEY__";<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private ConcurrentMap<String, Object> externalMap = new ConcurrentHashMap<>();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> private String contextName;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> private volatile URI configLocation;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> private Cancellable shutdownCallback;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> private final Lock configLock = new ReentrantLock();<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> * Constructor taking only a name.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param name The context name.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public LoggerContext(final String name) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> this(name, null, (URI) null);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Constructor taking a name and a reference to an external context.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param name The context name.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param externalContext The external context.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> public LoggerContext(final String name, final Object externalContext) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> this(name, externalContext, (URI) null);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Constructor taking a name, external context and a configuration URI.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> *<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @param name The context name.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param externalContext The external context.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param configLocn The location of the configuration as a URI.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public LoggerContext(final String name, final Object externalContext, final URI configLocn) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> this.contextName = name;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (externalContext == null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> externalMap.remove(EXTERNAL_CONTEXT_KEY);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> } else {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> externalMap.put(EXTERNAL_CONTEXT_KEY, externalContext);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> this.configLocation = configLocn;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> /**<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * Constructor taking a name external context and a configuration location String. The location must be resolvable<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * to a File.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @param name The configuration location.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @param externalContext The external context.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @param configLocn The configuration location.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> */<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> public LoggerContext(final String name, final Object externalContext, final String configLocn) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> this.contextName = name;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> if (externalContext == null) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> externalMap.remove(EXTERNAL_CONTEXT_KEY);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> } else {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> externalMap.put(EXTERNAL_CONTEXT_KEY, externalContext);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> if (configLocn != null) {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> URI uri;<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> try {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> uri = new File(configLocn).toURI();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> } catch (final Exception ex) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> uri = null;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> configLocation = uri;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> } else {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> configLocation = null;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public void addShutdownListener(LoggerContextShutdownAware listener) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (listeners == null) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> synchronized(this) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (listeners == null) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> listeners = Collections.synchronizedList(new ArrayList<LoggerContextShutdownAware>());<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> listeners.add(listener);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public List<LoggerContextShutdownAware> getListeners() {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return listeners;<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * Returns the current LoggerContext.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <p><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * Avoids the type cast for:<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * </p><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * <pre><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * (LoggerContext) LogManager.getContext();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * </pre><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> *<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * <p><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * WARNING - The LoggerContext returned by this method may not be the LoggerContext used to create a Logger for the<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * calling class.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * </p><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> *<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @return The current LoggerContext.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @see LogManager#getContext()<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> */<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> public static LoggerContext getContext() {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return (LoggerContext) LogManager.getContext();<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> /**<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * Returns a LoggerContext.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * <p><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * Avoids the type cast for:<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * </p><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> *<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * <pre><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * (LoggerContext) LogManager.getContext(currentContext);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * </pre><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> *<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @return a LoggerContext.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @see LogManager#getContext(boolean)<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> */<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> public static LoggerContext getContext(final boolean currentContext) {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> return (LoggerContext) LogManager.getContext(currentContext);<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span><a name="line.226"></a> |
| <span class="sourceLineNo">227</span> /**<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * Returns a LoggerContext.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * <p><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Avoids the type cast for:<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * </p><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> *<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * <pre><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * (LoggerContext) LogManager.getContext(loader, currentContext, configLocation);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * </pre><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> *<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * ClassLoader.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param configLocation The URI for the configuration to use.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @return a LoggerContext.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @see LogManager#getContext(ClassLoader, boolean, URI)<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> */<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> final URI configLocation) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> return (LoggerContext) LogManager.getContext(loader, currentContext, configLocation);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> @Override<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> public void start() {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> LOGGER.debug("Starting LoggerContext[name={}, {}]...", getName(), this);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> if (PropertiesUtil.getProperties().getBooleanProperty("log4j.LoggerContext.stacktrace.on.start", false)) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> LOGGER.debug("Stack trace to locate invoker",<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> new Exception("Not a real error, showing stack trace to locate invoker"));<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> if (configLock.tryLock()) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> try {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> if (this.isInitialized() || this.isStopped()) {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> this.setStarting();<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> reconfigure();<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (this.configuration.isShutdownHookEnabled()) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> setUpShutdownHook();<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> this.setStarted();<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> } finally {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> configLock.unlock();<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> }<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> LOGGER.debug("LoggerContext[name={}, {}] started OK.", getName(), this);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> /**<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * Starts with a specific configuration.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> *<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * @param config The new Configuration.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> */<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public void start(final Configuration config) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> LOGGER.debug("Starting LoggerContext[name={}, {}] with configuration {}...", getName(), this, config);<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> if (configLock.tryLock()) {<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> try {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> if (this.isInitialized() || this.isStopped()) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> if (this.configuration.isShutdownHookEnabled()) {<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> setUpShutdownHook();<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> }<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> this.setStarted();<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> } finally {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> configLock.unlock();<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> setConfiguration(config);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> LOGGER.debug("LoggerContext[name={}, {}] started OK with configuration {}.", getName(), this, config);<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> }<a name="line.297"></a> |
| <span class="sourceLineNo">298</span><a name="line.298"></a> |
| <span class="sourceLineNo">299</span> private void setUpShutdownHook() {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> if (shutdownCallback == null) {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> final LoggerContextFactory factory = LogManager.getFactory();<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> if (factory instanceof ShutdownCallbackRegistry) {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> LOGGER.debug(SHUTDOWN_HOOK_MARKER, "Shutdown hook enabled. Registering a new one.");<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> try {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> final long shutdownTimeoutMillis = this.configuration.getShutdownTimeoutMillis();<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> this.shutdownCallback = ((ShutdownCallbackRegistry) factory).addShutdownCallback(new Runnable() {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> @Override<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> public void run() {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> @SuppressWarnings("resource")<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> final LoggerContext context = LoggerContext.this;<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> LOGGER.debug(SHUTDOWN_HOOK_MARKER, "Stopping LoggerContext[name={}, {}]",<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> context.getName(), context);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> context.stop(shutdownTimeoutMillis, TimeUnit.MILLISECONDS);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> @Override<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> public String toString() {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> return "Shutdown callback for LoggerContext[name=" + LoggerContext.this.getName() + ']';<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> }<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> });<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> } catch (final IllegalStateException e) {<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> throw new IllegalStateException(<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> "Unable to register Log4j shutdown hook because JVM is shutting down.", e);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> } catch (final SecurityException e) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> LOGGER.error(SHUTDOWN_HOOK_MARKER, "Unable to register shutdown hook due to security restrictions",<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> e);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> @Override<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> public void close() {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> stop();<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> }<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> @Override<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> public void terminate() {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> stop();<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span><a name="line.341"></a> |
| <span class="sourceLineNo">342</span> /**<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * Blocks until all Log4j tasks have completed execution after a shutdown request and all appenders have shut down,<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * or the timeout occurs, or the current thread is interrupted, whichever happens first.<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * <p><a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * Not all appenders will honor this, it is a hint and not an absolute guarantee that the this method not block longer.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * Setting timeout too low increase the risk of losing outstanding log events not yet written to the final<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * destination.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * <p><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Log4j can start threads to perform certain actions like file rollovers, calling this method with a positive timeout will<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * block until the rollover thread is done.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> *<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param timeout the maximum time to wait, or 0 which mean that each apppender uses its default timeout, and don't wait for background<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> tasks<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * @param timeUnit<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * the time unit of the timeout argument<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * @return {@code true} if the logger context terminated and {@code false} if the timeout elapsed before<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * termination.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @since 2.7<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> */<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> @Override<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> LOGGER.debug("Stopping LoggerContext[name={}, {}]...", getName(), this);<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> configLock.lock();<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> try {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> if (this.isStopped()) {<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> return true;<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> }<a name="line.368"></a> |
| <span class="sourceLineNo">369</span><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> this.setStopping();<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> try {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> Server.unregisterLoggerContext(getName()); // LOG4J2-406, LOG4J2-500<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> } catch (final LinkageError | Exception e) {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> // LOG4J2-1506 Hello Android, GAE<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> LOGGER.error("Unable to unregister MBeans", e);<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> if (shutdownCallback != null) {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> shutdownCallback.cancel();<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> shutdownCallback = null;<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> }<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> final Configuration prev = configuration;<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> configuration = NULL_CONFIGURATION;<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> updateLoggers();<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> if (prev instanceof LifeCycle2) {<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> ((LifeCycle2) prev).stop(timeout, timeUnit);<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> } else {<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> prev.stop();<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> externalMap.clear();<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> LogManager.getFactory().removeContext(this);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> } finally {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> configLock.unlock();<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> this.setStopped();<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> if (listeners != null) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> for (LoggerContextShutdownAware listener : listeners) {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> try {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> listener.contextShutdown(this);<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> } catch (Exception ex) {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> // Ignore the exception.<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> }<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> }<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> LOGGER.debug("Stopped LoggerContext[name={}, {}] with status {}", getName(), this, true);<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> return true;<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> }<a name="line.406"></a> |
| <span class="sourceLineNo">407</span><a name="line.407"></a> |
| <span class="sourceLineNo">408</span> /**<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * Gets the name.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> *<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * @return the name.<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> */<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> public String getName() {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> return contextName;<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> /**<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * Gets the root logger.<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> *<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @return the root logger.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> */<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> public Logger getRootLogger() {<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> return getLogger(LogManager.ROOT_LOGGER_NAME);<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> /**<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * Sets the name.<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> *<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * @param name the new LoggerContext name<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * @throws NullPointerException if the specified name is {@code null}<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> */<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> public void setName(final String name) {<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> contextName = Objects.requireNonNull(name);<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> }<a name="line.434"></a> |
| <span class="sourceLineNo">435</span><a name="line.435"></a> |
| <span class="sourceLineNo">436</span> @Override<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> public Object getObject(String key) {<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> return externalMap.get(key);<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> }<a name="line.439"></a> |
| <span class="sourceLineNo">440</span><a name="line.440"></a> |
| <span class="sourceLineNo">441</span> @Override<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> public Object putObject(String key, Object value) {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> return externalMap.put(key, value);<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> }<a name="line.444"></a> |
| <span class="sourceLineNo">445</span><a name="line.445"></a> |
| <span class="sourceLineNo">446</span> @Override<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> public Object putObjectIfAbsent(String key, Object value) {<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> return externalMap.putIfAbsent(key, value);<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> }<a name="line.449"></a> |
| <span class="sourceLineNo">450</span><a name="line.450"></a> |
| <span class="sourceLineNo">451</span> @Override<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> public Object removeObject(String key) {<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> return externalMap.remove(key);<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> }<a name="line.454"></a> |
| <span class="sourceLineNo">455</span><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> @Override<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> public boolean removeObject(String key, Object value) {<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> return externalMap.remove(key, value);<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> }<a name="line.459"></a> |
| <span class="sourceLineNo">460</span><a name="line.460"></a> |
| <span class="sourceLineNo">461</span> /**<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * Sets the external context.<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> *<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * @param context The external context.<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> */<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> public void setExternalContext(final Object context) {<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> if (context != null) {<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> this.externalMap.put(EXTERNAL_CONTEXT_KEY, context);<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> } else {<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> this.externalMap.remove(EXTERNAL_CONTEXT_KEY);<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> }<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> }<a name="line.472"></a> |
| <span class="sourceLineNo">473</span><a name="line.473"></a> |
| <span class="sourceLineNo">474</span> /**<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * Returns the external context.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> *<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * @return The external context.<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> */<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> @Override<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> public Object getExternalContext() {<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> return this.externalMap.get(EXTERNAL_CONTEXT_KEY);<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> }<a name="line.482"></a> |
| <span class="sourceLineNo">483</span><a name="line.483"></a> |
| <span class="sourceLineNo">484</span> /**<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * Gets a Logger from the Context.<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> *<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * @param name The name of the Logger to return.<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * @return The Logger.<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> */<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> @Override<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> public Logger getLogger(final String name) {<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> return getLogger(name, null);<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> }<a name="line.493"></a> |
| <span class="sourceLineNo">494</span><a name="line.494"></a> |
| <span class="sourceLineNo">495</span> /**<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * Gets a collection of the current loggers.<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * <p><a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * Whether this collection is a copy of the underlying collection or not is undefined. Therefore, modify this<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * collection at your own risk.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * </p><a name="line.500"></a> |
| <span class="sourceLineNo">501</span> *<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @return a collection of the current loggers.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> */<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> public Collection<Logger> getLoggers() {<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> return loggerRegistry.getLoggers();<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> }<a name="line.506"></a> |
| <span class="sourceLineNo">507</span><a name="line.507"></a> |
| <span class="sourceLineNo">508</span> /**<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * Obtains a Logger from the Context.<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> *<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * @param name The name of the Logger to return.<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change the<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * logger but will log a warning if mismatched.<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * @return The Logger.<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> */<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> @Override<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> public Logger getLogger(final String name, final MessageFactory messageFactory) {<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> // Note: This is the only method where we add entries to the 'loggerRegistry' ivar.<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> Logger logger = loggerRegistry.getLogger(name, messageFactory);<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> if (logger != null) {<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> AbstractLogger.checkMessageFactory(logger, messageFactory);<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> return logger;<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> }<a name="line.523"></a> |
| <span class="sourceLineNo">524</span><a name="line.524"></a> |
| <span class="sourceLineNo">525</span> logger = newInstance(this, name, messageFactory);<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> loggerRegistry.putIfAbsent(name, messageFactory, logger);<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> return loggerRegistry.getLogger(name, messageFactory);<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> }<a name="line.528"></a> |
| <span class="sourceLineNo">529</span><a name="line.529"></a> |
| <span class="sourceLineNo">530</span> /**<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * Determines if the specified Logger exists.<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> *<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * @param name The Logger name to search for.<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * @return True if the Logger exists, false otherwise.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> */<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> @Override<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> public boolean hasLogger(final String name) {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> return loggerRegistry.hasLogger(name);<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> }<a name="line.539"></a> |
| <span class="sourceLineNo">540</span><a name="line.540"></a> |
| <span class="sourceLineNo">541</span> /**<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * Determines if the specified Logger exists.<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> *<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * @param name The Logger name to search for.<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * @return True if the Logger exists, false otherwise.<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> */<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> @Override<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> public boolean hasLogger(final String name, final MessageFactory messageFactory) {<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> return loggerRegistry.hasLogger(name, messageFactory);<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> }<a name="line.550"></a> |
| <span class="sourceLineNo">551</span><a name="line.551"></a> |
| <span class="sourceLineNo">552</span> /**<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * Determines if the specified Logger exists.<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> *<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> * @param name The Logger name to search for.<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * @return True if the Logger exists, false otherwise.<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> */<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> @Override<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> public boolean hasLogger(final String name, final Class<? extends MessageFactory> messageFactoryClass) {<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> return loggerRegistry.hasLogger(name, messageFactoryClass);<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> }<a name="line.561"></a> |
| <span class="sourceLineNo">562</span><a name="line.562"></a> |
| <span class="sourceLineNo">563</span> /**<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * Returns the current Configuration. The Configuration will be replaced when a reconfigure occurs.<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> *<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> * @return The current Configuration, never {@code null}, but may be<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * {@link org.apache.logging.log4j.core.config.NullConfiguration}.<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> */<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> public Configuration getConfiguration() {<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> return configuration;<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> }<a name="line.571"></a> |
| <span class="sourceLineNo">572</span><a name="line.572"></a> |
| <span class="sourceLineNo">573</span> /**<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * Adds a Filter to the Configuration. Filters that are added through the API will be lost when a reconfigure<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> * occurs.<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> *<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> * @param filter The Filter to add.<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> */<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> public void addFilter(final Filter filter) {<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> configuration.addFilter(filter);<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> }<a name="line.581"></a> |
| <span class="sourceLineNo">582</span><a name="line.582"></a> |
| <span class="sourceLineNo">583</span> /**<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> * Removes a Filter from the current Configuration.<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> *<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * @param filter The Filter to remove.<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> */<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> public void removeFilter(final Filter filter) {<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> configuration.removeFilter(filter);<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> }<a name="line.590"></a> |
| <span class="sourceLineNo">591</span><a name="line.591"></a> |
| <span class="sourceLineNo">592</span> /**<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> * Sets the Configuration to be used.<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> *<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> * @param config The new Configuration.<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> * @return The previous Configuration.<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> */<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> public Configuration setConfiguration(final Configuration config) {<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> if (config == null) {<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> LOGGER.error("No configuration found for context '{}'.", contextName);<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> // No change, return the current configuration.<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> return this.configuration;<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> }<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> configLock.lock();<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> try {<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> final Configuration prev = this.configuration;<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> config.addListener(this);<a name="line.607"></a> |
| <span class="sourceLineNo">608</span><a name="line.608"></a> |
| <span class="sourceLineNo">609</span> final ConcurrentMap<String, String> map = config.getComponent(Configuration.CONTEXT_PROPERTIES);<a name="line.609"></a> |
| <span class="sourceLineNo">610</span><a name="line.610"></a> |
| <span class="sourceLineNo">611</span> try { // LOG4J2-719 network access may throw android.os.NetworkOnMainThreadException<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> map.putIfAbsent("hostName", NetUtils.getLocalHostname());<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> } catch (final Exception ex) {<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> LOGGER.debug("Ignoring {}, setting hostName to 'unknown'", ex.toString());<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> map.putIfAbsent("hostName", "unknown");<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> }<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> map.putIfAbsent("contextName", contextName);<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> config.start();<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> this.configuration = config;<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> updateLoggers();<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> if (prev != null) {<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> prev.removeListener(this);<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> prev.stop();<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> }<a name="line.624"></a> |
| <span class="sourceLineNo">625</span><a name="line.625"></a> |
| <span class="sourceLineNo">626</span> firePropertyChangeEvent(new PropertyChangeEvent(this, PROPERTY_CONFIG, prev, config));<a name="line.626"></a> |
| <span class="sourceLineNo">627</span><a name="line.627"></a> |
| <span class="sourceLineNo">628</span> try {<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> Server.reregisterMBeansAfterReconfigure();<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> } catch (final LinkageError | Exception e) {<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> // LOG4J2-716: Android has no java.lang.management<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> LOGGER.error("Could not reconfigure JMX", e);<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> }<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> // AsyncLoggers update their nanoClock when the configuration changes<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> Log4jLogEvent.setNanoClock(configuration.getNanoClock());<a name="line.635"></a> |
| <span class="sourceLineNo">636</span><a name="line.636"></a> |
| <span class="sourceLineNo">637</span> return prev;<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> } finally {<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> configLock.unlock();<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> }<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> }<a name="line.641"></a> |
| <span class="sourceLineNo">642</span><a name="line.642"></a> |
| <span class="sourceLineNo">643</span> private void firePropertyChangeEvent(final PropertyChangeEvent event) {<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> for (final PropertyChangeListener listener : propertyChangeListeners) {<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> listener.propertyChange(event);<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> }<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> }<a name="line.647"></a> |
| <span class="sourceLineNo">648</span><a name="line.648"></a> |
| <span class="sourceLineNo">649</span> public void addPropertyChangeListener(final PropertyChangeListener listener) {<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> propertyChangeListeners.add(Objects.requireNonNull(listener, "listener"));<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> }<a name="line.651"></a> |
| <span class="sourceLineNo">652</span><a name="line.652"></a> |
| <span class="sourceLineNo">653</span> public void removePropertyChangeListener(final PropertyChangeListener listener) {<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> propertyChangeListeners.remove(listener);<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> }<a name="line.655"></a> |
| <span class="sourceLineNo">656</span><a name="line.656"></a> |
| <span class="sourceLineNo">657</span> /**<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> * Returns the initial configuration location or {@code null}. The returned value may not be the location of the<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * current configuration. Use {@link #getConfiguration()}.{@link Configuration#getConfigurationSource()<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * getConfigurationSource()}.{@link ConfigurationSource#getLocation() getLocation()} to get the actual source of the<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * current configuration.<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> *<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> * @return the initial configuration location or {@code null}<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> */<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> public URI getConfigLocation() {<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> return configLocation;<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> }<a name="line.667"></a> |
| <span class="sourceLineNo">668</span><a name="line.668"></a> |
| <span class="sourceLineNo">669</span> /**<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * Sets the configLocation to the specified value and reconfigures this context.<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> *<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * @param configLocation the location of the new configuration<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> */<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> public void setConfigLocation(final URI configLocation) {<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> this.configLocation = configLocation;<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> reconfigure(configLocation);<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> }<a name="line.677"></a> |
| <span class="sourceLineNo">678</span><a name="line.678"></a> |
| <span class="sourceLineNo">679</span> /**<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> * Reconfigures the context.<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> */<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> private void reconfigure(final URI configURI) {<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> Object externalContext = externalMap.get(EXTERNAL_CONTEXT_KEY);<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> final ClassLoader cl = ClassLoader.class.isInstance(externalContext) ? (ClassLoader) externalContext : null;<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> LOGGER.debug("Reconfiguration started for context[name={}] at URI {} ({}) with optional ClassLoader: {}",<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> contextName, configURI, this, cl);<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> final Configuration instance = ConfigurationFactory.getInstance().getConfiguration(this, contextName, configURI, cl);<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> if (instance == null) {<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> LOGGER.error("Reconfiguration failed: No configuration found for '{}' at '{}' in '{}'", contextName, configURI, cl);<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> } else {<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> setConfiguration(instance);<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> /*<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * instance.start(); Configuration old = setConfiguration(instance); updateLoggers(); if (old != null) {<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> * old.stop(); }<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> */<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> final String location = configuration == null ? "?" : String.valueOf(configuration.getConfigurationSource());<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> LOGGER.debug("Reconfiguration complete for context[name={}] at URI {} ({}) with optional ClassLoader: {}",<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> contextName, location, this, cl);<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> }<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> }<a name="line.700"></a> |
| <span class="sourceLineNo">701</span><a name="line.701"></a> |
| <span class="sourceLineNo">702</span> /**<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * Reconfigures the context. Log4j does not remove Loggers during a reconfiguration. Log4j will create new<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * LoggerConfig objects and Log4j will point the Loggers at the new LoggerConfigs. Log4j will free the old<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * LoggerConfig, along with old Appenders and Filters.<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> */<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> public void reconfigure() {<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> reconfigure(configLocation);<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> }<a name="line.709"></a> |
| <span class="sourceLineNo">710</span><a name="line.710"></a> |
| <span class="sourceLineNo">711</span> public void reconfigure(Configuration configuration) {<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> setConfiguration(configuration);<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> ConfigurationSource source = configuration.getConfigurationSource();<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> if (source != null) {<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> URI uri = source.getURI();<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> if (uri != null) {<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> configLocation = uri;<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> }<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> }<a name="line.719"></a> |
| <span class="sourceLineNo">720</span> }<a name="line.720"></a> |
| <span class="sourceLineNo">721</span><a name="line.721"></a> |
| <span class="sourceLineNo">722</span> /**<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * Causes all Loggers to be updated against the current Configuration.<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> */<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> public void updateLoggers() {<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> updateLoggers(this.configuration);<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> }<a name="line.727"></a> |
| <span class="sourceLineNo">728</span><a name="line.728"></a> |
| <span class="sourceLineNo">729</span> /**<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * Causes all Logger to be updated against the specified Configuration.<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> *<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * @param config The Configuration.<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> */<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> public void updateLoggers(final Configuration config) {<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> final Configuration old = this.configuration;<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> for (final Logger logger : loggerRegistry.getLoggers()) {<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> logger.updateConfiguration(config);<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> }<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> firePropertyChangeEvent(new PropertyChangeEvent(this, PROPERTY_CONFIG, old, config));<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> }<a name="line.740"></a> |
| <span class="sourceLineNo">741</span><a name="line.741"></a> |
| <span class="sourceLineNo">742</span> /**<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> * Causes a reconfiguration to take place when the underlying configuration file changes.<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> *<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * @param reconfigurable The Configuration that can be reconfigured.<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> */<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> @Override<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> public synchronized void onChange(final Reconfigurable reconfigurable) {<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> final long startMillis = System.currentTimeMillis();<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> LOGGER.debug("Reconfiguration started for context {} ({})", contextName, this);<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> initApiModule();<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> final Configuration newConfig = reconfigurable.reconfigure();<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> if (newConfig != null) {<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> setConfiguration(newConfig);<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> LOGGER.debug("Reconfiguration completed for {} ({}) in {} milliseconds.", contextName, this,<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> System.currentTimeMillis() - startMillis);<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> } else {<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> LOGGER.debug("Reconfiguration failed for {} ({}) in {} milliseconds.", contextName, this,<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> System.currentTimeMillis() - startMillis);<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> }<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> }<a name="line.761"></a> |
| <span class="sourceLineNo">762</span><a name="line.762"></a> |
| <span class="sourceLineNo">763</span> private void initApiModule() {<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> ThreadContextMapFactory.init(); // Or make public and call ThreadContext.init() which calls ThreadContextMapFactory.init().<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> }<a name="line.765"></a> |
| <span class="sourceLineNo">766</span><a name="line.766"></a> |
| <span class="sourceLineNo">767</span> // LOG4J2-151: changed visibility from private to protected<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> protected Logger newInstance(final LoggerContext ctx, final String name, final MessageFactory messageFactory) {<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> return new Logger(ctx, name, messageFactory);<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> }<a name="line.770"></a> |
| <span class="sourceLineNo">771</span><a name="line.771"></a> |
| <span class="sourceLineNo">772</span>}<a name="line.772"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
