| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.FileOutputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.OutputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.Serializable;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.nio.ByteBuffer;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.nio.channels.FileChannel;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.nio.channels.FileLock;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.nio.file.FileSystems;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.nio.file.Files;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.nio.file.Path;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.nio.file.Paths;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.nio.file.attribute.FileOwnerAttributeView;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.nio.file.attribute.FileTime;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.nio.file.attribute.PosixFileAttributeView;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.nio.file.attribute.PosixFilePermission;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.nio.file.attribute.PosixFilePermissions;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.Date;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import java.util.HashMap;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import java.util.Map;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import java.util.Set;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.Layout;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.util.FileUtils;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span>/**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Manages actual File I/O for File Appenders.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public class FileManager extends OutputStreamManager {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private static final FileManagerFactory FACTORY = new FileManagerFactory();<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private final boolean isAppend;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private final boolean createOnDemand;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private final boolean isLocking;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private final String advertiseURI;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private final int bufferSize;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private final Set<PosixFilePermission> filePermissions;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private final String fileOwner;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private final String fileGroup;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private final boolean attributeViewEnabled;<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> * @deprecated<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @Deprecated<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> protected FileManager(final String fileName, final OutputStream os, final boolean append, final boolean locking,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> final String advertiseURI, final Layout<? extends Serializable> layout, final int bufferSize,<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final boolean writeHeader) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> this(fileName, os, append, locking, advertiseURI, layout, writeHeader, ByteBuffer.wrap(new byte[bufferSize]));<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> * @deprecated<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @since 2.6<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> @Deprecated<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> protected FileManager(final String fileName, final OutputStream os, final boolean append, final boolean locking,<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> final String advertiseURI, final Layout<? extends Serializable> layout, final boolean writeHeader,<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> final ByteBuffer buffer) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> super(os, fileName, layout, writeHeader, buffer);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> this.isAppend = append;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.createOnDemand = false;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.isLocking = locking;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> this.advertiseURI = advertiseURI;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.bufferSize = buffer.capacity();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.filePermissions = null;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> this.fileOwner = null;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> this.fileGroup = null;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.attributeViewEnabled = false;<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> * @deprecated<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @since 2.7<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> @Deprecated<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> protected FileManager(final LoggerContext loggerContext, final String fileName, final OutputStream os, final boolean append, final boolean locking,<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final boolean createOnDemand, final String advertiseURI, final Layout<? extends Serializable> layout,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> final boolean writeHeader, final ByteBuffer buffer) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> super(loggerContext, os, fileName, createOnDemand, layout, writeHeader, buffer);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.isAppend = append;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> this.createOnDemand = createOnDemand;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.isLocking = locking;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> this.advertiseURI = advertiseURI;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> this.bufferSize = buffer.capacity();<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this.filePermissions = null;<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.fileOwner = null;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> this.fileGroup = null;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> this.attributeViewEnabled = false;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @since 2.9<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> protected FileManager(final LoggerContext loggerContext, final String fileName, final OutputStream os, final boolean append, final boolean locking,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final boolean createOnDemand, final String advertiseURI, final Layout<? extends Serializable> layout,<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> final String filePermissions, final String fileOwner, final String fileGroup, final boolean writeHeader,<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> final ByteBuffer buffer) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> super(loggerContext, os, fileName, createOnDemand, layout, writeHeader, buffer);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> this.isAppend = append;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> this.createOnDemand = createOnDemand;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this.isLocking = locking;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> this.advertiseURI = advertiseURI;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> this.bufferSize = buffer.capacity();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> final Set<String> views = FileSystems.getDefault().supportedFileAttributeViews();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> if (views.contains("posix")) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> this.filePermissions = filePermissions != null ? PosixFilePermissions.fromString(filePermissions) : null;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> this.fileGroup = fileGroup;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> } else {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> this.filePermissions = null;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> this.fileGroup = null;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (filePermissions != null) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> LOGGER.warn("Posix file attribute permissions defined but it is not supported by this files system.");<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> if (fileGroup != null) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> LOGGER.warn("Posix file attribute group defined but it is not supported by this files system.");<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> if (views.contains("owner")) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> this.fileOwner = fileOwner;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> } else {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> this.fileOwner = null;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (fileOwner != null) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> LOGGER.warn("Owner file attribute defined but it is not supported by this files system.");<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> // Supported and defined<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> this.attributeViewEnabled = this.filePermissions != null || this.fileOwner != null || this.fileGroup != null;<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> * Returns the FileManager.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param fileName The name of the file to manage.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @param append true if the file should be appended to, false if it should be overwritten.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param locking true if the file should be locked while writing, false otherwise.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param bufferedIo true if the contents should be buffered as they are written.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param createOnDemand true if you want to lazy-create the file (a.k.a. on-demand.)<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @param advertiseUri the URI to use when advertising the file<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @param layout The layout<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param bufferSize buffer size for buffered IO<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param filePermissions File permissions<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param fileOwner File owner<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @param fileGroup File group<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @param configuration The configuration.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @return A FileManager for the File.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> */<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public static FileManager getFileManager(final String fileName, final boolean append, boolean locking,<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> final boolean bufferedIo, final boolean createOnDemand, final String advertiseUri,<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> final Layout<? extends Serializable> layout,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> final int bufferSize, final String filePermissions, final String fileOwner, final String fileGroup,<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> final Configuration configuration) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> if (locking && bufferedIo) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> locking = false;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return narrow(FileManager.class, getManager(fileName, new FactoryData(append, locking, bufferedIo, bufferSize,<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> createOnDemand, advertiseUri, layout, filePermissions, fileOwner, fileGroup, configuration), FACTORY));<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> @Override<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> protected OutputStream createOutputStream() throws IOException {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> final String filename = getFileName();<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> LOGGER.debug("Now writing to {} at {}", filename, new Date());<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> final File file = new File(filename);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> final FileOutputStream fos = new FileOutputStream(file, isAppend);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> if (file.exists() && file.length() == 0) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> try {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> FileTime now = FileTime.fromMillis(System.currentTimeMillis());<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> Files.setAttribute(file.toPath(), "creationTime", now);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> } catch (Exception ex) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> LOGGER.warn("Unable to set current file tiem for {}", filename);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> writeHeader(fos);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> defineAttributeView(Paths.get(filename));<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return fos;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> protected void defineAttributeView(final Path path) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> if (attributeViewEnabled) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> try {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> // FileOutputStream may not create new file on all jvm<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> path.toFile().createNewFile();<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> FileUtils.defineFilePosixAttributeView(path, filePermissions, fileOwner, fileGroup);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> } catch (final Exception e) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> LOGGER.error("Could not define attribute view on path \"{}\" got {}", path, e.getMessage(), e);<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><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> @Override<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> protected synchronized void write(final byte[] bytes, final int offset, final int length,<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> final boolean immediateFlush) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> if (isLocking) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> try {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> @SuppressWarnings("resource")<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> final FileChannel channel = ((FileOutputStream) getOutputStream()).getChannel();<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> /*<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * Lock the whole file. This could be optimized to only lock from the current file position. Note that<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * locking may be advisory on some systems and mandatory on others, so locking just from the current<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * position would allow reading on systems where locking is mandatory. Also, Java 6 will throw an<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * exception if the region of the file is already locked by another FileChannel in the same JVM.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Hopefully, that will be avoided since every file should have a single file manager - unless two<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * different files strings are configured that somehow map to the same file.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> try (final FileLock lock = channel.lock(0, Long.MAX_VALUE, false)) {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> super.write(bytes, offset, length, immediateFlush);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> } catch (final IOException ex) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> throw new AppenderLoggingException("Unable to obtain lock on " + getName(), ex);<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> }<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> } else {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> super.write(bytes, offset, length, immediateFlush);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Overrides {@link OutputStreamManager#writeToDestination(byte[], int, int)} to add support for file locking.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> *<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param bytes the array containing data<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @param offset from where to write<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param length how many bytes to write<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @since 2.8<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> */<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> @Override<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> protected synchronized void writeToDestination(final byte[] bytes, final int offset, final int length) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> if (isLocking) {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> try {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> @SuppressWarnings("resource")<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> final FileChannel channel = ((FileOutputStream) getOutputStream()).getChannel();<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> /*<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * Lock the whole file. This could be optimized to only lock from the current file position. Note that<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * locking may be advisory on some systems and mandatory on others, so locking just from the current<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * position would allow reading on systems where locking is mandatory. Also, Java 6 will throw an<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * exception if the region of the file is already locked by another FileChannel in the same JVM.<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * Hopefully, that will be avoided since every file should have a single file manager - unless two<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * different files strings are configured that somehow map to the same file.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> */<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> try (final FileLock lock = channel.lock(0, Long.MAX_VALUE, false)) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> super.writeToDestination(bytes, offset, length);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> } catch (final IOException ex) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> throw new AppenderLoggingException("Unable to obtain lock on " + getName(), ex);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> } else {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> super.writeToDestination(bytes, offset, length);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> }<a name="line.275"></a> |
| <span class="sourceLineNo">276</span><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> /**<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * Returns the name of the File being managed.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * @return The name of the File being managed.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> */<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public String getFileName() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return getName();<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> * Returns the append status.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @return true if the file will be appended to, false if it is overwritten.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> */<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> public boolean isAppend() {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> return isAppend;<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> * Returns the lazy-create.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @return true if the file will be lazy-created.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> */<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public boolean isCreateOnDemand() {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return createOnDemand;<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> /**<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * Returns the lock status.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @return true if the file will be locked when writing, false otherwise.<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> */<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> public boolean isLocking() {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> return isLocking;<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> }<a name="line.306"></a> |
| <span class="sourceLineNo">307</span><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> /**<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * Returns the buffer size to use if the appender was configured with BufferedIO=true, otherwise returns a negative<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * number.<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * @return the buffer size, or a negative number if the output stream is not buffered<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> */<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> public int getBufferSize() {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> return bufferSize;<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> /**<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * Returns posix file permissions if defined and the OS supports posix file attribute,<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * null otherwise.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * @return File posix permissions<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @see PosixFileAttributeView<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> */<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> public Set<PosixFilePermission> getFilePermissions() {<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return filePermissions;<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> /**<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * Returns file owner if defined and the OS supports owner file attribute view,<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * null otherwise.<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * @return File owner<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * @see FileOwnerAttributeView<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> */<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> public String getFileOwner() {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> return fileOwner;<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> }<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> /**<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * Returns file group if defined and the OS supports posix/group file attribute view,<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * null otherwise.<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @return File group<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @see PosixFileAttributeView<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> */<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> public String getFileGroup() {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> return fileGroup;<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> /**<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * Returns true if file attribute view enabled for this file manager.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> *<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * @return True if posix or owner supported and defined false otherwise.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> */<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> public boolean isAttributeViewEnabled() {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> return attributeViewEnabled;<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> * FileManager's content format is specified by: <code>Key: "fileURI" Value: provided "advertiseURI" param</code>.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> *<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @return Map of content format keys supporting FileManager<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> */<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> @Override<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> public Map<String, String> getContentFormat() {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> final Map<String, String> result = new HashMap<>(super.getContentFormat());<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> result.put("fileURI", advertiseURI);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> return result;<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> * Factory Data.<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> */<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> private static class FactoryData extends ConfigurationFactoryData {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> private final boolean append;<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> private final boolean locking;<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> private final boolean bufferedIo;<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> private final int bufferSize;<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> private final boolean createOnDemand;<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> private final String advertiseURI;<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> private final Layout<? extends Serializable> layout;<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> private final String filePermissions;<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> private final String fileOwner;<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> private final String fileGroup;<a name="line.381"></a> |
| <span class="sourceLineNo">382</span><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> /**<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * Constructor.<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @param append Append status.<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @param locking Locking status.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * @param bufferedIo Buffering flag.<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * @param bufferSize Buffer size.<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * @param createOnDemand if you want to lazy-create the file (a.k.a. on-demand.)<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * @param advertiseURI the URI to use when advertising the file<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * @param layout The layout<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * @param filePermissions File permissions<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * @param fileOwner File owner<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @param fileGroup File group<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * @param configuration the configuration<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> */<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> public FactoryData(final boolean append, final boolean locking, final boolean bufferedIo, final int bufferSize,<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> final boolean createOnDemand, final String advertiseURI, final Layout<? extends Serializable> layout,<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> final String filePermissions, final String fileOwner, final String fileGroup,<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> final Configuration configuration) {<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> super(configuration);<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> this.append = append;<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> this.locking = locking;<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> this.bufferedIo = bufferedIo;<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> this.bufferSize = bufferSize;<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> this.createOnDemand = createOnDemand;<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> this.advertiseURI = advertiseURI;<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> this.layout = layout;<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> this.filePermissions = filePermissions;<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> this.fileOwner = fileOwner;<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> this.fileGroup = fileGroup;<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> }<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> }<a name="line.413"></a> |
| <span class="sourceLineNo">414</span><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> /**<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * Factory to create a FileManager.<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> */<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> private static class FileManagerFactory implements ManagerFactory<FileManager, FactoryData> {<a name="line.418"></a> |
| <span class="sourceLineNo">419</span><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> /**<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * Creates a FileManager.<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * @param name The name of the File.<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * @param data The FactoryData<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * @return The FileManager for the File.<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> */<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> @Override<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> public FileManager createManager(final String name, final FactoryData data) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> final File file = new File(name);<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> try {<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> FileUtils.makeParentDirs(file);<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> final boolean writeHeader = !data.append || !file.exists();<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> final int actualSize = data.bufferedIo ? data.bufferSize : Constants.ENCODER_BYTE_BUFFER_SIZE;<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> final ByteBuffer byteBuffer = ByteBuffer.wrap(new byte[actualSize]);<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> final FileOutputStream fos = data.createOnDemand ? null : new FileOutputStream(file, data.append);<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> final FileManager fm = new FileManager(data.getLoggerContext(), name, fos, data.append, data.locking,<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> data.createOnDemand, data.advertiseURI, data.layout,<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> data.filePermissions, data.fileOwner, data.fileGroup, writeHeader, byteBuffer);<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> if (fos != null && fm.attributeViewEnabled) {<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> fm.defineAttributeView(file.toPath());<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> return fm;<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> } catch (final IOException ex) {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> LOGGER.error("FileManager (" + name + ") " + ex, ex);<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> }<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> return null;<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> }<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> }<a name="line.447"></a> |
| <span class="sourceLineNo">448</span><a name="line.448"></a> |
| <span class="sourceLineNo">449</span>}<a name="line.449"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
