| <!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.util.Objects;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.Level;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Appender;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Filter;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.appender.AppenderLoggingException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.filter.AbstractFilterable;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.filter.Filterable;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.PerformanceSensitive;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Wraps an {@link Appender} with details an appender implementation shouldn't need to know about.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public class AppenderControl extends AbstractFilterable {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> private final ThreadLocal<AppenderControl> recursive = new ThreadLocal<>();<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private final Appender appender;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private final Level level;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> private final int intLevel;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private final String appenderName;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Constructor.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @param appender The target Appender.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @param level the Level to filter on.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param filter the Filter(s) to apply.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public AppenderControl(final Appender appender, final Level level, final Filter filter) {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> super(filter);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this.appender = appender;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.appenderName = appender.getName();<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> this.level = level;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> this.intLevel = level == null ? Level.ALL.intLevel() : level.intLevel();<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> start();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Returns the name the appender had when this AppenderControl was constructed.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return the appender name<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public String getAppenderName() {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> return appenderName;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Returns the Appender.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @return the Appender.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public Appender getAppender() {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return appender;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Call the appender.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param event The event to process.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public void callAppender(final LogEvent event) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if (shouldSkip(event)) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> callAppenderPreventRecursion(event);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private boolean shouldSkip(final LogEvent event) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> return isFilteredByAppenderControl(event) || isFilteredByLevel(event) || isRecursiveCall();<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> @PerformanceSensitive<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private boolean isFilteredByAppenderControl(final LogEvent event) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final Filter filter = getFilter();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> return filter != null && Filter.Result.DENY == filter.filter(event);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @PerformanceSensitive<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private boolean isFilteredByLevel(final LogEvent event) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return level != null && intLevel < event.getLevel().intLevel();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @PerformanceSensitive<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> private boolean isRecursiveCall() {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> if (recursive.get() != null) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> appenderErrorHandlerMessage("Recursive call to appender ");<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return true;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> return false;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> private String appenderErrorHandlerMessage(final String prefix) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> final String result = createErrorMsg(prefix);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> appender.getHandler().error(result);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return result;<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> private void callAppenderPreventRecursion(final LogEvent event) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> try {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> recursive.set(this);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> callAppender0(event);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> } finally {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> recursive.set(null);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> private void callAppender0(final LogEvent event) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> ensureAppenderStarted();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (!isFilteredByAppender(event)) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> tryCallAppender(event);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<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 void ensureAppenderStarted() {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> if (!appender.isStarted()) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> handleError("Attempted to append to non-started appender ");<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> private void handleError(final String prefix) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> final String msg = appenderErrorHandlerMessage(prefix);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> if (!appender.ignoreExceptions()) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> throw new AppenderLoggingException(msg);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> private String createErrorMsg(final String prefix) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return prefix + appender.getName();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> private boolean isFilteredByAppender(final LogEvent event) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return appender instanceof Filterable && ((Filterable) appender).isFiltered(event);<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> private void tryCallAppender(final LogEvent event) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> try {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> appender.append(event);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> } catch (final RuntimeException ex) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> handleAppenderError(event, ex);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> } catch (final Exception ex) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> handleAppenderError(event, new AppenderLoggingException(ex));<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> private void handleAppenderError(final LogEvent event, final RuntimeException ex) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> appender.getHandler().error(createErrorMsg("An exception occurred processing Appender "), event, ex);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> if (!appender.ignoreExceptions()) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> throw ex;<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><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // AppenderControl is a helper object whose purpose is to make it<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> // easier for LoggerConfig to manage and invoke Appenders.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> // LoggerConfig manages Appenders by their name. To facilitate this,<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> // two AppenderControl objects are considered equal if and only<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> // if they have the same appender name.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> @Override<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public boolean equals(final Object obj) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (obj == this) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return true;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> if (!(obj instanceof AppenderControl)) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return false;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> final AppenderControl other = (AppenderControl) obj;<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return Objects.equals(appenderName, other.appenderName);<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> @Override<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> public int hashCode() {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> return appenderName.hashCode();<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> @Override<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> public String toString() {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> return super.toString() + "[appender=" + appender + ", appenderName=" + appenderName + ", level=" + level<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> + ", intLevel=" + intLevel + ", recursive=" + recursive + ", filter=" + getFilter() + "]";<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span>}<a name="line.198"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |