| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <FONT color="green">008</FONT> *<a name="line.8"></a> |
| <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <FONT color="green">010</FONT> *<a name="line.10"></a> |
| <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a> |
| <FONT color="green">016</FONT> */<a name="line.16"></a> |
| <FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender;<a name="line.17"></a> |
| <FONT color="green">018</FONT> <a name="line.18"></a> |
| <FONT color="green">019</FONT> import java.io.BufferedOutputStream;<a name="line.19"></a> |
| <FONT color="green">020</FONT> import java.io.File;<a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.io.FileNotFoundException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.io.FileOutputStream;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.io.IOException;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.io.OutputStream;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.nio.channels.FileChannel;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import java.nio.channels.FileLock;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> /**<a name="line.29"></a> |
| <FONT color="green">030</FONT> * Class that handles actual File I/O for File Appenders.<a name="line.30"></a> |
| <FONT color="green">031</FONT> */<a name="line.31"></a> |
| <FONT color="green">032</FONT> public class FileManager extends OutputStreamManager {<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> private static ManagerFactory factory = new FileManagerFactory();<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> private boolean isAppend;<a name="line.36"></a> |
| <FONT color="green">037</FONT> private boolean isLocking;<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> protected FileManager(String fileName, OutputStream os, boolean append, boolean locking) {<a name="line.39"></a> |
| <FONT color="green">040</FONT> super(os, fileName);<a name="line.40"></a> |
| <FONT color="green">041</FONT> this.isAppend = append;<a name="line.41"></a> |
| <FONT color="green">042</FONT> this.isLocking = locking;<a name="line.42"></a> |
| <FONT color="green">043</FONT> }<a name="line.43"></a> |
| <FONT color="green">044</FONT> <a name="line.44"></a> |
| <FONT color="green">045</FONT> /**<a name="line.45"></a> |
| <FONT color="green">046</FONT> * Return the FileManager.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * @param fileName The name of the file to manage.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @param append true if the file should be appended to, false if it should be overwritten.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @param locking true if the file should be locked while writing, false otherwise.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * @param bufferedIO true if the contents should be buffered as they are written.<a name="line.50"></a> |
| <FONT color="green">051</FONT> * @return A FileManager for the File.<a name="line.51"></a> |
| <FONT color="green">052</FONT> */<a name="line.52"></a> |
| <FONT color="green">053</FONT> public static FileManager getFileManager(String fileName, boolean append, boolean locking, boolean bufferedIO) {<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> if (locking && bufferedIO) {<a name="line.55"></a> |
| <FONT color="green">056</FONT> locking = false;<a name="line.56"></a> |
| <FONT color="green">057</FONT> }<a name="line.57"></a> |
| <FONT color="green">058</FONT> return (FileManager) getManager(fileName, factory, new FactoryData(append, locking, bufferedIO));<a name="line.58"></a> |
| <FONT color="green">059</FONT> }<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> protected synchronized void write(byte[] bytes, int offset, int length) {<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> if (isLocking) {<a name="line.63"></a> |
| <FONT color="green">064</FONT> FileChannel channel = ((FileOutputStream) getOutputStream()).getChannel();<a name="line.64"></a> |
| <FONT color="green">065</FONT> try {<a name="line.65"></a> |
| <FONT color="green">066</FONT> /* Lock the whole file. This could be optimized to only lock from the current file<a name="line.66"></a> |
| <FONT color="green">067</FONT> position. Note that locking may be advisory on some systems and mandatory on others,<a name="line.67"></a> |
| <FONT color="green">068</FONT> so locking just from the current position would allow reading on systems where<a name="line.68"></a> |
| <FONT color="green">069</FONT> locking is mandatory. Also, Java 6 will throw an exception if the region of the<a name="line.69"></a> |
| <FONT color="green">070</FONT> file is already locked by another FileChannel in the same JVM. Hopefully, that will<a name="line.70"></a> |
| <FONT color="green">071</FONT> be avoided since every file should have a single file manager - unless two different<a name="line.71"></a> |
| <FONT color="green">072</FONT> files strings are configured that somehow map to the same file.*/<a name="line.72"></a> |
| <FONT color="green">073</FONT> FileLock lock = channel.lock(0, Long.MAX_VALUE, false);<a name="line.73"></a> |
| <FONT color="green">074</FONT> try {<a name="line.74"></a> |
| <FONT color="green">075</FONT> super.write(bytes, offset, length);<a name="line.75"></a> |
| <FONT color="green">076</FONT> } finally {<a name="line.76"></a> |
| <FONT color="green">077</FONT> lock.release();<a name="line.77"></a> |
| <FONT color="green">078</FONT> }<a name="line.78"></a> |
| <FONT color="green">079</FONT> } catch (IOException ex) {<a name="line.79"></a> |
| <FONT color="green">080</FONT> throw new AppenderRuntimeException("Unable to obtain lock on " + getName(), ex);<a name="line.80"></a> |
| <FONT color="green">081</FONT> }<a name="line.81"></a> |
| <FONT color="green">082</FONT> <a name="line.82"></a> |
| <FONT color="green">083</FONT> } else {<a name="line.83"></a> |
| <FONT color="green">084</FONT> super.write(bytes, offset, length);<a name="line.84"></a> |
| <FONT color="green">085</FONT> }<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * Return the name of the File being managed.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * @return The name of the File being managed.<a name="line.90"></a> |
| <FONT color="green">091</FONT> */<a name="line.91"></a> |
| <FONT color="green">092</FONT> public String getFileName() {<a name="line.92"></a> |
| <FONT color="green">093</FONT> return getName();<a name="line.93"></a> |
| <FONT color="green">094</FONT> }<a name="line.94"></a> |
| <FONT color="green">095</FONT> <a name="line.95"></a> |
| <FONT color="green">096</FONT> /**<a name="line.96"></a> |
| <FONT color="green">097</FONT> * Return the append status.<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @return true if the file will be appended to, false if it is overwritten.<a name="line.98"></a> |
| <FONT color="green">099</FONT> */<a name="line.99"></a> |
| <FONT color="green">100</FONT> public boolean isAppend() {<a name="line.100"></a> |
| <FONT color="green">101</FONT> return isAppend;<a name="line.101"></a> |
| <FONT color="green">102</FONT> }<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> /**<a name="line.104"></a> |
| <FONT color="green">105</FONT> * Return the lock status.<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @return true if the file will be locked when writing, false otherwise.<a name="line.106"></a> |
| <FONT color="green">107</FONT> */<a name="line.107"></a> |
| <FONT color="green">108</FONT> public boolean isLocking() {<a name="line.108"></a> |
| <FONT color="green">109</FONT> return isLocking;<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> /**<a name="line.112"></a> |
| <FONT color="green">113</FONT> * Factory Data.<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> private static class FactoryData {<a name="line.115"></a> |
| <FONT color="green">116</FONT> private boolean append;<a name="line.116"></a> |
| <FONT color="green">117</FONT> private boolean locking;<a name="line.117"></a> |
| <FONT color="green">118</FONT> private boolean bufferedIO;<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /**<a name="line.120"></a> |
| <FONT color="green">121</FONT> * Constructor.<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @param append Append status.<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @param locking Locking status.<a name="line.123"></a> |
| <FONT color="green">124</FONT> * @param bufferedIO Buffering flag.<a name="line.124"></a> |
| <FONT color="green">125</FONT> */<a name="line.125"></a> |
| <FONT color="green">126</FONT> public FactoryData(boolean append, boolean locking, boolean bufferedIO) {<a name="line.126"></a> |
| <FONT color="green">127</FONT> this.append = append;<a name="line.127"></a> |
| <FONT color="green">128</FONT> this.locking = locking;<a name="line.128"></a> |
| <FONT color="green">129</FONT> this.bufferedIO = bufferedIO;<a name="line.129"></a> |
| <FONT color="green">130</FONT> }<a name="line.130"></a> |
| <FONT color="green">131</FONT> }<a name="line.131"></a> |
| <FONT color="green">132</FONT> <a name="line.132"></a> |
| <FONT color="green">133</FONT> /**<a name="line.133"></a> |
| <FONT color="green">134</FONT> * Factory to create a FileManager.<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> private static class FileManagerFactory implements ManagerFactory<FileManager, FactoryData> {<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> /**<a name="line.138"></a> |
| <FONT color="green">139</FONT> * Create a FileManager.<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param name The name of the File.<a name="line.140"></a> |
| <FONT color="green">141</FONT> * @param data The FactoryData<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @return The FileManager for the File.<a name="line.142"></a> |
| <FONT color="green">143</FONT> */<a name="line.143"></a> |
| <FONT color="green">144</FONT> public FileManager createManager(String name, FactoryData data) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> File file = new File(name);<a name="line.145"></a> |
| <FONT color="green">146</FONT> final File parent = file.getParentFile();<a name="line.146"></a> |
| <FONT color="green">147</FONT> if (null != parent && !parent.exists()) {<a name="line.147"></a> |
| <FONT color="green">148</FONT> parent.mkdirs();<a name="line.148"></a> |
| <FONT color="green">149</FONT> }<a name="line.149"></a> |
| <FONT color="green">150</FONT> <a name="line.150"></a> |
| <FONT color="green">151</FONT> OutputStream os;<a name="line.151"></a> |
| <FONT color="green">152</FONT> try {<a name="line.152"></a> |
| <FONT color="green">153</FONT> os = new FileOutputStream(name, data.append);<a name="line.153"></a> |
| <FONT color="green">154</FONT> if (data.bufferedIO) {<a name="line.154"></a> |
| <FONT color="green">155</FONT> os = new BufferedOutputStream(os);<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> return new FileManager(name, os, data.append, data.locking);<a name="line.157"></a> |
| <FONT color="green">158</FONT> } catch (FileNotFoundException ex) {<a name="line.158"></a> |
| <FONT color="green">159</FONT> LOGGER.error("FileManager (" + name + ") " + ex);<a name="line.159"></a> |
| <FONT color="green">160</FONT> }<a name="line.160"></a> |
| <FONT color="green">161</FONT> return null;<a name="line.161"></a> |
| <FONT color="green">162</FONT> }<a name="line.162"></a> |
| <FONT color="green">163</FONT> }<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> }<a name="line.165"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
