| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.log4j;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.log4j.helpers.QuietWriter;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.log4j.spi.ErrorHandler;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.log4j.spi.LoggingEvent;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.io.IOException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.io.InterruptedIOException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.io.OutputStream;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.io.OutputStreamWriter;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.io.Writer;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>/**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * WriterAppender appends log events to a {@link Writer} or an<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * {@link OutputStream} depending on the user's choice.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>public class WriterAppender extends AppenderSkeleton {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private static final org.apache.logging.log4j.Logger LOGGER = StatusLogger.getLogger();<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Immediate flush means that the underlying writer or output stream<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * will be flushed at the end of each append operation unless shouldFlush()<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * is overridden. Immediate<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * flush is slower but ensures that each append request is actually<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * written. If <code>immediateFlush</code> is set to<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <code>false</code>, then there is a good chance that the last few<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * logs events are not actually written to persistent media if and<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * when the application crashes.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <p>The <code>immediateFlush</code> variable is set to<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <code>true</code> by default.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> protected boolean immediateFlush = true;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * The encoding to use when writing. <p>The<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <code>encoding</code> variable is set to <code>null</null> by<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * default which results in the utilization of the system's default<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * encoding.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> protected String encoding;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * This is the {@link QuietWriter quietWriter} where we will write<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * to.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> protected QuietWriter qw;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * This default constructor does nothing.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public WriterAppender() {<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> * Instantiate a WriterAppender and set the output destination to a<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * new {@link OutputStreamWriter} initialized with <code>os</code><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * as its {@link OutputStream}.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public WriterAppender(Layout layout, OutputStream os) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this(layout, new OutputStreamWriter(os));<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> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Instantiate a WriterAppender and set the output destination to<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <code>writer</code>.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <p>The <code>writer</code> must have been previously opened by<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * the user.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public WriterAppender(Layout layout, Writer writer) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.layout = layout;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.setWriter(writer);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<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> * Returns value of the <b>ImmediateFlush</b> option.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public boolean getImmediateFlush() {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return immediateFlush;<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> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * If the <b>ImmediateFlush</b> option is set to<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <code>true</code>, the appender will flush at the end of each<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * write. This is the default behavior. If the option is set to<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <code>false</code>, then the underlying stream can defer writing<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * to physical medium to a later time.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <p>Avoiding the flush operation at the end of each append results in<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * a performance gain of 10 to 20 percent. However, there is safety<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * tradeoff involved in skipping flushing. Indeed, when flushing is<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * skipped, then it is likely that the last few log events will not<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * be recorded on disk when the application exits. This is a high<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * price to pay even for a 20% performance gain.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public void setImmediateFlush(boolean value) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> immediateFlush = value;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<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> * Does nothing.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public void activateOptions() {<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> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * This method is called by the {@link AppenderSkeleton#doAppend}<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * method.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> *<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <p>If the output stream exists and is writable then write a log<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * statement to the output stream. Otherwise, write a single warning<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * message to <code>System.err</code>.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <p>The format of the output will depend on this appender's<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * layout.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public void append(LoggingEvent event) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> // Reminder: the nesting of calls is:<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> //<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // doAppend()<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> // - check threshold<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> // - filter<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // - append();<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> // - checkEntryConditions();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> // - subAppend();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (!checkEntryConditions()) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return;<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> subAppend(event);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * This method determines if there is a sense in attempting to append.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> *<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * <p>It checks whether there is a set output target and also if<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * there is a set layout. If these checks fail, then the boolean<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * value <code>false</code> is returned.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> protected boolean checkEntryConditions() {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> if (this.closed) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> LOGGER.warn("Not allowed to write to a closed appender.");<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return false;<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> if (this.qw == null) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> errorHandler.error("No output stream or file set for the appender named [" + name + "].");<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return false;<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (this.layout == null) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> errorHandler.error("No layout set for the appender named [" + name + "].");<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return false;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return true;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><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> * Close this appender instance. The underlying stream or writer is<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * also closed.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> *<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <p>Closed appenders cannot be reused.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> *<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @see #setWriter<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @since 0.8.4<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> synchronized void close() {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (this.closed) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> this.closed = true;<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> writeFooter();<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> reset();<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> /**<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * Close the underlying {@link Writer}.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> protected void closeWriter() {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> if (qw != null) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> try {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> qw.close();<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> } catch (IOException e) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (e instanceof InterruptedIOException) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> Thread.currentThread().interrupt();<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> // There is do need to invoke an error handler at this late<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> // stage.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> LOGGER.error("Could not close " + qw, e);<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> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Returns an OutputStreamWriter when passed an OutputStream. The<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * encoding used will depend on the value of the<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * <code>encoding</code> property. If the encoding value is<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * specified incorrectly the writer will be opened using the default<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * system encoding (an error message will be printed to the LOGGER.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> protected OutputStreamWriter createWriter(OutputStream os) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> OutputStreamWriter retval = null;<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> String enc = getEncoding();<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> if (enc != null) {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> try {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> retval = new OutputStreamWriter(os, enc);<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> } catch (IOException e) {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> if (e instanceof InterruptedIOException) {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> Thread.currentThread().interrupt();<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> }<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> LOGGER.warn("Error initializing output writer.");<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> LOGGER.warn("Unsupported encoding?");<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> if (retval == null) {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> retval = new OutputStreamWriter(os);<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> }<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> return retval;<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> public String getEncoding() {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> return encoding;<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> }<a name="line.249"></a> |
| <span class="sourceLineNo">250</span><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public void setEncoding(String value) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> encoding = value;<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> /**<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Set the {@link ErrorHandler} for this WriterAppender and also the<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * underlying {@link QuietWriter} if any.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> public synchronized void setErrorHandler(ErrorHandler eh) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> if (eh == null) {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> LOGGER.warn("You have tried to set a null error-handler.");<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> } else {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> this.errorHandler = eh;<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> if (this.qw != null) {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> this.qw.setErrorHandler(eh);<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<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><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> /**<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <p>Sets the Writer where the log output will go. The<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * specified Writer must be opened by the user and be<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * writable.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> *<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * <p>The <code>java.io.Writer</code> will be closed when the<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * appender instance is closed.<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> * <p><b>WARNING:</b> Logging to an unopened Writer will fail.<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * <p><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @param writer An already opened Writer.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public synchronized void setWriter(Writer writer) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> reset();<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> this.qw = new QuietWriter(writer, errorHandler);<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> //this.tp = new TracerPrintWriter(qw);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> writeHeader();<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span><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> * Actual writing occurs here.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> *<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * <p>Most subclasses of <code>WriterAppender</code> will need to<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * override this method.<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> *<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @since 0.9.0<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> */<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> protected void subAppend(LoggingEvent event) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> this.qw.write(this.layout.format(event));<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> if (layout.ignoresThrowable()) {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> String[] s = event.getThrowableStrRep();<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> if (s != null) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> int len = s.length;<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> for (int i = 0; i < len; i++) {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> this.qw.write(s[i]);<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> this.qw.write(Layout.LINE_SEP);<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><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> if (shouldFlush(event)) {<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> this.qw.flush();<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<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> * The WriterAppender requires a layout. Hence, this method returns<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * <code>true</code>.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> */<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> public boolean requiresLayout() {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> return true;<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> /**<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * Clear internal references to the writer and other variables.<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * <p><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * Subclasses can override this method for an alternate closing<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * behavior.<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> */<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> protected void reset() {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> closeWriter();<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> this.qw = null;<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> //this.tp = null;<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span><a name="line.340"></a> |
| <span class="sourceLineNo">341</span><a name="line.341"></a> |
| <span class="sourceLineNo">342</span> /**<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * Write a footer as produced by the embedded layout's {@link<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * Layout#getFooter} method.<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> */<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> protected void writeFooter() {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> if (layout != null) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> String f = layout.getFooter();<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> if (f != null && this.qw != null) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> this.qw.write(f);<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> this.qw.flush();<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> /**<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * Write a header as produced by the embedded layout's {@link<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * Layout#getHeader} method.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> */<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> protected void writeHeader() {<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> if (layout != null) {<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> String h = layout.getHeader();<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> if (h != null && this.qw != null) {<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> this.qw.write(h);<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> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> /**<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * Determines whether the writer should be flushed after<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * this event is written.<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> *<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @since 1.2.16<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> */<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> protected boolean shouldFlush(final LoggingEvent event) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> return immediateFlush;<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> }<a name="line.377"></a> |
| <span class="sourceLineNo">378</span>}<a name="line.378"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
