blob: d4dc3bcaaf7c099c9ed327a30f4a5962e0f2ac10 [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><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 java.io.BufferedWriter;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.File;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.FileNotFoundException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.FileOutputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.InterruptedIOException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.Writer;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.log4j.helpers.LogLog;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.log4j.helpers.QuietWriter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.log4j.spi.ErrorCode;<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> * FileAppender appends log events to a file.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Support for &lt;code&gt;java.io.Writer&lt;/code&gt; and console appending has been deprecated and then removed. See the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * replacement solutions: {@link WriterAppender} and {@link ConsoleAppender}.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>public class FileAppender extends WriterAppender {<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> * Controls file truncatation. The default value for this variable is &lt;code&gt;true&lt;/code&gt;, meaning that by default a<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;code&gt;FileAppender&lt;/code&gt; will append to an existing file and not truncate it.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * This option is meaningful only if the FileAppender opens the file.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/p&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> protected boolean fileAppend = true;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * The name of the log file.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> protected String fileName = null;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Do we do bufferedIO?<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> protected boolean bufferedIO = false;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Determines the size of IO buffer be. Default is 8K.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> protected int bufferSize = 8 * 1024;<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> * The default constructor does not do anything.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public FileAppender() {<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Constructs a FileAppender and open the file designated by &lt;code&gt;filename&lt;/code&gt;. The opened filename will become the<a name="line.72"></a>
<span class="sourceLineNo">073</span> * output destination for this appender.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * The file will be appended to.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;/p&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public FileAppender(Layout layout, String filename) throws IOException {<a name="line.78"></a>
<span class="sourceLineNo">079</span> this(layout, filename, true);<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Constructs a FileAppender and open the file designated by &lt;code&gt;filename&lt;/code&gt;. The opened filename will become the<a name="line.83"></a>
<span class="sourceLineNo">084</span> * output destination for this appender.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;p&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> * If the &lt;code&gt;append&lt;/code&gt; parameter is true, the file will be appended to. Otherwise, the file designated by<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;code&gt;filename&lt;/code&gt; will be truncated before being opened.<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;/p&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> public FileAppender(Layout layout, String filename, boolean append) throws IOException {<a name="line.90"></a>
<span class="sourceLineNo">091</span> this.layout = layout;<a name="line.91"></a>
<span class="sourceLineNo">092</span> this.setFile(filename, append, false, bufferSize);<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> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Constructs a &lt;code&gt;FileAppender&lt;/code&gt; and open the file designated by &lt;code&gt;filename&lt;/code&gt;. The opened filename<a name="line.96"></a>
<span class="sourceLineNo">097</span> * will become the output destination for this appender.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * &lt;p&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span> * If the &lt;code&gt;append&lt;/code&gt; parameter is true, the file will be appended to. Otherwise, the file designated by<a name="line.99"></a>
<span class="sourceLineNo">100</span> * &lt;code&gt;filename&lt;/code&gt; will be truncated before being opened.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * &lt;/p&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> * &lt;p&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span> * If the &lt;code&gt;bufferedIO&lt;/code&gt; parameter is &lt;code&gt;true&lt;/code&gt;, then buffered IO will be used to write to the output<a name="line.103"></a>
<span class="sourceLineNo">104</span> * file.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;/p&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> */<a name="line.106"></a>
<span class="sourceLineNo">107</span> public FileAppender(Layout layout, String filename, boolean append, boolean bufferedIO, int bufferSize) throws IOException {<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.layout = layout;<a name="line.108"></a>
<span class="sourceLineNo">109</span> this.setFile(filename, append, bufferedIO, bufferSize);<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> /**<a name="line.112"></a>
<span class="sourceLineNo">113</span> * If the value of &lt;b&gt;File&lt;/b&gt; is not &lt;code&gt;null&lt;/code&gt;, then {@link #setFile} is called with the values of &lt;b&gt;File&lt;/b&gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> * and &lt;b&gt;Append&lt;/b&gt; properties.<a name="line.114"></a>
<span class="sourceLineNo">115</span> * <a name="line.115"></a>
<span class="sourceLineNo">116</span> * @since 0.8.1<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> public void activateOptions() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (fileName != null) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> try {<a name="line.120"></a>
<span class="sourceLineNo">121</span> setFile(fileName, fileAppend, bufferedIO, bufferSize);<a name="line.121"></a>
<span class="sourceLineNo">122</span> } catch (java.io.IOException e) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> errorHandler.error("setFile(" + fileName + "," + fileAppend + ") call failed.", e, ErrorCode.FILE_OPEN_FAILURE);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> } else {<a name="line.125"></a>
<span class="sourceLineNo">126</span> // LogLog.error("File option not set for appender ["+name+"].");<a name="line.126"></a>
<span class="sourceLineNo">127</span> LogLog.warn("File option not set for appender [" + name + "].");<a name="line.127"></a>
<span class="sourceLineNo">128</span> LogLog.warn("Are you using FileAppender instead of ConsoleAppender?");<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<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> * Closes the previously opened file.<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> protected void closeFile() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> if (this.qw != null) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> try {<a name="line.137"></a>
<span class="sourceLineNo">138</span> this.qw.close();<a name="line.138"></a>
<span class="sourceLineNo">139</span> } catch (java.io.IOException e) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (e instanceof InterruptedIOException) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> Thread.currentThread().interrupt();<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> // Exceptionally, it does not make sense to delegate to an<a name="line.143"></a>
<span class="sourceLineNo">144</span> // ErrorHandler. Since a closed appender is basically dead.<a name="line.144"></a>
<span class="sourceLineNo">145</span> LogLog.error("Could not close " + qw, e);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<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> /**<a name="line.150"></a>
<span class="sourceLineNo">151</span> * Returns the value of the &lt;b&gt;Append&lt;/b&gt; option.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public boolean getAppend() {<a name="line.153"></a>
<span class="sourceLineNo">154</span> return fileAppend;<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> /**<a name="line.157"></a>
<span class="sourceLineNo">158</span> * Get the value of the &lt;b&gt;BufferedIO&lt;/b&gt; option.<a name="line.158"></a>
<span class="sourceLineNo">159</span> * <a name="line.159"></a>
<span class="sourceLineNo">160</span> * &lt;p&gt;<a name="line.160"></a>
<span class="sourceLineNo">161</span> * BufferedIO will significatnly increase performance on heavily loaded systems.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * &lt;/p&gt;<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public boolean getBufferedIO() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return this.bufferedIO;<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> * Get the size of the IO buffer.<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> public int getBufferSize() {<a name="line.171"></a>
<span class="sourceLineNo">172</span> return this.bufferSize;<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> /** Returns the value of the &lt;b&gt;File&lt;/b&gt; option. */<a name="line.175"></a>
<span class="sourceLineNo">176</span> public String getFile() {<a name="line.176"></a>
<span class="sourceLineNo">177</span> return fileName;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
<span class="sourceLineNo">181</span> * Close any previously opened file and call the parent's &lt;code&gt;reset&lt;/code&gt;.<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> protected void reset() {<a name="line.183"></a>
<span class="sourceLineNo">184</span> closeFile();<a name="line.184"></a>
<span class="sourceLineNo">185</span> this.fileName = null;<a name="line.185"></a>
<span class="sourceLineNo">186</span> super.reset();<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> /**<a name="line.189"></a>
<span class="sourceLineNo">190</span> * The &lt;b&gt;Append&lt;/b&gt; option takes a boolean value. It is set to &lt;code&gt;true&lt;/code&gt; by default. If true, then<a name="line.190"></a>
<span class="sourceLineNo">191</span> * &lt;code&gt;File&lt;/code&gt; will be opened in append mode by {@link #setFile setFile} (see above). Otherwise, {@link #setFile<a name="line.191"></a>
<span class="sourceLineNo">192</span> * setFile} will open &lt;code&gt;File&lt;/code&gt; in truncate mode.<a name="line.192"></a>
<span class="sourceLineNo">193</span> * <a name="line.193"></a>
<span class="sourceLineNo">194</span> * &lt;p&gt;<a name="line.194"></a>
<span class="sourceLineNo">195</span> * Note: Actual opening of the file is made when {@link #activateOptions} is called, not when the options are set.<a name="line.195"></a>
<span class="sourceLineNo">196</span> * &lt;/p&gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> public void setAppend(boolean flag) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> fileAppend = flag;<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> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * The &lt;b&gt;BufferedIO&lt;/b&gt; option takes a boolean value. It is set to &lt;code&gt;false&lt;/code&gt; by default. If true, then<a name="line.203"></a>
<span class="sourceLineNo">204</span> * &lt;code&gt;File&lt;/code&gt; will be opened and the resulting {@link java.io.Writer} wrapped around a {@link BufferedWriter}.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * <a name="line.205"></a>
<span class="sourceLineNo">206</span> * BufferedIO will significatnly increase performance on heavily loaded systems.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * <a name="line.207"></a>
<span class="sourceLineNo">208</span> */<a name="line.208"></a>
<span class="sourceLineNo">209</span> public void setBufferedIO(boolean bufferedIO) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> this.bufferedIO = bufferedIO;<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (bufferedIO) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> immediateFlush = false;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<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> * Set the size of the IO buffer.<a name="line.217"></a>
<span class="sourceLineNo">218</span> */<a name="line.218"></a>
<span class="sourceLineNo">219</span> public void setBufferSize(int bufferSize) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> this.bufferSize = bufferSize;<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> /**<a name="line.223"></a>
<span class="sourceLineNo">224</span> * The &lt;b&gt;File&lt;/b&gt; property takes a string value which should be the name of the file to append to.<a name="line.224"></a>
<span class="sourceLineNo">225</span> * &lt;p&gt;<a name="line.225"></a>
<span class="sourceLineNo">226</span> * &lt;font color="#DD0044"&gt;&lt;b&gt;Note that the special values "System.out" or "System.err" are no longer honored.&lt;/b&gt;&lt;/font&gt;<a name="line.226"></a>
<span class="sourceLineNo">227</span> * &lt;/p&gt;<a name="line.227"></a>
<span class="sourceLineNo">228</span> * &lt;p&gt;<a name="line.228"></a>
<span class="sourceLineNo">229</span> * Note: Actual opening of the file is made when {@link #activateOptions} is called, not when the options are set.<a name="line.229"></a>
<span class="sourceLineNo">230</span> * &lt;/p&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> public void setFile(String file) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> // Trim spaces from both ends. The users probably does not want<a name="line.233"></a>
<span class="sourceLineNo">234</span> // trailing spaces in file names.<a name="line.234"></a>
<span class="sourceLineNo">235</span> String val = file.trim();<a name="line.235"></a>
<span class="sourceLineNo">236</span> fileName = val;<a name="line.236"></a>
<span class="sourceLineNo">237</span> }<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
<span class="sourceLineNo">240</span> * Sets and &lt;i&gt;opens&lt;/i&gt; the file where the log output will go. The specified file must be writable.<a name="line.240"></a>
<span class="sourceLineNo">241</span> * &lt;p&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span> * If there was already an opened file, then the previous file is closed first.<a name="line.242"></a>
<span class="sourceLineNo">243</span> * &lt;/p&gt;<a name="line.243"></a>
<span class="sourceLineNo">244</span> * &lt;p&gt;<a name="line.244"></a>
<span class="sourceLineNo">245</span> * &lt;b&gt;Do not use this method directly. To configure a FileAppender or one of its subclasses, set its properties one by<a name="line.245"></a>
<span class="sourceLineNo">246</span> * one and then call activateOptions.&lt;/b&gt;<a name="line.246"></a>
<span class="sourceLineNo">247</span> * &lt;/p&gt;<a name="line.247"></a>
<span class="sourceLineNo">248</span> * <a name="line.248"></a>
<span class="sourceLineNo">249</span> * @param fileName The path to the log file.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @param append If true will append to fileName. Otherwise will truncate fileName.<a name="line.250"></a>
<span class="sourceLineNo">251</span> */<a name="line.251"></a>
<span class="sourceLineNo">252</span> public synchronized void setFile(String fileName, boolean append, boolean bufferedIO, int bufferSize) throws IOException {<a name="line.252"></a>
<span class="sourceLineNo">253</span> LogLog.debug("setFile called: " + fileName + ", " + append);<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> // It does not make sense to have immediate flush and bufferedIO.<a name="line.255"></a>
<span class="sourceLineNo">256</span> if (bufferedIO) {<a name="line.256"></a>
<span class="sourceLineNo">257</span> setImmediateFlush(false);<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> reset();<a name="line.260"></a>
<span class="sourceLineNo">261</span> FileOutputStream ostream = null;<a name="line.261"></a>
<span class="sourceLineNo">262</span> try {<a name="line.262"></a>
<span class="sourceLineNo">263</span> //<a name="line.263"></a>
<span class="sourceLineNo">264</span> // attempt to create file<a name="line.264"></a>
<span class="sourceLineNo">265</span> //<a name="line.265"></a>
<span class="sourceLineNo">266</span> ostream = new FileOutputStream(fileName, append);<a name="line.266"></a>
<span class="sourceLineNo">267</span> } catch (FileNotFoundException ex) {<a name="line.267"></a>
<span class="sourceLineNo">268</span> //<a name="line.268"></a>
<span class="sourceLineNo">269</span> // if parent directory does not exist then<a name="line.269"></a>
<span class="sourceLineNo">270</span> // attempt to create it and try to create file<a name="line.270"></a>
<span class="sourceLineNo">271</span> // see bug 9150<a name="line.271"></a>
<span class="sourceLineNo">272</span> //<a name="line.272"></a>
<span class="sourceLineNo">273</span> String parentName = new File(fileName).getParent();<a name="line.273"></a>
<span class="sourceLineNo">274</span> if (parentName != null) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> File parentDir = new File(parentName);<a name="line.275"></a>
<span class="sourceLineNo">276</span> if (!parentDir.exists() &amp;&amp; parentDir.mkdirs()) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> ostream = new FileOutputStream(fileName, append);<a name="line.277"></a>
<span class="sourceLineNo">278</span> } else {<a name="line.278"></a>
<span class="sourceLineNo">279</span> throw ex;<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span> } else {<a name="line.281"></a>
<span class="sourceLineNo">282</span> throw ex;<a name="line.282"></a>
<span class="sourceLineNo">283</span> }<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span> Writer fw = createWriter(ostream);<a name="line.285"></a>
<span class="sourceLineNo">286</span> if (bufferedIO) {<a name="line.286"></a>
<span class="sourceLineNo">287</span> fw = new BufferedWriter(fw, bufferSize);<a name="line.287"></a>
<span class="sourceLineNo">288</span> }<a name="line.288"></a>
<span class="sourceLineNo">289</span> this.setQWForFiles(fw);<a name="line.289"></a>
<span class="sourceLineNo">290</span> this.fileName = fileName;<a name="line.290"></a>
<span class="sourceLineNo">291</span> this.fileAppend = append;<a name="line.291"></a>
<span class="sourceLineNo">292</span> this.bufferedIO = bufferedIO;<a name="line.292"></a>
<span class="sourceLineNo">293</span> this.bufferSize = bufferSize;<a name="line.293"></a>
<span class="sourceLineNo">294</span> writeHeader();<a name="line.294"></a>
<span class="sourceLineNo">295</span> LogLog.debug("setFile ended");<a name="line.295"></a>
<span class="sourceLineNo">296</span> }<a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span> /**<a name="line.298"></a>
<span class="sourceLineNo">299</span> * Sets the quiet writer being used.<a name="line.299"></a>
<span class="sourceLineNo">300</span> * <a name="line.300"></a>
<span class="sourceLineNo">301</span> * This method is overriden by {@link RollingFileAppender}.<a name="line.301"></a>
<span class="sourceLineNo">302</span> */<a name="line.302"></a>
<span class="sourceLineNo">303</span> protected void setQWForFiles(Writer writer) {<a name="line.303"></a>
<span class="sourceLineNo">304</span> this.qw = new QuietWriter(writer, errorHandler);<a name="line.304"></a>
<span class="sourceLineNo">305</span> }<a name="line.305"></a>
<span class="sourceLineNo">306</span>}<a name="line.306"></a>
</pre>
</div>
</body>
</html>