| <!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.config;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.ByteArrayOutputStream;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.Serializable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.lang.ref.WeakReference;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Arrays;<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.HashSet;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.LinkedHashMap;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.List;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.Map;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.Objects;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.Set;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.concurrent.ConcurrentMap;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.concurrent.CopyOnWriteArrayList;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import java.util.concurrent.TimeUnit;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.Level;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.Appender;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.Filter;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.Layout;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.LifeCycle2;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.core.Version;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.core.appender.AsyncAppender;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.logging.log4j.core.appender.ConsoleAppender;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.logging.log4j.core.async.AsyncLoggerConfig;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.logging.log4j.core.async.AsyncLoggerConfigDelegate;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.logging.log4j.core.async.AsyncLoggerConfigDisruptor;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.logging.log4j.core.config.plugins.util.PluginBuilder;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.logging.log4j.core.filter.AbstractFilterable;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>import org.apache.logging.log4j.core.lookup.Interpolator;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.logging.log4j.core.lookup.MapLookup;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.logging.log4j.core.lookup.StrLookup;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>import org.apache.logging.log4j.core.net.Advertiser;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>import org.apache.logging.log4j.core.script.AbstractScript;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>import org.apache.logging.log4j.core.script.ScriptManager;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span>import org.apache.logging.log4j.core.script.ScriptRef;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span>import org.apache.logging.log4j.core.util.DummyNanoClock;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>import org.apache.logging.log4j.core.util.NameUtil;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>import org.apache.logging.log4j.core.util.NanoClock;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span>import org.apache.logging.log4j.core.util.Source;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span>import org.apache.logging.log4j.core.util.WatchManager;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span>import org.apache.logging.log4j.core.util.Watcher;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span>import org.apache.logging.log4j.core.util.WatcherFactory;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span>/**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * The base Configuration. Many configuration implementations will extend this class.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span>public abstract class AbstractConfiguration extends AbstractFilterable implements Configuration {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private static final int BUF_SIZE = 16384;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * The root node of the configuration.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> protected Node rootNode;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Listeners for configuration changes.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> protected final List<ConfigurationListener> listeners = new CopyOnWriteArrayList<>();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Packages found in configuration "packages" attribute.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> protected final List<String> pluginPackages = new ArrayList<>();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * The plugin manager.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> protected PluginManager pluginManager;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Shutdown hook is enabled by default.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> protected boolean isShutdownHookEnabled = true;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Shutdown timeout in milliseconds.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> protected long shutdownTimeoutMillis = 0;<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> * The Script manager.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> protected ScriptManager scriptManager;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * The Advertiser which exposes appender configurations to external systems.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> private Advertiser advertiser = new DefaultAdvertiser();<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> private Node advertiserNode = null;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> private Object advertisement;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> private String name;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> private ConcurrentMap<String, Appender> appenders = new ConcurrentHashMap<>();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> private ConcurrentMap<String, LoggerConfig> loggerConfigs = new ConcurrentHashMap<>();<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> private List<CustomLevelConfig> customLevels = Collections.emptyList();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private final ConcurrentMap<String, String> propertyMap = new ConcurrentHashMap<>();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> private final StrLookup tempLookup = new Interpolator(propertyMap);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> private final StrSubstitutor subst = new StrSubstitutor(tempLookup);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private LoggerConfig root = new LoggerConfig();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> private final ConcurrentMap<String, Object> componentMap = new ConcurrentHashMap<>();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> private final ConfigurationSource configurationSource;<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> private final ConfigurationScheduler configurationScheduler = new ConfigurationScheduler();<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> private final WatchManager watchManager = new WatchManager(configurationScheduler);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> private AsyncLoggerConfigDisruptor asyncLoggerConfigDisruptor;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> private NanoClock nanoClock = new DummyNanoClock();<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> private final WeakReference<LoggerContext> loggerContext;<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> * Constructor.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> protected AbstractConfiguration(final LoggerContext loggerContext, final ConfigurationSource configurationSource) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> this.loggerContext = new WeakReference<>(loggerContext);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> // The loggerContext is null for the NullConfiguration class.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // this.loggerContext = new WeakReference(Objects.requireNonNull(loggerContext, "loggerContext is null"));<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> this.configurationSource = Objects.requireNonNull(configurationSource, "configurationSource is null");<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> componentMap.put(Configuration.CONTEXT_PROPERTIES, propertyMap);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> pluginManager = new PluginManager(Node.CATEGORY);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> rootNode = new Node();<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> setState(State.INITIALIZING);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> @Override<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public ConfigurationSource getConfigurationSource() {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return configurationSource;<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> @Override<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public List<String> getPluginPackages() {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> return pluginPackages;<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> @Override<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public Map<String, String> getProperties() {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> return propertyMap;<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> @Override<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public ScriptManager getScriptManager() {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> return scriptManager;<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> public void setScriptManager(final ScriptManager scriptManager) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> this.scriptManager = scriptManager;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> public PluginManager getPluginManager() {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> return pluginManager;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public void setPluginManager(final PluginManager pluginManager) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> this.pluginManager = pluginManager;<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> @Override<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public WatchManager getWatchManager() {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return watchManager;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> @Override<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> public ConfigurationScheduler getScheduler() {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return configurationScheduler;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> public Node getRootNode() {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return rootNode;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> @Override<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> public AsyncLoggerConfigDelegate getAsyncLoggerConfigDelegate() {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> // lazily instantiate only when requested by AsyncLoggers:<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> // loading AsyncLoggerConfigDisruptor requires LMAX Disruptor jar on classpath<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> if (asyncLoggerConfigDisruptor == null) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> asyncLoggerConfigDisruptor = new AsyncLoggerConfigDisruptor();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> return asyncLoggerConfigDisruptor;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> /**<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * Initialize the configuration.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> @Override<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> public void initialize() {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> LOGGER.debug(Version.getProductString() + " initializing configuration {}", this);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> subst.setConfiguration(this);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> try {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> scriptManager = new ScriptManager(this, watchManager);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> } catch (final LinkageError | Exception e) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> // LOG4J2-1920 ScriptEngineManager is not available in Android<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> LOGGER.info("Cannot initialize scripting support because this JRE does not support it.", e);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> pluginManager.collectPlugins(pluginPackages);<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> final PluginManager levelPlugins = new PluginManager(Level.CATEGORY);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> levelPlugins.collectPlugins(pluginPackages);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> final Map<String, PluginType<?>> plugins = levelPlugins.getPlugins();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> if (plugins != null) {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> for (final PluginType<?> type : plugins.values()) {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> try {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> // Cause the class to be initialized if it isn't already.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> Loader.initializeClass(type.getPluginClass().getName(), type.getPluginClass().getClassLoader());<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> } catch (final Exception e) {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> LOGGER.error("Unable to initialize {} due to {}", type.getPluginClass().getName(), e.getClass()<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> .getSimpleName(), e);<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> }<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> }<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> }<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> setup();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> setupAdvertisement();<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> doConfigure();<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> setState(State.INITIALIZED);<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> LOGGER.debug("Configuration {} initialized", this);<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> protected void initializeWatchers(Reconfigurable reconfigurable, ConfigurationSource configSource,<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> int monitorIntervalSeconds) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> if (configSource.getFile() != null || configSource.getURL() != null) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> if (monitorIntervalSeconds > 0) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> watchManager.setIntervalSeconds(monitorIntervalSeconds);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> if (configSource.getFile() != null) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> final Source cfgSource = new Source(configSource);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> final long lastModifeid = configSource.getFile().lastModified();<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> final ConfigurationFileWatcher watcher = new ConfigurationFileWatcher(this, reconfigurable,<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> listeners, lastModifeid);<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> watchManager.watch(cfgSource, watcher);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> } else {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> if (configSource.getURL() != null) {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> monitorSource(reconfigurable, configSource);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> }<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> } else if (watchManager.hasEventListeners() && configSource.getURL() != null && monitorIntervalSeconds >= 0) {<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> monitorSource(reconfigurable, configSource);<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> }<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> }<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> private void monitorSource(Reconfigurable reconfigurable, ConfigurationSource configSource) {<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> if (configSource.getLastModified() > 0) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> final Source cfgSource = new Source(configSource);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> final Watcher watcher = WatcherFactory.getInstance(pluginPackages)<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> .newWatcher(cfgSource, this, reconfigurable, listeners, configSource.getLastModified());<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> if (watcher != null) {<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> watchManager.watch(cfgSource, watcher);<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> }<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> } else {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> LOGGER.info("{} does not support dynamic reconfiguration", configSource.getURI());<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Start the configuration.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> */<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> @Override<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public void start() {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> // Preserve the prior behavior of initializing during start if not initialized.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> if (getState().equals(State.INITIALIZING)) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> initialize();<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> }<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> LOGGER.debug("Starting configuration {}", this);<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> this.setStarting();<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> if (watchManager.getIntervalSeconds() >= 0) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> watchManager.start();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> if (hasAsyncLoggers()) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> asyncLoggerConfigDisruptor.start();<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> }<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> final Set<LoggerConfig> alreadyStarted = new HashSet<>();<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> for (final LoggerConfig logger : loggerConfigs.values()) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> logger.start();<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> alreadyStarted.add(logger);<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> for (final Appender appender : appenders.values()) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> appender.start();<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> if (!alreadyStarted.contains(root)) { // LOG4J2-392<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> root.start(); // LOG4J2-336<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> super.start();<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> LOGGER.debug("Started configuration {} OK.", this);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> }<a name="line.311"></a> |
| <span class="sourceLineNo">312</span><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> private boolean hasAsyncLoggers() {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> if (root instanceof AsyncLoggerConfig) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return true;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> for (final LoggerConfig logger : loggerConfigs.values()) {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (logger instanceof AsyncLoggerConfig) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> return true;<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> }<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> return false;<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> /**<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * Tear down the configuration.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> @Override<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> this.setStopping();<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> super.stop(timeout, timeUnit, false);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> LOGGER.trace("Stopping {}...", this);<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> // Stop the components that are closest to the application first:<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> // 1. Notify all LoggerConfigs' ReliabilityStrategy that the configuration will be stopped.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> // 2. Stop the LoggerConfig objects (this may stop nested Filters)<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> // 3. Stop the AsyncLoggerConfigDelegate. This shuts down the AsyncLoggerConfig Disruptor<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> // and waits until all events in the RingBuffer have been processed.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> // 4. Stop all AsyncAppenders. This shuts down the associated thread and<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> // waits until all events in the queue have been processed. (With optional timeout.)<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> // 5. Notify all LoggerConfigs' ReliabilityStrategy that appenders will be stopped.<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> // This guarantees that any event received by a LoggerConfig before reconfiguration<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> // are passed on to the Appenders before the Appenders are stopped.<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> // 6. Stop the remaining running Appenders. (It should now be safe to do so.)<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> // 7. Notify all LoggerConfigs that their Appenders can be cleaned up.<a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> for (final LoggerConfig loggerConfig : loggerConfigs.values()) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> loggerConfig.getReliabilityStrategy().beforeStopConfiguration(this);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> }<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> root.getReliabilityStrategy().beforeStopConfiguration(this);<a name="line.350"></a> |
| <span class="sourceLineNo">351</span><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> final String cls = getClass().getSimpleName();<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> LOGGER.trace("{} notified {} ReliabilityStrategies that config will be stopped.", cls, loggerConfigs.size()<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> + 1);<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> if (!loggerConfigs.isEmpty()) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> LOGGER.trace("{} stopping {} LoggerConfigs.", cls, loggerConfigs.size());<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> for (final LoggerConfig logger : loggerConfigs.values()) {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> logger.stop(timeout, timeUnit);<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> LOGGER.trace("{} stopping root LoggerConfig.", cls);<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> if (!root.isStopped()) {<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> root.stop(timeout, timeUnit);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> if (hasAsyncLoggers()) {<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> LOGGER.trace("{} stopping AsyncLoggerConfigDisruptor.", cls);<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> asyncLoggerConfigDisruptor.stop(timeout, timeUnit);<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span><a name="line.371"></a> |
| <span class="sourceLineNo">372</span> // Stop the appenders in reverse order in case they still have activity.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> final Appender[] array = appenders.values().toArray(new Appender[appenders.size()]);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> final List<Appender> async = getAsyncAppenders(array);<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> if (!async.isEmpty()) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> // LOG4J2-511, LOG4J2-392 stop AsyncAppenders first<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> LOGGER.trace("{} stopping {} AsyncAppenders.", cls, async.size());<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> for (final Appender appender : async) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> if (appender instanceof LifeCycle2) {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> ((LifeCycle2) appender).stop(timeout, timeUnit);<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> } else {<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> appender.stop();<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> }<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> }<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> }<a name="line.385"></a> |
| <span class="sourceLineNo">386</span><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> LOGGER.trace("{} notifying ReliabilityStrategies that appenders will be stopped.", cls);<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> for (final LoggerConfig loggerConfig : loggerConfigs.values()) {<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> loggerConfig.getReliabilityStrategy().beforeStopAppenders();<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> root.getReliabilityStrategy().beforeStopAppenders();<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> LOGGER.trace("{} stopping remaining Appenders.", cls);<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> int appenderCount = 0;<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> for (int i = array.length - 1; i >= 0; --i) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> if (array[i].isStarted()) { // then stop remaining Appenders<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> if (array[i] instanceof LifeCycle2) {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> ((LifeCycle2) array[i]).stop(timeout, timeUnit);<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> } else {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> array[i].stop();<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> }<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> appenderCount++;<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> }<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> }<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> LOGGER.trace("{} stopped {} remaining Appenders.", cls, appenderCount);<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> LOGGER.trace("{} cleaning Appenders from {} LoggerConfigs.", cls, loggerConfigs.size() + 1);<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> for (final LoggerConfig loggerConfig : loggerConfigs.values()) {<a name="line.408"></a> |
| <span class="sourceLineNo">409</span><a name="line.409"></a> |
| <span class="sourceLineNo">410</span> // LOG4J2-520, LOG4J2-392:<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> // Important: do not clear appenders until after all AsyncLoggerConfigs<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> // have been stopped! Stopping the last AsyncLoggerConfig will<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> // shut down the disruptor and wait for all enqueued events to be processed.<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> // Only *after this* the appenders can be cleared or events will be lost.<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> loggerConfig.clearAppenders();<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> }<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> root.clearAppenders();<a name="line.417"></a> |
| <span class="sourceLineNo">418</span><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> if (watchManager.isStarted()) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> watchManager.stop(timeout, timeUnit);<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> }<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> configurationScheduler.stop(timeout, timeUnit);<a name="line.422"></a> |
| <span class="sourceLineNo">423</span><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> if (advertiser != null && advertisement != null) {<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> advertiser.unadvertise(advertisement);<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> }<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> setStopped();<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> LOGGER.debug("Stopped {} OK", this);<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> return true;<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span><a name="line.431"></a> |
| <span class="sourceLineNo">432</span> private List<Appender> getAsyncAppenders(final Appender[] all) {<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> final List<Appender> result = new ArrayList<>();<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> for (int i = all.length - 1; i >= 0; --i) {<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> if (all[i] instanceof AsyncAppender) {<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> result.add(all[i]);<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> }<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> return result;<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span><a name="line.441"></a> |
| <span class="sourceLineNo">442</span> @Override<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> public boolean isShutdownHookEnabled() {<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> return isShutdownHookEnabled;<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> }<a name="line.445"></a> |
| <span class="sourceLineNo">446</span><a name="line.446"></a> |
| <span class="sourceLineNo">447</span> @Override<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> public long getShutdownTimeoutMillis() {<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> return shutdownTimeoutMillis;<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> }<a name="line.450"></a> |
| <span class="sourceLineNo">451</span><a name="line.451"></a> |
| <span class="sourceLineNo">452</span> public void setup() {<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> // default does nothing, subclasses do work.<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> protected Level getDefaultStatus() {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> final String statusLevel = PropertiesUtil.getProperties().getStringProperty(<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> Constants.LOG4J_DEFAULT_STATUS_LEVEL, Level.ERROR.name());<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> try {<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> return Level.toLevel(statusLevel);<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> } catch (final Exception ex) {<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> return Level.ERROR;<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> }<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> }<a name="line.464"></a> |
| <span class="sourceLineNo">465</span><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> protected void createAdvertiser(final String advertiserString, final ConfigurationSource configSource,<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> final byte[] buffer, final String contentType) {<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> if (advertiserString != null) {<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> final Node node = new Node(null, advertiserString, null);<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> final Map<String, String> attributes = node.getAttributes();<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> attributes.put("content", new String(buffer));<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> attributes.put("contentType", contentType);<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> attributes.put("name", "configuration");<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> if (configSource.getLocation() != null) {<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> attributes.put("location", configSource.getLocation());<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> }<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> advertiserNode = node;<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> }<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> }<a name="line.479"></a> |
| <span class="sourceLineNo">480</span><a name="line.480"></a> |
| <span class="sourceLineNo">481</span> private void setupAdvertisement() {<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> if (advertiserNode != null) {<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> final String nodeName = advertiserNode.getName();<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> final PluginType<?> type = pluginManager.getPluginType(nodeName);<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> if (type != null) {<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> final Class<? extends Advertiser> clazz = type.getPluginClass().asSubclass(Advertiser.class);<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> try {<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> advertiser = clazz.newInstance();<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> advertisement = advertiser.advertise(advertiserNode.getAttributes());<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> } catch (final InstantiationException e) {<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> LOGGER.error("InstantiationException attempting to instantiate advertiser: {}", nodeName, e);<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> } catch (final IllegalAccessException e) {<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> LOGGER.error("IllegalAccessException attempting to instantiate advertiser: {}", nodeName, e);<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> }<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> }<a name="line.497"></a> |
| <span class="sourceLineNo">498</span><a name="line.498"></a> |
| <span class="sourceLineNo">499</span> @SuppressWarnings("unchecked")<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> @Override<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> public <T> T getComponent(final String componentName) {<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> return (T) componentMap.get(componentName);<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> }<a name="line.503"></a> |
| <span class="sourceLineNo">504</span><a name="line.504"></a> |
| <span class="sourceLineNo">505</span> @Override<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> public void addComponent(final String componentName, final Object obj) {<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> componentMap.putIfAbsent(componentName, obj);<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> }<a name="line.508"></a> |
| <span class="sourceLineNo">509</span><a name="line.509"></a> |
| <span class="sourceLineNo">510</span> protected void preConfigure(final Node node) {<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> try {<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> for (final Node child : node.getChildren()) {<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> if (child.getType() == null) {<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> LOGGER.error("Unable to locate plugin type for " + child.getName());<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> continue;<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> }<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> final Class<?> clazz = child.getType().getPluginClass();<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> if (clazz.isAnnotationPresent(Scheduled.class)) {<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> configurationScheduler.incrementScheduledItems();<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> }<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> preConfigure(child);<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> }<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> } catch (final Exception ex) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> LOGGER.error("Error capturing node data for node " + node.getName(), ex);<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> }<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> protected void doConfigure() {<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> preConfigure(rootNode);<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> configurationScheduler.start();<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> if (rootNode.hasChildren() && rootNode.getChildren().get(0).getName().equalsIgnoreCase("Properties")) {<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> final Node first = rootNode.getChildren().get(0);<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> createConfiguration(first, null);<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> if (first.getObject() != null) {<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> subst.setVariableResolver((StrLookup) first.getObject());<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> }<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> } else {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> final Map<String, String> map = this.getComponent(CONTEXT_PROPERTIES);<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> final StrLookup lookup = map == null ? null : new MapLookup(map);<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> subst.setVariableResolver(new Interpolator(lookup, pluginPackages));<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> }<a name="line.541"></a> |
| <span class="sourceLineNo">542</span><a name="line.542"></a> |
| <span class="sourceLineNo">543</span> boolean setLoggers = false;<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> boolean setRoot = false;<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> for (final Node child : rootNode.getChildren()) {<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> if (child.getName().equalsIgnoreCase("Properties")) {<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> if (tempLookup == subst.getVariableResolver()) {<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> LOGGER.error("Properties declaration must be the first element in the configuration");<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> }<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> continue;<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> }<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> createConfiguration(child, null);<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> if (child.getObject() == null) {<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> continue;<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> }<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> if (child.getName().equalsIgnoreCase("Scripts")) {<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> for (final AbstractScript script : child.getObject(AbstractScript[].class)) {<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> if (script instanceof ScriptRef) {<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> LOGGER.error("Script reference to {} not added. Scripts definition cannot contain script references",<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> script.getName());<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> } else {<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> if (scriptManager != null) {<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> scriptManager.addScript(script);<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> }}<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> }<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> } else if (child.getName().equalsIgnoreCase("Appenders")) {<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> appenders = child.getObject();<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> } else if (child.isInstanceOf(Filter.class)) {<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> addFilter(child.getObject(Filter.class));<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> } else if (child.getName().equalsIgnoreCase("Loggers")) {<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> final Loggers l = child.getObject();<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> loggerConfigs = l.getMap();<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> setLoggers = true;<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> if (l.getRoot() != null) {<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> root = l.getRoot();<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> setRoot = true;<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> }<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> } else if (child.getName().equalsIgnoreCase("CustomLevels")) {<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> customLevels = child.getObject(CustomLevels.class).getCustomLevels();<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> } else if (child.isInstanceOf(CustomLevelConfig.class)) {<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> final List<CustomLevelConfig> copy = new ArrayList<>(customLevels);<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> copy.add(child.getObject(CustomLevelConfig.class));<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> customLevels = copy;<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> } else {<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> final List<String> expected = Arrays.asList("\"Appenders\"", "\"Loggers\"", "\"Properties\"",<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> "\"Scripts\"", "\"CustomLevels\"");<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> LOGGER.error("Unknown object \"{}\" of type {} is ignored: try nesting it inside one of: {}.",<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> child.getName(), child.getObject().getClass().getName(), expected);<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> }<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> if (!setLoggers) {<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> LOGGER.warn("No Loggers were configured, using default. Is the Loggers element missing?");<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> setToDefault();<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> return;<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> } else if (!setRoot) {<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> LOGGER.warn("No Root logger was configured, creating default ERROR-level Root logger with Console appender");<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> setToDefault();<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> // return; // LOG4J2-219: creating default root=ok, but don't exclude configured Loggers<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> }<a name="line.600"></a> |
| <span class="sourceLineNo">601</span><a name="line.601"></a> |
| <span class="sourceLineNo">602</span> for (final Map.Entry<String, LoggerConfig> entry : loggerConfigs.entrySet()) {<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> final LoggerConfig loggerConfig = entry.getValue();<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> for (final AppenderRef ref : loggerConfig.getAppenderRefs()) {<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> final Appender app = appenders.get(ref.getRef());<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> if (app != null) {<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> loggerConfig.addAppender(app, ref.getLevel(), ref.getFilter());<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> } else {<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> LOGGER.error("Unable to locate appender \"{}\" for logger config \"{}\"", ref.getRef(),<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> loggerConfig);<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> }<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> }<a name="line.612"></a> |
| <span class="sourceLineNo">613</span><a name="line.613"></a> |
| <span class="sourceLineNo">614</span> }<a name="line.614"></a> |
| <span class="sourceLineNo">615</span><a name="line.615"></a> |
| <span class="sourceLineNo">616</span> setParents();<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> }<a name="line.617"></a> |
| <span class="sourceLineNo">618</span><a name="line.618"></a> |
| <span class="sourceLineNo">619</span> protected void setToDefault() {<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> // LOG4J2-1176 facilitate memory leak investigation<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> setName(DefaultConfiguration.DEFAULT_NAME + "@" + Integer.toHexString(hashCode()));<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> final Layout<? extends Serializable> layout = PatternLayout.newBuilder()<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> .withPattern(DefaultConfiguration.DEFAULT_PATTERN)<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> .withConfiguration(this)<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> .build();<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> final Appender appender = ConsoleAppender.createDefaultAppenderForLayout(layout);<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> appender.start();<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> addAppender(appender);<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> final LoggerConfig rootLoggerConfig = getRootLogger();<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> rootLoggerConfig.addAppender(appender, null, null);<a name="line.630"></a> |
| <span class="sourceLineNo">631</span><a name="line.631"></a> |
| <span class="sourceLineNo">632</span> final Level defaultLevel = Level.ERROR;<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> final String levelName = PropertiesUtil.getProperties().getStringProperty(DefaultConfiguration.DEFAULT_LEVEL,<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> defaultLevel.name());<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> final Level level = Level.valueOf(levelName);<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> rootLoggerConfig.setLevel(level != null ? level : defaultLevel);<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> }<a name="line.637"></a> |
| <span class="sourceLineNo">638</span><a name="line.638"></a> |
| <span class="sourceLineNo">639</span> /**<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> * Set the name of the configuration.<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> *<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> * @param name The name.<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> */<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> public void setName(final String name) {<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> this.name = name;<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> * Returns the name of the configuration.<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> *<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * @return the name of the configuration.<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> */<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> @Override<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> public String getName() {<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> return name;<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> /**<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * Add a listener for changes on the configuration.<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> *<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * @param listener The ConfigurationListener to add.<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> */<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> @Override<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> public void addListener(final ConfigurationListener listener) {<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> listeners.add(listener);<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> }<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> * Remove a ConfigurationListener.<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> *<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * @param listener The ConfigurationListener to remove.<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> */<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> @Override<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> public void removeListener(final ConfigurationListener listener) {<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> listeners.remove(listener);<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> }<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> * Returns the Appender with the specified name.<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> *<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> * @param appenderName The name of the Appender.<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * @return the Appender with the specified name or null if the Appender cannot be located.<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> */<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> @Override<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> @SuppressWarnings("unchecked")<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> public <T extends Appender> T getAppender(final String appenderName) {<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> return appenderName != null ? (T) appenders.get(appenderName) : null;<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> }<a name="line.688"></a> |
| <span class="sourceLineNo">689</span><a name="line.689"></a> |
| <span class="sourceLineNo">690</span> /**<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * Returns a Map containing all the Appenders and their name.<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> *<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * @return A Map containing each Appender's name and the Appender object.<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> */<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> @Override<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> public Map<String, Appender> getAppenders() {<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> return appenders;<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> }<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> * Adds an Appender to the configuration.<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> *<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * @param appender The Appender to add.<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> */<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> @Override<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> public void addAppender(final Appender appender) {<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> if (appender != null) {<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> appenders.putIfAbsent(appender.getName(), appender);<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><a name="line.711"></a> |
| <span class="sourceLineNo">712</span> @Override<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> public StrSubstitutor getStrSubstitutor() {<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> return subst;<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> }<a name="line.715"></a> |
| <span class="sourceLineNo">716</span><a name="line.716"></a> |
| <span class="sourceLineNo">717</span> @Override<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> public void setAdvertiser(final Advertiser advertiser) {<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> this.advertiser = advertiser;<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> @Override<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> public Advertiser getAdvertiser() {<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> return advertiser;<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> }<a name="line.725"></a> |
| <span class="sourceLineNo">726</span><a name="line.726"></a> |
| <span class="sourceLineNo">727</span> /*<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * (non-Javadoc)<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> *<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * @see org.apache.logging.log4j.core.config.ReliabilityStrategyFactory#getReliabilityStrategy(org.apache.logging.log4j<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * .core.config.LoggerConfig)<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> */<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> @Override<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> public ReliabilityStrategy getReliabilityStrategy(final LoggerConfig loggerConfig) {<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> return ReliabilityStrategyFactory.getReliabilityStrategy(loggerConfig);<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> }<a name="line.736"></a> |
| <span class="sourceLineNo">737</span><a name="line.737"></a> |
| <span class="sourceLineNo">738</span> /**<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> * Associates an Appender with a LoggerConfig. This method is synchronized in case a Logger with the same name is<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> * being updated at the same time.<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> *<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> * Note: This method is not used when configuring via configuration. It is primarily used by unit tests.<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> *<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> * @param logger The Logger the Appender will be associated with.<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * @param appender The Appender.<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 addLoggerAppender(final org.apache.logging.log4j.core.Logger logger,<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> final Appender appender) {<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> if (appender == null || logger == null) {<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> return;<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> }<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> final String loggerName = logger.getName();<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> appenders.putIfAbsent(appender.getName(), appender);<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> final LoggerConfig lc = getLoggerConfig(loggerName);<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> if (lc.getName().equals(loggerName)) {<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> lc.addAppender(appender, null, null);<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> } else {<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> final LoggerConfig nlc = new LoggerConfig(loggerName, lc.getLevel(), lc.isAdditive());<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> nlc.addAppender(appender, null, null);<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> nlc.setParent(lc);<a name="line.761"></a> |
| <span class="sourceLineNo">762</span> loggerConfigs.putIfAbsent(loggerName, nlc);<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> setParents();<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> logger.getContext().updateLoggers();<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><a name="line.767"></a> |
| <span class="sourceLineNo">768</span> /**<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> * Associates a Filter with a LoggerConfig. This method is synchronized in case a Logger with the same name is being<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> * updated at the same time.<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> *<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * Note: This method is not used when configuring via configuration. It is primarily used by unit tests.<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> *<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * @param logger The Logger the Footer will be associated with.<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * @param filter The Filter.<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> */<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> @Override<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> public synchronized void addLoggerFilter(final org.apache.logging.log4j.core.Logger logger, final Filter filter) {<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> final String loggerName = logger.getName();<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> final LoggerConfig lc = getLoggerConfig(loggerName);<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> if (lc.getName().equals(loggerName)) {<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> lc.addFilter(filter);<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> } else {<a name="line.783"></a> |
| <span class="sourceLineNo">784</span> final LoggerConfig nlc = new LoggerConfig(loggerName, lc.getLevel(), lc.isAdditive());<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> nlc.addFilter(filter);<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> nlc.setParent(lc);<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> loggerConfigs.putIfAbsent(loggerName, nlc);<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> setParents();<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> logger.getContext().updateLoggers();<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> }<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> }<a name="line.791"></a> |
| <span class="sourceLineNo">792</span><a name="line.792"></a> |
| <span class="sourceLineNo">793</span> /**<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> * Marks a LoggerConfig as additive. This method is synchronized in case a Logger with the same name is being<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> * updated at the same time.<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> *<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> * Note: This method is not used when configuring via configuration. It is primarily used by unit tests.<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> *<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> * @param logger The Logger the Appender will be associated with.<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> * @param additive True if the LoggerConfig should be additive, false otherwise.<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> */<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> @Override<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> public synchronized void setLoggerAdditive(final org.apache.logging.log4j.core.Logger logger, final boolean additive) {<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> final String loggerName = logger.getName();<a name="line.804"></a> |
| <span class="sourceLineNo">805</span> final LoggerConfig lc = getLoggerConfig(loggerName);<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> if (lc.getName().equals(loggerName)) {<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> lc.setAdditive(additive);<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> } else {<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> final LoggerConfig nlc = new LoggerConfig(loggerName, lc.getLevel(), additive);<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> nlc.setParent(lc);<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> loggerConfigs.putIfAbsent(loggerName, nlc);<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> setParents();<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> logger.getContext().updateLoggers();<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> }<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> }<a name="line.815"></a> |
| <span class="sourceLineNo">816</span><a name="line.816"></a> |
| <span class="sourceLineNo">817</span> /**<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> * Remove an Appender. First removes any associations between LoggerConfigs and the Appender, removes the Appender<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> * from this appender list and then stops the appender. This method is synchronized in case an Appender with the<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> * same name is being added during the removal.<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> *<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> * @param appenderName the name of the appender to remove.<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> */<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> public synchronized void removeAppender(final String appenderName) {<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> for (final LoggerConfig logger : loggerConfigs.values()) {<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> logger.removeAppender(appenderName);<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> }<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> final Appender app = appenderName != null ? appenders.remove(appenderName) : null;<a name="line.828"></a> |
| <span class="sourceLineNo">829</span><a name="line.829"></a> |
| <span class="sourceLineNo">830</span> if (app != null) {<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> app.stop();<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> }<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> }<a name="line.833"></a> |
| <span class="sourceLineNo">834</span><a name="line.834"></a> |
| <span class="sourceLineNo">835</span> /*<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> * (non-Javadoc)<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> *<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> * @see org.apache.logging.log4j.core.config.Configuration#getCustomLevels()<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> */<a name="line.839"></a> |
| <span class="sourceLineNo">840</span> @Override<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> public List<CustomLevelConfig> getCustomLevels() {<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> return Collections.unmodifiableList(customLevels);<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> }<a name="line.843"></a> |
| <span class="sourceLineNo">844</span><a name="line.844"></a> |
| <span class="sourceLineNo">845</span> /**<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> * Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> * necessary or return the root LoggerConfig if no other matches were found.<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> *<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> * @param loggerName The Logger name.<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * @return The located LoggerConfig.<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> */<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> @Override<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> public LoggerConfig getLoggerConfig(final String loggerName) {<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> LoggerConfig loggerConfig = loggerConfigs.get(loggerName);<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> if (loggerConfig != null) {<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> return loggerConfig;<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> }<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> String substr = loggerName;<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> while ((substr = NameUtil.getSubName(substr)) != null) {<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> loggerConfig = loggerConfigs.get(substr);<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> if (loggerConfig != null) {<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> return loggerConfig;<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> }<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> }<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> return root;<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> }<a name="line.866"></a> |
| <span class="sourceLineNo">867</span><a name="line.867"></a> |
| <span class="sourceLineNo">868</span> @Override<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> public LoggerContext getLoggerContext() {<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> return loggerContext.get();<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> }<a name="line.871"></a> |
| <span class="sourceLineNo">872</span><a name="line.872"></a> |
| <span class="sourceLineNo">873</span> /**<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> * Returns the root Logger.<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> *<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> * @return the root Logger.<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> */<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> @Override<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> public LoggerConfig getRootLogger() {<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> return root;<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> }<a name="line.881"></a> |
| <span class="sourceLineNo">882</span><a name="line.882"></a> |
| <span class="sourceLineNo">883</span> /**<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * Returns a Map of all the LoggerConfigs.<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> *<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> * @return a Map with each entry containing the name of the Logger and the LoggerConfig.<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> */<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> @Override<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> public Map<String, LoggerConfig> getLoggers() {<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> return Collections.unmodifiableMap(loggerConfigs);<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> }<a name="line.891"></a> |
| <span class="sourceLineNo">892</span><a name="line.892"></a> |
| <span class="sourceLineNo">893</span> /**<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> * Returns the LoggerConfig with the specified name.<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> *<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> * @param loggerName The Logger name.<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> * @return The LoggerConfig or null if no match was found.<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> */<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> public LoggerConfig getLogger(final String loggerName) {<a name="line.899"></a> |
| <span class="sourceLineNo">900</span> return loggerConfigs.get(loggerName);<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> }<a name="line.901"></a> |
| <span class="sourceLineNo">902</span><a name="line.902"></a> |
| <span class="sourceLineNo">903</span> /**<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> * Add a loggerConfig. The LoggerConfig must already be configured with Appenders, Filters, etc. After addLogger is<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> * called LoggerContext.updateLoggers must be called.<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> *<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> * @param loggerName The name of the Logger.<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> * @param loggerConfig The LoggerConfig.<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> */<a name="line.909"></a> |
| <span class="sourceLineNo">910</span> @Override<a name="line.910"></a> |
| <span class="sourceLineNo">911</span> public synchronized void addLogger(final String loggerName, final LoggerConfig loggerConfig) {<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> loggerConfigs.putIfAbsent(loggerName, loggerConfig);<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> setParents();<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> }<a name="line.914"></a> |
| <span class="sourceLineNo">915</span><a name="line.915"></a> |
| <span class="sourceLineNo">916</span> /**<a name="line.916"></a> |
| <span class="sourceLineNo">917</span> * Remove a LoggerConfig.<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> *<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> * @param loggerName The name of the Logger.<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> */<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> @Override<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> public synchronized void removeLogger(final String loggerName) {<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> loggerConfigs.remove(loggerName);<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> setParents();<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> }<a name="line.925"></a> |
| <span class="sourceLineNo">926</span><a name="line.926"></a> |
| <span class="sourceLineNo">927</span> @Override<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> public void createConfiguration(final Node node, final LogEvent event) {<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> final PluginType<?> type = node.getType();<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> if (type != null && type.isDeferChildren()) {<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> node.setObject(createPluginObject(type, node, event));<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> } else {<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> for (final Node child : node.getChildren()) {<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> createConfiguration(child, event);<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> }<a name="line.935"></a> |
| <span class="sourceLineNo">936</span><a name="line.936"></a> |
| <span class="sourceLineNo">937</span> if (type == null) {<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> if (node.getParent() != null) {<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> LOGGER.error("Unable to locate plugin for {}", node.getName());<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> }<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> } else {<a name="line.941"></a> |
| <span class="sourceLineNo">942</span> node.setObject(createPluginObject(type, node, event));<a name="line.942"></a> |
| <span class="sourceLineNo">943</span> }<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> }<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> }<a name="line.945"></a> |
| <span class="sourceLineNo">946</span><a name="line.946"></a> |
| <span class="sourceLineNo">947</span> /**<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> * Invokes a static factory method to either create the desired object or to create a builder object that creates<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> * the desired object. In the case of a factory method, it should be annotated with<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginFactory}, and each parameter should be annotated with<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> * an appropriate plugin annotation depending on what that parameter describes. Parameters annotated with<a name="line.951"></a> |
| <span class="sourceLineNo">952</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginAttribute} must be a type that can be converted from a<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> * string using one of the {@link org.apache.logging.log4j.core.config.plugins.convert.TypeConverter TypeConverters}<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> * . Parameters with {@link org.apache.logging.log4j.core.config.plugins.PluginElement} may be any plugin class or<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> * an array of a plugin class. Collections and Maps are currently not supported, although the factory method that is<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> * called can create these from an array.<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> *<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> * Plugins can also be created using a builder class that implements<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> * {@link org.apache.logging.log4j.core.util.Builder}. In that case, a static method annotated with<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute} should create the builder class, and<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> * the various fields in the builder class should be annotated similarly to the method parameters. However, instead<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> * of using PluginAttribute, one should use<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute} where the default value can be<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> * specified as the default field value instead of as an additional annotation parameter.<a name="line.964"></a> |
| <span class="sourceLineNo">965</span> *<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> * In either case, there are also annotations for specifying a<a name="line.966"></a> |
| <span class="sourceLineNo">967</span> * {@link org.apache.logging.log4j.core.config.Configuration} (<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginConfiguration}) or a<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> * {@link org.apache.logging.log4j.core.config.Node} (<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> * {@link org.apache.logging.log4j.core.config.plugins.PluginNode}).<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> *<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> * Although the happy path works, more work still needs to be done to log incorrect parameters. These will generally<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> * result in unhelpful InvocationTargetExceptions.<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> *<a name="line.974"></a> |
| <span class="sourceLineNo">975</span> * @param type the type of plugin to create.<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> * @param node the corresponding configuration node for this plugin to create.<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> * @param event the LogEvent that spurred the creation of this plugin<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> * @return the created plugin object or {@code null} if there was an error setting it up.<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> * @see org.apache.logging.log4j.core.config.plugins.util.PluginBuilder<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> * @see org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * @see org.apache.logging.log4j.core.config.plugins.convert.TypeConverter<a name="line.981"></a> |
| <span class="sourceLineNo">982</span> */<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> private Object createPluginObject(final PluginType<?> type, final Node node, final LogEvent event) {<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> final Class<?> clazz = type.getPluginClass();<a name="line.984"></a> |
| <span class="sourceLineNo">985</span><a name="line.985"></a> |
| <span class="sourceLineNo">986</span> if (Map.class.isAssignableFrom(clazz)) {<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> try {<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> return createPluginMap(node);<a name="line.988"></a> |
| <span class="sourceLineNo">989</span> } catch (final Exception e) {<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> LOGGER.warn("Unable to create Map for {} of class {}", type.getElementName(), clazz, e);<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> }<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> }<a name="line.992"></a> |
| <span class="sourceLineNo">993</span><a name="line.993"></a> |
| <span class="sourceLineNo">994</span> if (Collection.class.isAssignableFrom(clazz)) {<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> try {<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> return createPluginCollection(node);<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> } catch (final Exception e) {<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> LOGGER.warn("Unable to create List for {} of class {}", type.getElementName(), clazz, e);<a name="line.998"></a> |
| <span class="sourceLineNo">999</span> }<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> }<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span><a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> return new PluginBuilder(type).withConfiguration(this).withConfigurationNode(node).forLogEvent(event).build();<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> }<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span><a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> private static Map<String, ?> createPluginMap(final Node node) {<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> final Map<String, Object> map = new LinkedHashMap<>();<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> for (final Node child : node.getChildren()) {<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> final Object object = child.getObject();<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> map.put(child.getName(), object);<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> }<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> return map;<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> }<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span><a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> private static Collection<?> createPluginCollection(final Node node) {<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> final List<Node> children = node.getChildren();<a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> final Collection<Object> list = new ArrayList<>(children.size());<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> for (final Node child : children) {<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> final Object object = child.getObject();<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> list.add(object);<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> }<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span> return list;<a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> }<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span><a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> private void setParents() {<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> for (final Map.Entry<String, LoggerConfig> entry : loggerConfigs.entrySet()) {<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> final LoggerConfig logger = entry.getValue();<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> String key = entry.getKey();<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> if (!key.isEmpty()) {<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> final int i = key.lastIndexOf('.');<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> if (i > 0) {<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> key = key.substring(0, i);<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> LoggerConfig parent = getLoggerConfig(key);<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> if (parent == null) {<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> parent = root;<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> }<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> logger.setParent(parent);<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> } else {<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> logger.setParent(root);<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> }<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> }<a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> }<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> }<a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span><a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> /**<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> * Reads an InputStream using buffered reads into a byte array buffer. The given InputStream will remain open after<a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> * invocation of this method.<a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> *<a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> * @param is the InputStream to read into a byte array buffer.<a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> * @return a byte array of the InputStream contents.<a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> * @throws IOException if the {@code read} method of the provided InputStream throws this exception.<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> */<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> protected static byte[] toByteArray(final InputStream is) throws IOException {<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> final ByteArrayOutputStream buffer = new ByteArrayOutputStream();<a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span><a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> int nRead;<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> final byte[] data = new byte[BUF_SIZE];<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span><a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> while ((nRead = is.read(data, 0, data.length)) != -1) {<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span> buffer.write(data, 0, nRead);<a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> }<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span><a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> return buffer.toByteArray();<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> }<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span><a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> @Override<a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> public NanoClock getNanoClock() {<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> return nanoClock;<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> }<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span><a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> @Override<a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> public void setNanoClock(final NanoClock nanoClock) {<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span> this.nanoClock = Objects.requireNonNull(nanoClock, "nanoClock");<a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> }<a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span>}<a name="line.1074"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
