| <!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.rolling;<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.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.nio.file.Files;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.file.Path;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Arrays;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Collections;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.SortedMap;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.concurrent.TimeUnit;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.zip.Deflater;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Core;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.appender.rolling.action.Action;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.appender.rolling.action.CompositeAction;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.appender.rolling.action.FileRenameAction;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.appender.rolling.action.PathCondition;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.appender.rolling.action.PosixViewAttributeAction;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.util.Integers;<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> * When rolling over, <code>DirectWriteRolloverStrategy</code> writes directly to the file as resolved by the file<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * pattern. Files will be renamed files according to an algorithm as described below.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * The DirectWriteRolloverStrategy uses similar logic as DefaultRolloverStrategy to determine the file name based<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * on the file pattern, however the DirectWriteRolloverStrategy writes directly to a file and does not rename it<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * during rollover, except if it is compressed, in which case it will add the appropriate file extension.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * </p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @since 2.8<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>@Plugin(name = "DirectWriteRolloverStrategy", category = Core.CATEGORY_NAME, printObject = true)<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>public class DirectWriteRolloverStrategy extends AbstractRolloverStrategy implements DirectFileRolloverStrategy {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private static final int DEFAULT_MAX_FILES = 7;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Builds DirectWriteRolloverStrategy instances.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public static class Builder implements org.apache.logging.log4j.core.util.Builder<DirectWriteRolloverStrategy> {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @PluginBuilderAttribute("maxFiles")<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private String maxFiles;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> @PluginBuilderAttribute("compressionLevel")<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private String compressionLevelStr;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> @PluginElement("Actions")<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private Action[] customActions;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @PluginBuilderAttribute(value = "stopCustomActionsOnError")<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private boolean stopCustomActionsOnError = true;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> @PluginBuilderAttribute(value = "tempCompressedFilePattern")<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private String tempCompressedFilePattern;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @PluginConfiguration<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private Configuration config;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @Override<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> public DirectWriteRolloverStrategy build() {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> int maxIndex = Integer.MAX_VALUE;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (maxFiles != null) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> maxIndex = Integer.parseInt(maxFiles);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> if (maxIndex < 0) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> maxIndex = Integer.MAX_VALUE;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> } else if (maxIndex < 2) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> LOGGER.error("Maximum files too small. Limited to " + DEFAULT_MAX_FILES);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> maxIndex = DEFAULT_MAX_FILES;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final int compressionLevel = Integers.parseInt(compressionLevelStr, Deflater.DEFAULT_COMPRESSION);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return new DirectWriteRolloverStrategy(maxIndex, compressionLevel, config.getStrSubstitutor(),<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> customActions, stopCustomActionsOnError, tempCompressedFilePattern);<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> public String getMaxFiles() {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return maxFiles;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Defines the maximum number of files to keep.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param maxFiles The maximum number of files that match the date portion of the pattern to keep.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return This builder for chaining convenience<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public Builder withMaxFiles(final String maxFiles) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> this.maxFiles = maxFiles;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return this;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public String getCompressionLevelStr() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return compressionLevelStr;<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> /**<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * Defines compression level.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> *<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @param compressionLevelStr The compression level, 0 (less) through 9 (more); applies only to ZIP files.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return This builder for chaining convenience<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public Builder withCompressionLevelStr(final String compressionLevelStr) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.compressionLevelStr = compressionLevelStr;<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return this;<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> public Action[] getCustomActions() {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return customActions;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Defines custom actions.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> *<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @param customActions custom actions to perform asynchronously after rollover<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @return This builder for chaining convenience<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public Builder withCustomActions(final Action[] customActions) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> this.customActions = customActions;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return this;<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> public boolean isStopCustomActionsOnError() {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return stopCustomActionsOnError;<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> * Defines whether to stop executing asynchronous actions if an error occurs.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @return This builder for chaining convenience<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public Builder withStopCustomActionsOnError(final boolean stopCustomActionsOnError) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> this.stopCustomActionsOnError = stopCustomActionsOnError;<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return this;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public String getTempCompressedFilePattern() {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return tempCompressedFilePattern;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<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> * Defines temporary compression file pattern.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> *<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @param tempCompressedFilePattern File pattern of the working file pattern used during compression, if null no temporary file are used<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @return This builder for chaining convenience<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> */<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public Builder withTempCompressedFilePattern(final String tempCompressedFilePattern) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> this.tempCompressedFilePattern = tempCompressedFilePattern;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return this;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> public Configuration getConfig() {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return config;<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> * Defines configuration.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> *<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @param config The Configuration.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @return This builder for chaining convenience<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> */<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public Builder withConfig(final Configuration config) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> this.config = config;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> return this;<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> @PluginBuilderFactory<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public static Builder newBuilder() {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> return new Builder();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * Creates the DirectWriteRolloverStrategy.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> *<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param maxFiles The maximum number of files that match the date portion of the pattern to keep.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @param compressionLevelStr The compression level, 0 (less) through 9 (more); applies only to ZIP files.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @param customActions custom actions to perform asynchronously after rollover<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @param config The Configuration.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * @return A DirectWriteRolloverStrategy.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @deprecated Since 2.9 Usage of Builder API is preferable<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> @Deprecated<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> @PluginFactory<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> public static DirectWriteRolloverStrategy createStrategy(<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> // @formatter:off<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> @PluginAttribute("maxFiles") final String maxFiles,<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> @PluginAttribute("compressionLevel") final String compressionLevelStr,<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> @PluginElement("Actions") final Action[] customActions,<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> @PluginAttribute(value = "stopCustomActionsOnError", defaultBoolean = true)<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> final boolean stopCustomActionsOnError,<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> @PluginConfiguration final Configuration config) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return newBuilder().withMaxFiles(maxFiles)<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> .withCompressionLevelStr(compressionLevelStr)<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> .withCustomActions(customActions)<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> .withStopCustomActionsOnError(stopCustomActionsOnError)<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> .withConfig(config)<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> .build();<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> // @formatter:on<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Index for most recent log file.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> */<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> private final int maxFiles;<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> private final int compressionLevel;<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> private final List<Action> customActions;<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> private final boolean stopCustomActionsOnError;<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> private volatile String currentFileName;<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> private int nextIndex = -1;<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> private final PatternProcessor tempCompressedFilePattern;<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> private volatile boolean usePrevTime = false;<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> /**<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * Constructs a new instance.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> *<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @param maxFiles The maximum number of files that match the date portion of the pattern to keep.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param customActions custom actions to perform asynchronously after rollover<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @deprecated Since 2.9 Added tempCompressedFilePatternString parameter<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> */<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> @Deprecated<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> protected DirectWriteRolloverStrategy(final int maxFiles, final int compressionLevel,<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> final StrSubstitutor strSubstitutor, final Action[] customActions,<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> final boolean stopCustomActionsOnError) {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> this(maxFiles, compressionLevel, strSubstitutor, customActions, stopCustomActionsOnError, null);<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> * Constructs a new instance.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> *<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @param maxFiles The maximum number of files that match the date portion of the pattern to keep.<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * @param customActions custom actions to perform asynchronously after rollover<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * @param stopCustomActionsOnError whether to stop executing asynchronous actions if an error occurs<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * @param tempCompressedFilePatternString File pattern of the working file<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * used during compression, if null no temporary file are used<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> */<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> protected DirectWriteRolloverStrategy(final int maxFiles, final int compressionLevel,<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> final StrSubstitutor strSubstitutor, final Action[] customActions,<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> final boolean stopCustomActionsOnError, final String tempCompressedFilePatternString) {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> super(strSubstitutor);<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> this.maxFiles = maxFiles;<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> this.compressionLevel = compressionLevel;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> this.stopCustomActionsOnError = stopCustomActionsOnError;<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> this.customActions = customActions == null ? Collections.<Action> emptyList() : Arrays.asList(customActions);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> this.tempCompressedFilePattern =<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> tempCompressedFilePatternString != null ? new PatternProcessor(tempCompressedFilePatternString) : null;<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> public int getCompressionLevel() {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return this.compressionLevel;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public List<Action> getCustomActions() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return customActions;<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> public int getMaxFiles() {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> return this.maxFiles;<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> public boolean isStopCustomActionsOnError() {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> return stopCustomActionsOnError;<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> public PatternProcessor getTempCompressedFilePattern() {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> return tempCompressedFilePattern;<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> private int purge(final RollingFileManager manager) {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> final SortedMap<Integer, Path> eligibleFiles = getEligibleFiles(manager);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> LOGGER.debug("Found {} eligible files, max is {}", eligibleFiles.size(), maxFiles);<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> while (eligibleFiles.size() >= maxFiles) {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> try {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> final Integer key = eligibleFiles.firstKey();<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> Files.delete(eligibleFiles.get(key));<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> eligibleFiles.remove(key);<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> } catch (final IOException ioe) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> LOGGER.error("Unable to delete {}", eligibleFiles.firstKey(), ioe);<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> break;<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> return eligibleFiles.size() > 0 ? eligibleFiles.lastKey() : 1;<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> @Override<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> public String getCurrentFileName(final RollingFileManager manager) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> if (currentFileName == null) {<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> final SortedMap<Integer, Path> eligibleFiles = getEligibleFiles(manager);<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> final int fileIndex = eligibleFiles.size() > 0 ? (nextIndex > 0 ? nextIndex : eligibleFiles.size()) : 1;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> final StringBuilder buf = new StringBuilder(255);<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, true, fileIndex);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> final int suffixLength = suffixLength(buf.toString());<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> final String name = suffixLength > 0 ? buf.substring(0, buf.length() - suffixLength) : buf.toString();<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> currentFileName = name;<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return currentFileName;<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> @Override<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public void clearCurrentFileName() {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> currentFileName = null;<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> /**<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * Performs the rollover.<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> *<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param manager The RollingFileManager name for current active log file.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @return A RolloverDescription.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @throws SecurityException if an error occurs.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> */<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> @Override<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public RolloverDescription rollover(final RollingFileManager manager) throws SecurityException {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> LOGGER.debug("Rolling " + currentFileName);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (maxFiles < 0) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> return null;<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> final long startNanos = System.nanoTime();<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> final int fileIndex = purge(manager);<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> if (LOGGER.isTraceEnabled()) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> final double durationMillis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> LOGGER.trace("DirectWriteRolloverStrategy.purge() took {} milliseconds", durationMillis);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> Action compressAction = null;<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> final String sourceName = getCurrentFileName(manager);<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> String compressedName = sourceName;<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> currentFileName = null;<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> nextIndex = fileIndex + 1;<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> final FileExtension fileExtension = manager.getFileExtension();<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if (fileExtension != null) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> compressedName += fileExtension.getExtension();<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> if (tempCompressedFilePattern != null) {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> final StringBuilder buf = new StringBuilder();<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> tempCompressedFilePattern.formatFileName(strSubstitutor, buf, fileIndex);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> final String tmpCompressedName = buf.toString();<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> final File tmpCompressedNameFile = new File(tmpCompressedName);<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> final File parentFile = tmpCompressedNameFile.getParentFile();<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> if (parentFile != null) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> parentFile.mkdirs();<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> compressAction = new CompositeAction(<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> Arrays.asList(fileExtension.createCompressAction(sourceName, tmpCompressedName,<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> true, compressionLevel),<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> new FileRenameAction(tmpCompressedNameFile,<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> new File(compressedName), true)),<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> true);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> } else {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> compressAction = fileExtension.createCompressAction(sourceName, compressedName,<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> true, compressionLevel);<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> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> if (compressAction != null && manager.isAttributeViewEnabled()) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> // Propagate posix attribute view to compressed file<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> // @formatter:off<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> final Action posixAttributeViewAction = PosixViewAttributeAction.newBuilder()<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> .withBasePath(compressedName)<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> .withFollowLinks(false)<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> .withMaxDepth(1)<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> .withPathConditions(new PathCondition[0])<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> .withSubst(getStrSubstitutor())<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> .withFilePermissions(manager.getFilePermissions())<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> .withFileOwner(manager.getFileOwner())<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> .withFileGroup(manager.getFileGroup())<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> .build();<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> // @formatter:on<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> compressAction = new CompositeAction(Arrays.asList(compressAction, posixAttributeViewAction), false);<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> }<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> final Action asyncAction = merge(compressAction, customActions, stopCustomActionsOnError);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> return new RolloverDescriptionImpl(sourceName, false, null, asyncAction);<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> }<a name="line.399"></a> |
| <span class="sourceLineNo">400</span><a name="line.400"></a> |
| <span class="sourceLineNo">401</span> @Override<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> public String toString() {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> return "DirectWriteRolloverStrategy(maxFiles=" + maxFiles + ')';<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> }<a name="line.404"></a> |
| <span class="sourceLineNo">405</span><a name="line.405"></a> |
| <span class="sourceLineNo">406</span>}<a name="line.406"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
