| <!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.Serializable;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.HashMap;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.zip.Deflater;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Appender;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Core;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Filter;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.Layout;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.appender.rolling.DirectFileRolloverStrategy;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.appender.rolling.DirectWriteRolloverStrategy;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.appender.rolling.RollingFileManager;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy;<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.Property;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<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.PluginElement;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.net.Advertiser;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.util.Booleans;<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> * An appender that writes to files and can roll over at intervals.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@Plugin(name = RollingFileAppender.PLUGIN_NAME, category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class RollingFileAppender extends AbstractOutputStreamAppender<RollingFileManager> {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static final String PLUGIN_NAME = "RollingFile";<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Builds FileAppender instances.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param <B><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * The type to build<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @since 2.7<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public static class Builder<B extends Builder<B>> extends AbstractOutputStreamAppender.Builder<B><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> implements org.apache.logging.log4j.core.util.Builder<RollingFileAppender> {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @PluginBuilderAttribute<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private String fileName;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @PluginBuilderAttribute<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> @Required<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private String filePattern;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> @PluginBuilderAttribute<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private boolean append = true;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @PluginBuilderAttribute<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private boolean locking;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> @PluginElement("Policy")<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> @Required<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private TriggeringPolicy policy;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> @PluginElement("Strategy")<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private RolloverStrategy strategy;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> @PluginBuilderAttribute<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private boolean advertise;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @PluginBuilderAttribute<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private String advertiseUri;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> @PluginBuilderAttribute<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private boolean createOnDemand;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> @PluginBuilderAttribute<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> private String filePermissions;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @PluginBuilderAttribute<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private String fileOwner;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @PluginBuilderAttribute<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> private String fileGroup;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> @Override<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public RollingFileAppender build() {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> // Even though some variables may be annotated with @Required, we must still perform validation here for<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> // call sites that build builders programmatically.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> final boolean isBufferedIo = isBufferedIo();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> final int bufferSize = getBufferSize();<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (getName() == null) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> LOGGER.error("RollingFileAppender '{}': No name provided.", getName());<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return null;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (!isBufferedIo && bufferSize > 0) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> LOGGER.warn("RollingFileAppender '{}': The bufferSize is set to {} but bufferedIO is not true", getName(), bufferSize);<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> if (filePattern == null) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> LOGGER.error("RollingFileAppender '{}': No file name pattern provided.", getName());<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return null;<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> if (policy == null) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> LOGGER.error("RollingFileAppender '{}': No TriggeringPolicy provided.", getName());<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return null;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (strategy == null) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if (fileName != null) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> strategy = DefaultRolloverStrategy.newBuilder()<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> .withCompressionLevelStr(String.valueOf(Deflater.DEFAULT_COMPRESSION))<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> .withConfig(getConfiguration())<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> .build();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> } else {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> strategy = DirectWriteRolloverStrategy.newBuilder()<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> .withCompressionLevelStr(String.valueOf(Deflater.DEFAULT_COMPRESSION))<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> .withConfig(getConfiguration())<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> .build();<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> } else if (fileName == null && !(strategy instanceof DirectFileRolloverStrategy)) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> LOGGER.error("RollingFileAppender '{}': When no file name is provided a DirectFilenameRolloverStrategy must be configured");<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return null;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> final Layout<? extends Serializable> layout = getOrCreateLayout();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> final RollingFileManager manager = RollingFileManager.getFileManager(fileName, filePattern, append,<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> isBufferedIo, policy, strategy, advertiseUri, layout, bufferSize, isImmediateFlush(),<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> createOnDemand, filePermissions, fileOwner, fileGroup, getConfiguration());<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> if (manager == null) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return null;<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> manager.initialize();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return new RollingFileAppender(getName(), layout, getFilter(), manager, fileName, filePattern,<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> isIgnoreExceptions(), isImmediateFlush(), advertise ? getConfiguration().getAdvertiser() : null,<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> getPropertyArray());<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public String getAdvertiseUri() {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return advertiseUri;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public String getFileName() {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return fileName;<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> public boolean isAdvertise() {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return advertise;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public boolean isAppend() {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return append;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public boolean isCreateOnDemand() {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return createOnDemand;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public boolean isLocking() {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return locking;<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public String getFilePermissions() {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return filePermissions;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public String getFileOwner() {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return fileOwner;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public String getFileGroup() {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> return fileGroup;<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public B withAdvertise(final boolean advertise) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> this.advertise = advertise;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return asBuilder();<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> public B withAdvertiseUri(final String advertiseUri) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> this.advertiseUri = advertiseUri;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return asBuilder();<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> public B withAppend(final boolean append) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> this.append = append;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> return asBuilder();<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> public B withFileName(final String fileName) {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> this.fileName = fileName;<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return asBuilder();<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> public B withCreateOnDemand(final boolean createOnDemand) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> this.createOnDemand = createOnDemand;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return asBuilder();<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> public B withLocking(final boolean locking) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> this.locking = locking;<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> return asBuilder();<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> public String getFilePattern() {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> return filePattern;<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> public TriggeringPolicy getPolicy() {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> return policy;<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> public RolloverStrategy getStrategy() {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> return strategy;<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> }<a name="line.236"></a> |
| <span class="sourceLineNo">237</span><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> public B withFilePattern(final String filePattern) {<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> this.filePattern = filePattern;<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> return asBuilder();<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> public B withPolicy(final TriggeringPolicy policy) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> this.policy = policy;<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> return asBuilder();<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> }<a name="line.246"></a> |
| <span class="sourceLineNo">247</span><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> public B withStrategy(final RolloverStrategy strategy) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> this.strategy = strategy;<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> return asBuilder();<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> public B withFilePermissions(final String filePermissions) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> this.filePermissions = filePermissions;<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> return asBuilder();<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> public B withFileOwner(final String fileOwner) {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> this.fileOwner = fileOwner;<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> return asBuilder();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public B withFileGroup(final String fileGroup) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> this.fileGroup = fileGroup;<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> return asBuilder();<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> private static final int DEFAULT_BUFFER_SIZE = 8192;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> private final String fileName;<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> private final String filePattern;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> private Object advertisement;<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> private final Advertiser advertiser;<a name="line.275"></a> |
| <span class="sourceLineNo">276</span><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> private RollingFileAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> final RollingFileManager manager, final String fileName, final String filePattern,<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser,<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> final Property[] properties) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> super(name, layout, filter, ignoreExceptions, immediateFlush, properties, manager);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> if (advertiser != null) {<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> final Map<String, String> configuration = new HashMap<>(layout.getContentFormat());<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> configuration.put("contentType", layout.getContentType());<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> configuration.put("name", name);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> advertisement = advertiser.advertise(configuration);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> this.fileName = fileName;<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> this.filePattern = filePattern;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> this.advertiser = advertiser;<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> @Override<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> setStopping();<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> final boolean stopped = super.stop(timeout, timeUnit, false);<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> if (advertiser != null) {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> advertiser.unadvertise(advertisement);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> setStopped();<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> return stopped;<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> /**<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * Writes the log entry rolling over the file when required.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @param event The LogEvent.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> */<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> @Override<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> public void append(final LogEvent event) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> getManager().checkRollover(event);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> super.append(event);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> /**<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * Returns the File name for the Appender.<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * @return The file name.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> */<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> public String getFileName() {<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> return fileName;<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> /**<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * Returns the file pattern used when rolling over.<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * @return The file pattern.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> */<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> public String getFilePattern() {<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> return filePattern;<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<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> * Returns the triggering policy.<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * @param <T> TriggeringPolicy type<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @return The TriggeringPolicy<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> */<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> public <T extends TriggeringPolicy> T getTriggeringPolicy() {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> return getManager().getTriggeringPolicy();<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> /**<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * Creates a RollingFileAppender.<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * @param fileName The name of the file that is actively written to. (required).<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * @param filePattern The pattern of the file name to use on rollover. (required).<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * @param append If true, events are appended to the file. If false, the file<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * is overwritten when opened. Defaults to "true"<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * @param name The name of the Appender (required).<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @param bufferedIO When true, I/O will be buffered. Defaults to "true".<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * @param bufferSizeStr buffer size for buffered IO (default is 8192).<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * @param immediateFlush When true, events are immediately flushed. Defaults to "true".<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * @param policy The triggering policy. (required).<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @param strategy The rollover strategy. Defaults to DefaultRolloverStrategy.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param layout The layout to use (defaults to the default PatternLayout).<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param filter The Filter or null.<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * they are propagated to the caller.<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * @param advertise "true" if the appender configuration should be advertised, "false" otherwise.<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * @param advertiseUri The advertised URI which can be used to retrieve the file contents.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * @param config The Configuration.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @return A RollingFileAppender.<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * @deprecated Use {@link #newBuilder()}.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> */<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> @Deprecated<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> public static <B extends Builder<B>> RollingFileAppender createAppender(<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> // @formatter:off<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> final String fileName,<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> final String filePattern,<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> final String append,<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> final String name,<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> final String bufferedIO,<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> final String bufferSizeStr,<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> final String immediateFlush,<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> final TriggeringPolicy policy,<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> final RolloverStrategy strategy,<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> final Layout<? extends Serializable> layout,<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> final Filter filter,<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> final String ignore,<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> final String advertise,<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> final String advertiseUri,<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> final Configuration config) {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> // @formatter:on<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> final int bufferSize = Integers.parseInt(bufferSizeStr, DEFAULT_BUFFER_SIZE);<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> // @formatter:off<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> return RollingFileAppender.<B>newBuilder()<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> .withAdvertise(Boolean.parseBoolean(advertise))<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> .withAdvertiseUri(advertiseUri)<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> .withAppend(Booleans.parseBoolean(append, true))<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> .withBufferedIo(Booleans.parseBoolean(bufferedIO, true))<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> .withBufferSize(bufferSize)<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> .setConfiguration(config)<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> .withFileName(fileName)<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> .withFilePattern(filePattern).setFilter(filter).setIgnoreExceptions(Booleans.parseBoolean(ignore, true))<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> .withImmediateFlush(Booleans.parseBoolean(immediateFlush, true)).setLayout(layout)<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> .withCreateOnDemand(false)<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> .withLocking(false).setName(name)<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> .withPolicy(policy)<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> .withStrategy(strategy)<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> .build();<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> // @formatter:on<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> /**<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * Creates a new Builder.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> *<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * @return a new Builder.<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * @since 2.7<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> */<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> @PluginBuilderFactory<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> return new Builder<B>().asBuilder();<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> }<a name="line.410"></a> |
| <span class="sourceLineNo">411</span>}<a name="line.411"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
