blob: cdd006b33ced22ca22d49c71ef86e93db037f23e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender.routing;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Collections;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Objects;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.ConcurrentMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.script.Bindings;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.Appender;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Core;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.Filter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.LifeCycle2;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.appender.rewrite.RewritePolicy;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.Node;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.Property;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.script.AbstractScript;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.script.ScriptManager;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>/**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * This Appender "routes" between various Appenders, some of which can be references to<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Appenders defined earlier in the configuration while others can be dynamically created<a name="line.49"></a>
<span class="sourceLineNo">050</span> * within this Appender as required. Routing is achieved by specifying a pattern on<a name="line.50"></a>
<span class="sourceLineNo">051</span> * the Routing appender declaration. The pattern should contain one or more substitution patterns of<a name="line.51"></a>
<span class="sourceLineNo">052</span> * the form "$${[key:]token}". The pattern will be resolved each time the Appender is called using<a name="line.52"></a>
<span class="sourceLineNo">053</span> * the built in StrSubstitutor and the StrLookup plugin that matches the specified key.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span>@Plugin(name = "Routing", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.55"></a>
<span class="sourceLineNo">056</span>public final class RoutingAppender extends AbstractAppender {<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> public static final String STATIC_VARIABLES_KEY = "staticVariables";<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractAppender.Builder&lt;B&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> implements org.apache.logging.log4j.core.util.Builder&lt;RoutingAppender&gt; {<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> // Does not work unless the element is called "Script", I wanted "DefaultRounteScript"...<a name="line.63"></a>
<span class="sourceLineNo">064</span> @PluginElement("Script")<a name="line.64"></a>
<span class="sourceLineNo">065</span> private AbstractScript defaultRouteScript;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> @PluginElement("Routes")<a name="line.67"></a>
<span class="sourceLineNo">068</span> private Routes routes;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @PluginElement("RewritePolicy")<a name="line.70"></a>
<span class="sourceLineNo">071</span> private RewritePolicy rewritePolicy;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @PluginElement("PurgePolicy")<a name="line.73"></a>
<span class="sourceLineNo">074</span> private PurgePolicy purgePolicy;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public RoutingAppender build() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> final String name = getName();<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (name == null) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> LOGGER.error("No name defined for this RoutingAppender");<a name="line.80"></a>
<span class="sourceLineNo">081</span> return null;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (routes == null) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> LOGGER.error("No routes defined for RoutingAppender {}", name);<a name="line.84"></a>
<span class="sourceLineNo">085</span> return null;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> return new RoutingAppender(name, getFilter(), isIgnoreExceptions(), routes, rewritePolicy,<a name="line.87"></a>
<span class="sourceLineNo">088</span> getConfiguration(), purgePolicy, defaultRouteScript, getPropertyArray());<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> public Routes getRoutes() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return routes;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> public AbstractScript getDefaultRouteScript() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return defaultRouteScript;<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> public RewritePolicy getRewritePolicy() {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return rewritePolicy;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> public PurgePolicy getPurgePolicy() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return purgePolicy;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> public B withRoutes(@SuppressWarnings("hiding") final Routes routes) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.routes = routes;<a name="line.108"></a>
<span class="sourceLineNo">109</span> return asBuilder();<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> public B withDefaultRouteScript(@SuppressWarnings("hiding") final AbstractScript defaultRouteScript) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.defaultRouteScript = defaultRouteScript;<a name="line.113"></a>
<span class="sourceLineNo">114</span> return asBuilder();<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> public B withRewritePolicy(@SuppressWarnings("hiding") final RewritePolicy rewritePolicy) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> this.rewritePolicy = rewritePolicy;<a name="line.118"></a>
<span class="sourceLineNo">119</span> return asBuilder();<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> public void withPurgePolicy(@SuppressWarnings("hiding") final PurgePolicy purgePolicy) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> this.purgePolicy = purgePolicy;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> @PluginBuilderFactory<a name="line.128"></a>
<span class="sourceLineNo">129</span> public static &lt;B extends Builder&lt;B&gt;&gt; B newBuilder() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return new Builder&lt;B&gt;().asBuilder();<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> private static final String DEFAULT_KEY = "ROUTING_APPENDER_DEFAULT";<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> private final Routes routes;<a name="line.135"></a>
<span class="sourceLineNo">136</span> private Route defaultRoute;<a name="line.136"></a>
<span class="sourceLineNo">137</span> private final Configuration configuration;<a name="line.137"></a>
<span class="sourceLineNo">138</span> private final ConcurrentMap&lt;String, CreatedRouteAppenderControl&gt; createdAppenders = new ConcurrentHashMap&lt;&gt;();<a name="line.138"></a>
<span class="sourceLineNo">139</span> private final Map&lt;String, AppenderControl&gt; createdAppendersUnmodifiableView = Collections.unmodifiableMap(<a name="line.139"></a>
<span class="sourceLineNo">140</span> (Map&lt;String, AppenderControl&gt;) (Map&lt;String, ?&gt;) createdAppenders);<a name="line.140"></a>
<span class="sourceLineNo">141</span> private final ConcurrentMap&lt;String, RouteAppenderControl&gt; referencedAppenders = new ConcurrentHashMap&lt;&gt;();<a name="line.141"></a>
<span class="sourceLineNo">142</span> private final RewritePolicy rewritePolicy;<a name="line.142"></a>
<span class="sourceLineNo">143</span> private final PurgePolicy purgePolicy;<a name="line.143"></a>
<span class="sourceLineNo">144</span> private final AbstractScript defaultRouteScript;<a name="line.144"></a>
<span class="sourceLineNo">145</span> private final ConcurrentMap&lt;Object, Object&gt; scriptStaticVariables = new ConcurrentHashMap&lt;&gt;();<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> private RoutingAppender(final String name, final Filter filter, final boolean ignoreExceptions, final Routes routes,<a name="line.147"></a>
<span class="sourceLineNo">148</span> final RewritePolicy rewritePolicy, final Configuration configuration, final PurgePolicy purgePolicy,<a name="line.148"></a>
<span class="sourceLineNo">149</span> final AbstractScript defaultRouteScript, final Property[] properties) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> super(name, filter, null, ignoreExceptions, properties);<a name="line.150"></a>
<span class="sourceLineNo">151</span> this.routes = routes;<a name="line.151"></a>
<span class="sourceLineNo">152</span> this.configuration = configuration;<a name="line.152"></a>
<span class="sourceLineNo">153</span> this.rewritePolicy = rewritePolicy;<a name="line.153"></a>
<span class="sourceLineNo">154</span> this.purgePolicy = purgePolicy;<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (this.purgePolicy != null) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> this.purgePolicy.initialize(this);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> this.defaultRouteScript = defaultRouteScript;<a name="line.158"></a>
<span class="sourceLineNo">159</span> Route defRoute = null;<a name="line.159"></a>
<span class="sourceLineNo">160</span> for (final Route route : routes.getRoutes()) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (route.getKey() == null) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (defRoute == null) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> defRoute = route;<a name="line.163"></a>
<span class="sourceLineNo">164</span> } else {<a name="line.164"></a>
<span class="sourceLineNo">165</span> error("Multiple default routes. Route " + route.toString() + " will be ignored");<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> defaultRoute = defRoute;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> @Override<a name="line.172"></a>
<span class="sourceLineNo">173</span> public void start() {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if (defaultRouteScript != null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (configuration == null) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> error("No Configuration defined for RoutingAppender; required for Script element.");<a name="line.176"></a>
<span class="sourceLineNo">177</span> } else {<a name="line.177"></a>
<span class="sourceLineNo">178</span> final ScriptManager scriptManager = configuration.getScriptManager();<a name="line.178"></a>
<span class="sourceLineNo">179</span> scriptManager.addScript(defaultRouteScript);<a name="line.179"></a>
<span class="sourceLineNo">180</span> final Bindings bindings = scriptManager.createBindings(defaultRouteScript);<a name="line.180"></a>
<span class="sourceLineNo">181</span> bindings.put(STATIC_VARIABLES_KEY, scriptStaticVariables);<a name="line.181"></a>
<span class="sourceLineNo">182</span> final Object object = scriptManager.execute(defaultRouteScript.getName(), bindings);<a name="line.182"></a>
<span class="sourceLineNo">183</span> final Route route = routes.getRoute(Objects.toString(object, null));<a name="line.183"></a>
<span class="sourceLineNo">184</span> if (route != null) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> defaultRoute = route;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> // Register all the static routes.<a name="line.189"></a>
<span class="sourceLineNo">190</span> for (final Route route : routes.getRoutes()) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> if (route.getAppenderRef() != null) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> final Appender appender = configuration.getAppender(route.getAppenderRef());<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (appender != null) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> final String key = route == defaultRoute ? DEFAULT_KEY : route.getKey();<a name="line.194"></a>
<span class="sourceLineNo">195</span> referencedAppenders.put(key, new ReferencedRouteAppenderControl(appender));<a name="line.195"></a>
<span class="sourceLineNo">196</span> } else {<a name="line.196"></a>
<span class="sourceLineNo">197</span> error("Appender " + route.getAppenderRef() + " cannot be located. Route ignored");<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<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> super.start();<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> @Override<a name="line.204"></a>
<span class="sourceLineNo">205</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> setStopping();<a name="line.206"></a>
<span class="sourceLineNo">207</span> super.stop(timeout, timeUnit, false);<a name="line.207"></a>
<span class="sourceLineNo">208</span> // Only stop appenders that were created by this RoutingAppender<a name="line.208"></a>
<span class="sourceLineNo">209</span> for (final Map.Entry&lt;String, CreatedRouteAppenderControl&gt; entry : createdAppenders.entrySet()) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> final Appender appender = entry.getValue().getAppender();<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (appender instanceof LifeCycle2) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> ((LifeCycle2) appender).stop(timeout, timeUnit);<a name="line.212"></a>
<span class="sourceLineNo">213</span> } else {<a name="line.213"></a>
<span class="sourceLineNo">214</span> appender.stop();<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> setStopped();<a name="line.217"></a>
<span class="sourceLineNo">218</span> return true;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> @Override<a name="line.221"></a>
<span class="sourceLineNo">222</span> public void append(LogEvent event) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (rewritePolicy != null) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> event = rewritePolicy.rewrite(event);<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> final String pattern = routes.getPattern(event, scriptStaticVariables);<a name="line.226"></a>
<span class="sourceLineNo">227</span> final String key = pattern != null ? configuration.getStrSubstitutor().replace(event, pattern) :<a name="line.227"></a>
<span class="sourceLineNo">228</span> defaultRoute.getKey() != null ? defaultRoute.getKey() : DEFAULT_KEY;<a name="line.228"></a>
<span class="sourceLineNo">229</span> final RouteAppenderControl control = getControl(key, event);<a name="line.229"></a>
<span class="sourceLineNo">230</span> if (control != null) {<a name="line.230"></a>
<span class="sourceLineNo">231</span> try {<a name="line.231"></a>
<span class="sourceLineNo">232</span> control.callAppender(event);<a name="line.232"></a>
<span class="sourceLineNo">233</span> } finally {<a name="line.233"></a>
<span class="sourceLineNo">234</span> control.release();<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> updatePurgePolicy(key, event);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> private void updatePurgePolicy(final String key, final LogEvent event) {<a name="line.240"></a>
<span class="sourceLineNo">241</span> if (purgePolicy != null<a name="line.241"></a>
<span class="sourceLineNo">242</span> // LOG4J2-2631: PurgePolicy implementations do not need to be aware of appenders that<a name="line.242"></a>
<span class="sourceLineNo">243</span> // were not created by this RoutingAppender.<a name="line.243"></a>
<span class="sourceLineNo">244</span> &amp;&amp; !referencedAppenders.containsKey(key)) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> purgePolicy.update(key, event);<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span> }<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span> private synchronized RouteAppenderControl getControl(final String key, final LogEvent event) {<a name="line.249"></a>
<span class="sourceLineNo">250</span> RouteAppenderControl control = getAppender(key);<a name="line.250"></a>
<span class="sourceLineNo">251</span> if (control != null) {<a name="line.251"></a>
<span class="sourceLineNo">252</span> control.checkout();<a name="line.252"></a>
<span class="sourceLineNo">253</span> return control;<a name="line.253"></a>
<span class="sourceLineNo">254</span> }<a name="line.254"></a>
<span class="sourceLineNo">255</span> Route route = null;<a name="line.255"></a>
<span class="sourceLineNo">256</span> for (final Route r : routes.getRoutes()) {<a name="line.256"></a>
<span class="sourceLineNo">257</span> if (r.getAppenderRef() == null &amp;&amp; key.equals(r.getKey())) {<a name="line.257"></a>
<span class="sourceLineNo">258</span> route = r;<a name="line.258"></a>
<span class="sourceLineNo">259</span> break;<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> if (route == null) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> route = defaultRoute;<a name="line.263"></a>
<span class="sourceLineNo">264</span> control = getAppender(DEFAULT_KEY);<a name="line.264"></a>
<span class="sourceLineNo">265</span> if (control != null) {<a name="line.265"></a>
<span class="sourceLineNo">266</span> control.checkout();<a name="line.266"></a>
<span class="sourceLineNo">267</span> return control;<a name="line.267"></a>
<span class="sourceLineNo">268</span> }<a name="line.268"></a>
<span class="sourceLineNo">269</span> }<a name="line.269"></a>
<span class="sourceLineNo">270</span> if (route != null) {<a name="line.270"></a>
<span class="sourceLineNo">271</span> final Appender app = createAppender(route, event);<a name="line.271"></a>
<span class="sourceLineNo">272</span> if (app == null) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> return null;<a name="line.273"></a>
<span class="sourceLineNo">274</span> }<a name="line.274"></a>
<span class="sourceLineNo">275</span> CreatedRouteAppenderControl created = new CreatedRouteAppenderControl(app);<a name="line.275"></a>
<span class="sourceLineNo">276</span> control = created;<a name="line.276"></a>
<span class="sourceLineNo">277</span> createdAppenders.put(key, created);<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> if (control != null) {<a name="line.280"></a>
<span class="sourceLineNo">281</span> control.checkout();<a name="line.281"></a>
<span class="sourceLineNo">282</span> }<a name="line.282"></a>
<span class="sourceLineNo">283</span> return control;<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span> private RouteAppenderControl getAppender(final String key) {<a name="line.286"></a>
<span class="sourceLineNo">287</span> final RouteAppenderControl result = referencedAppenders.get(key);<a name="line.287"></a>
<span class="sourceLineNo">288</span> if (result == null) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> return createdAppenders.get(key);<a name="line.289"></a>
<span class="sourceLineNo">290</span> }<a name="line.290"></a>
<span class="sourceLineNo">291</span> return result;<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span> private Appender createAppender(final Route route, final LogEvent event) {<a name="line.294"></a>
<span class="sourceLineNo">295</span> final Node routeNode = route.getNode();<a name="line.295"></a>
<span class="sourceLineNo">296</span> for (final Node node : routeNode.getChildren()) {<a name="line.296"></a>
<span class="sourceLineNo">297</span> if (node.getType().getElementName().equals(Appender.ELEMENT_TYPE)) {<a name="line.297"></a>
<span class="sourceLineNo">298</span> final Node appNode = new Node(node);<a name="line.298"></a>
<span class="sourceLineNo">299</span> configuration.createConfiguration(appNode, event);<a name="line.299"></a>
<span class="sourceLineNo">300</span> if (appNode.getObject() instanceof Appender) {<a name="line.300"></a>
<span class="sourceLineNo">301</span> final Appender app = appNode.getObject();<a name="line.301"></a>
<span class="sourceLineNo">302</span> app.start();<a name="line.302"></a>
<span class="sourceLineNo">303</span> return app;<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span> error("Unable to create Appender of type " + node.getName());<a name="line.305"></a>
<span class="sourceLineNo">306</span> return null;<a name="line.306"></a>
<span class="sourceLineNo">307</span> }<a name="line.307"></a>
<span class="sourceLineNo">308</span> }<a name="line.308"></a>
<span class="sourceLineNo">309</span> error("No Appender was configured for route " + route.getKey());<a name="line.309"></a>
<span class="sourceLineNo">310</span> return null;<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> /**<a name="line.313"></a>
<span class="sourceLineNo">314</span> * Returns an unmodifiable view of the appenders created by this {@link RoutingAppender}.<a name="line.314"></a>
<span class="sourceLineNo">315</span> * Note that this map does not contain appenders that are routed by reference.<a name="line.315"></a>
<span class="sourceLineNo">316</span> */<a name="line.316"></a>
<span class="sourceLineNo">317</span> public Map&lt;String, AppenderControl&gt; getAppenders() {<a name="line.317"></a>
<span class="sourceLineNo">318</span> return createdAppendersUnmodifiableView;<a name="line.318"></a>
<span class="sourceLineNo">319</span> }<a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span> /**<a name="line.321"></a>
<span class="sourceLineNo">322</span> * Deletes the specified appender.<a name="line.322"></a>
<span class="sourceLineNo">323</span> *<a name="line.323"></a>
<span class="sourceLineNo">324</span> * @param key The appender's key<a name="line.324"></a>
<span class="sourceLineNo">325</span> */<a name="line.325"></a>
<span class="sourceLineNo">326</span> public void deleteAppender(final String key) {<a name="line.326"></a>
<span class="sourceLineNo">327</span> LOGGER.debug("Deleting route with {} key ", key);<a name="line.327"></a>
<span class="sourceLineNo">328</span> // LOG4J2-2631: Only appenders created by this RoutingAppender are eligible for deletion.<a name="line.328"></a>
<span class="sourceLineNo">329</span> final CreatedRouteAppenderControl control = createdAppenders.remove(key);<a name="line.329"></a>
<span class="sourceLineNo">330</span> if (null != control) {<a name="line.330"></a>
<span class="sourceLineNo">331</span> LOGGER.debug("Stopping route with {} key", key);<a name="line.331"></a>
<span class="sourceLineNo">332</span> // Synchronize with getControl to avoid triggering stopAppender before RouteAppenderControl.checkout<a name="line.332"></a>
<span class="sourceLineNo">333</span> // can be invoked.<a name="line.333"></a>
<span class="sourceLineNo">334</span> synchronized (this) {<a name="line.334"></a>
<span class="sourceLineNo">335</span> control.pendingDeletion = true;<a name="line.335"></a>
<span class="sourceLineNo">336</span> }<a name="line.336"></a>
<span class="sourceLineNo">337</span> // Don't attempt to stop the appender in a synchronized block, since it may block flushing events<a name="line.337"></a>
<span class="sourceLineNo">338</span> // to disk.<a name="line.338"></a>
<span class="sourceLineNo">339</span> control.tryStopAppender();<a name="line.339"></a>
<span class="sourceLineNo">340</span> } else {<a name="line.340"></a>
<span class="sourceLineNo">341</span> if (referencedAppenders.containsKey(key)) {<a name="line.341"></a>
<span class="sourceLineNo">342</span> LOGGER.debug("Route {} using an appender reference may not be removed because " +<a name="line.342"></a>
<span class="sourceLineNo">343</span> "the appender may be used outside of the RoutingAppender", key);<a name="line.343"></a>
<span class="sourceLineNo">344</span> } else {<a name="line.344"></a>
<span class="sourceLineNo">345</span> LOGGER.debug("Route with {} key already deleted", key);<a name="line.345"></a>
<span class="sourceLineNo">346</span> }<a name="line.346"></a>
<span class="sourceLineNo">347</span> }<a name="line.347"></a>
<span class="sourceLineNo">348</span> }<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> /**<a name="line.350"></a>
<span class="sourceLineNo">351</span> * Creates a RoutingAppender.<a name="line.351"></a>
<span class="sourceLineNo">352</span> * @param name The name of the Appender.<a name="line.352"></a>
<span class="sourceLineNo">353</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.353"></a>
<span class="sourceLineNo">354</span> * they are propagated to the caller.<a name="line.354"></a>
<span class="sourceLineNo">355</span> * @param routes The routing definitions.<a name="line.355"></a>
<span class="sourceLineNo">356</span> * @param config The Configuration (automatically added by the Configuration).<a name="line.356"></a>
<span class="sourceLineNo">357</span> * @param rewritePolicy A RewritePolicy, if any.<a name="line.357"></a>
<span class="sourceLineNo">358</span> * @param filter A Filter to restrict events processed by the Appender or null.<a name="line.358"></a>
<span class="sourceLineNo">359</span> * @return The RoutingAppender<a name="line.359"></a>
<span class="sourceLineNo">360</span> * @deprecated Since 2.7; use {@link #newBuilder()}<a name="line.360"></a>
<span class="sourceLineNo">361</span> */<a name="line.361"></a>
<span class="sourceLineNo">362</span> @Deprecated<a name="line.362"></a>
<span class="sourceLineNo">363</span> public static RoutingAppender createAppender(<a name="line.363"></a>
<span class="sourceLineNo">364</span> final String name,<a name="line.364"></a>
<span class="sourceLineNo">365</span> final String ignore,<a name="line.365"></a>
<span class="sourceLineNo">366</span> final Routes routes,<a name="line.366"></a>
<span class="sourceLineNo">367</span> final Configuration config,<a name="line.367"></a>
<span class="sourceLineNo">368</span> final RewritePolicy rewritePolicy,<a name="line.368"></a>
<span class="sourceLineNo">369</span> final PurgePolicy purgePolicy,<a name="line.369"></a>
<span class="sourceLineNo">370</span> final Filter filter) {<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.372"></a>
<span class="sourceLineNo">373</span> if (name == null) {<a name="line.373"></a>
<span class="sourceLineNo">374</span> LOGGER.error("No name provided for RoutingAppender");<a name="line.374"></a>
<span class="sourceLineNo">375</span> return null;<a name="line.375"></a>
<span class="sourceLineNo">376</span> }<a name="line.376"></a>
<span class="sourceLineNo">377</span> if (routes == null) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> LOGGER.error("No routes defined for RoutingAppender");<a name="line.378"></a>
<span class="sourceLineNo">379</span> return null;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span> return new RoutingAppender(name, filter, ignoreExceptions, routes, rewritePolicy, config, purgePolicy, null, null);<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> public Route getDefaultRoute() {<a name="line.384"></a>
<span class="sourceLineNo">385</span> return defaultRoute;<a name="line.385"></a>
<span class="sourceLineNo">386</span> }<a name="line.386"></a>
<span class="sourceLineNo">387</span><a name="line.387"></a>
<span class="sourceLineNo">388</span> public AbstractScript getDefaultRouteScript() {<a name="line.388"></a>
<span class="sourceLineNo">389</span> return defaultRouteScript;<a name="line.389"></a>
<span class="sourceLineNo">390</span> }<a name="line.390"></a>
<span class="sourceLineNo">391</span><a name="line.391"></a>
<span class="sourceLineNo">392</span> public PurgePolicy getPurgePolicy() {<a name="line.392"></a>
<span class="sourceLineNo">393</span> return purgePolicy;<a name="line.393"></a>
<span class="sourceLineNo">394</span> }<a name="line.394"></a>
<span class="sourceLineNo">395</span><a name="line.395"></a>
<span class="sourceLineNo">396</span> public RewritePolicy getRewritePolicy() {<a name="line.396"></a>
<span class="sourceLineNo">397</span> return rewritePolicy;<a name="line.397"></a>
<span class="sourceLineNo">398</span> }<a name="line.398"></a>
<span class="sourceLineNo">399</span><a name="line.399"></a>
<span class="sourceLineNo">400</span> public Routes getRoutes() {<a name="line.400"></a>
<span class="sourceLineNo">401</span> return routes;<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span><a name="line.403"></a>
<span class="sourceLineNo">404</span> public Configuration getConfiguration() {<a name="line.404"></a>
<span class="sourceLineNo">405</span> return configuration;<a name="line.405"></a>
<span class="sourceLineNo">406</span> }<a name="line.406"></a>
<span class="sourceLineNo">407</span><a name="line.407"></a>
<span class="sourceLineNo">408</span> public ConcurrentMap&lt;Object, Object&gt; getScriptStaticVariables() {<a name="line.408"></a>
<span class="sourceLineNo">409</span> return scriptStaticVariables;<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span><a name="line.411"></a>
<span class="sourceLineNo">412</span> /**<a name="line.412"></a>
<span class="sourceLineNo">413</span> * LOG4J2-2629: PurgePolicy implementations can invoke {@link #deleteAppender(String)} after we have looked up<a name="line.413"></a>
<span class="sourceLineNo">414</span> * an instance of a target appender but before events are appended, which could result in events not being<a name="line.414"></a>
<span class="sourceLineNo">415</span> * recorded to any appender.<a name="line.415"></a>
<span class="sourceLineNo">416</span> * This extension of {@link AppenderControl} allows to to mark usage of an appender, allowing deferral of<a name="line.416"></a>
<span class="sourceLineNo">417</span> * {@link Appender#stop()} until events have successfully been recorded.<a name="line.417"></a>
<span class="sourceLineNo">418</span> * Alternative approaches considered:<a name="line.418"></a>
<span class="sourceLineNo">419</span> * - More aggressive synchronization: Appenders may do expensive I/O that shouldn't block routing.<a name="line.419"></a>
<span class="sourceLineNo">420</span> * - Move the 'updatePurgePolicy' invocation before appenders are called: Unfortunately this approach doesn't work<a name="line.420"></a>
<span class="sourceLineNo">421</span> * if we consider an ImmediatePurgePolicy (or IdlePurgePolicy with a very small timeout) because it may attempt<a name="line.421"></a>
<span class="sourceLineNo">422</span> * to remove an appender that doesn't exist yet. It's counterintuitive to get an event that a route has been<a name="line.422"></a>
<span class="sourceLineNo">423</span> * used at a point when we expect the route doesn't exist in {@link #getAppenders()}.<a name="line.423"></a>
<span class="sourceLineNo">424</span> */<a name="line.424"></a>
<span class="sourceLineNo">425</span> private static abstract class RouteAppenderControl extends AppenderControl {<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> RouteAppenderControl(Appender appender) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> super(appender, null, null);<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> abstract void checkout();<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span> abstract void release();<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>
<span class="sourceLineNo">436</span> private static final class CreatedRouteAppenderControl extends RouteAppenderControl {<a name="line.436"></a>
<span class="sourceLineNo">437</span><a name="line.437"></a>
<span class="sourceLineNo">438</span> private volatile boolean pendingDeletion = false;<a name="line.438"></a>
<span class="sourceLineNo">439</span> private final AtomicInteger depth = new AtomicInteger();<a name="line.439"></a>
<span class="sourceLineNo">440</span><a name="line.440"></a>
<span class="sourceLineNo">441</span> CreatedRouteAppenderControl(Appender appender) {<a name="line.441"></a>
<span class="sourceLineNo">442</span> super(appender);<a name="line.442"></a>
<span class="sourceLineNo">443</span> }<a name="line.443"></a>
<span class="sourceLineNo">444</span><a name="line.444"></a>
<span class="sourceLineNo">445</span> @Override<a name="line.445"></a>
<span class="sourceLineNo">446</span> void checkout() {<a name="line.446"></a>
<span class="sourceLineNo">447</span> if (pendingDeletion) {<a name="line.447"></a>
<span class="sourceLineNo">448</span> LOGGER.warn("CreatedRouteAppenderControl.checkout invoked on a " +<a name="line.448"></a>
<span class="sourceLineNo">449</span> "RouteAppenderControl that is pending deletion");<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span> depth.incrementAndGet();<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span> @Override<a name="line.454"></a>
<span class="sourceLineNo">455</span> void release() {<a name="line.455"></a>
<span class="sourceLineNo">456</span> depth.decrementAndGet();<a name="line.456"></a>
<span class="sourceLineNo">457</span> tryStopAppender();<a name="line.457"></a>
<span class="sourceLineNo">458</span> }<a name="line.458"></a>
<span class="sourceLineNo">459</span><a name="line.459"></a>
<span class="sourceLineNo">460</span> void tryStopAppender() {<a name="line.460"></a>
<span class="sourceLineNo">461</span> if (pendingDeletion<a name="line.461"></a>
<span class="sourceLineNo">462</span> // Only attempt to stop the appender if we can CaS the depth away from zero, otherwise either<a name="line.462"></a>
<span class="sourceLineNo">463</span> // 1. Another invocation of tryStopAppender has succeeded, or<a name="line.463"></a>
<span class="sourceLineNo">464</span> // 2. Events are being appended, and will trigger stop when they complete<a name="line.464"></a>
<span class="sourceLineNo">465</span> &amp;&amp; depth.compareAndSet(0, -100_000)) {<a name="line.465"></a>
<span class="sourceLineNo">466</span> Appender appender = getAppender();<a name="line.466"></a>
<span class="sourceLineNo">467</span> LOGGER.debug("Stopping appender {}", appender);<a name="line.467"></a>
<span class="sourceLineNo">468</span> appender.stop();<a name="line.468"></a>
<span class="sourceLineNo">469</span> }<a name="line.469"></a>
<span class="sourceLineNo">470</span> }<a name="line.470"></a>
<span class="sourceLineNo">471</span> }<a name="line.471"></a>
<span class="sourceLineNo">472</span><a name="line.472"></a>
<span class="sourceLineNo">473</span> private static final class ReferencedRouteAppenderControl extends RouteAppenderControl {<a name="line.473"></a>
<span class="sourceLineNo">474</span><a name="line.474"></a>
<span class="sourceLineNo">475</span> ReferencedRouteAppenderControl(Appender appender) {<a name="line.475"></a>
<span class="sourceLineNo">476</span> super(appender);<a name="line.476"></a>
<span class="sourceLineNo">477</span> }<a name="line.477"></a>
<span class="sourceLineNo">478</span><a name="line.478"></a>
<span class="sourceLineNo">479</span> @Override<a name="line.479"></a>
<span class="sourceLineNo">480</span> void checkout() {<a name="line.480"></a>
<span class="sourceLineNo">481</span> // nop<a name="line.481"></a>
<span class="sourceLineNo">482</span> }<a name="line.482"></a>
<span class="sourceLineNo">483</span><a name="line.483"></a>
<span class="sourceLineNo">484</span> @Override<a name="line.484"></a>
<span class="sourceLineNo">485</span> void release() {<a name="line.485"></a>
<span class="sourceLineNo">486</span> // nop<a name="line.486"></a>
<span class="sourceLineNo">487</span> }<a name="line.487"></a>
<span class="sourceLineNo">488</span> }<a name="line.488"></a>
<span class="sourceLineNo">489</span>}<a name="line.489"></a>
</pre>
</div>
</body>
</html>