| <!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.RollingRandomAccessFileManager;<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.net.Advertiser;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.util.Integers;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span>/**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * An appender that writes to random access files and can roll over at<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * intervals.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@Plugin(name = "RollingRandomAccessFile", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class RollingRandomAccessFileAppender extends AbstractOutputStreamAppender<RollingRandomAccessFileManager> {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static class Builder<B extends Builder<B>> extends AbstractOutputStreamAppender.Builder<B><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> implements org.apache.logging.log4j.core.util.Builder<RollingRandomAccessFileAppender> {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public Builder() {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> super();<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> withBufferSize(RollingRandomAccessFileManager.DEFAULT_BUFFER_SIZE);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> setIgnoreExceptions(true);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> withImmediateFlush(true);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @PluginBuilderAttribute("fileName")<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private String fileName;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> @PluginBuilderAttribute("filePattern")<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private String filePattern;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> @PluginBuilderAttribute("append")<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private boolean append = true;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> @PluginElement("Policy")<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private TriggeringPolicy policy;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @PluginElement("Strategy")<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private RolloverStrategy strategy;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> @PluginBuilderAttribute("advertise")<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private boolean advertise;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> @PluginBuilderAttribute("advertiseURI")<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private String advertiseURI;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> @PluginBuilderAttribute<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private String filePermissions;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> @PluginBuilderAttribute<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private String fileOwner;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> @PluginBuilderAttribute<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private String fileGroup;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> @Override<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public RollingRandomAccessFileAppender build() {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> final String name = getName();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> if (name == null) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> LOGGER.error("No name provided for FileAppender");<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return null;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> if (strategy == null) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (fileName != null) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> strategy = DefaultRolloverStrategy.newBuilder()<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> .withCompressionLevelStr(String.valueOf(Deflater.DEFAULT_COMPRESSION))<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> .withConfig(getConfiguration())<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> .build();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> } else {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> strategy = DirectWriteRolloverStrategy.newBuilder()<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> .withCompressionLevelStr(String.valueOf(Deflater.DEFAULT_COMPRESSION))<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> .withConfig(getConfiguration())<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> .build();<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> } else if (fileName == null && !(strategy instanceof DirectFileRolloverStrategy)) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> LOGGER.error("RollingFileAppender '{}': When no file name is provided a DirectFileRolloverStrategy must be configured");<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return null;<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("No filename pattern provided for FileAppender with name " + name);<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("A TriggeringPolicy must be provided");<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> final Layout<? extends Serializable> layout = getOrCreateLayout();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> final boolean immediateFlush = isImmediateFlush();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> final int bufferSize = getBufferSize();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final RollingRandomAccessFileManager manager = RollingRandomAccessFileManager<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> .getRollingRandomAccessFileManager(fileName, filePattern, append, immediateFlush, bufferSize, policy,<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> strategy, advertiseURI, layout,<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> filePermissions, fileOwner, fileGroup, getConfiguration());<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (manager == null) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return null;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> manager.initialize();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return new RollingRandomAccessFileAppender(name, layout, getFilter(), manager, fileName, filePattern,<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> isIgnoreExceptions(), immediateFlush, bufferSize,<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> advertise ? getConfiguration().getAdvertiser() : null, getPropertyArray());<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public B withFileName(final String fileName) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> this.fileName = fileName;<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return asBuilder();<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> public B withFilePattern(final String filePattern) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> this.filePattern = filePattern;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return asBuilder();<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> public B withAppend(final boolean append) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> this.append = append;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return asBuilder();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> public B withPolicy(final TriggeringPolicy policy) {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> this.policy = policy;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return asBuilder();<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> public B withStrategy(final RolloverStrategy strategy) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> this.strategy = strategy;<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return asBuilder();<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 B withAdvertise(final boolean advertise) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> this.advertise = advertise;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return asBuilder();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public B withAdvertiseURI(final String advertiseURI) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> this.advertiseURI = advertiseURI;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return asBuilder();<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> public B withFilePermissions(final String filePermissions) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> this.filePermissions = filePermissions;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return asBuilder();<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public B withFileOwner(final String fileOwner) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> this.fileOwner = fileOwner;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return asBuilder();<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 B withFileGroup(final String fileGroup) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> this.fileGroup = fileGroup;<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return asBuilder();<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><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> private final String fileName;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> private final String filePattern;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> private final Object advertisement;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> private final Advertiser advertiser;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> private RollingRandomAccessFileAppender(final String name, final Layout<? extends Serializable> layout,<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> final Filter filter, final RollingRandomAccessFileManager manager, final String fileName,<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> final String filePattern, final boolean ignoreExceptions, final boolean immediateFlush,<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> final int bufferSize, final Advertiser advertiser, final Property[] properties) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> super(name, layout, filter, ignoreExceptions, immediateFlush, properties, manager);<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (advertiser != null) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> final Map<String, String> configuration = new HashMap<>(layout.getContentFormat());<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> configuration.put("contentType", layout.getContentType());<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> configuration.put("name", name);<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> advertisement = advertiser.advertise(configuration);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> } else {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> advertisement = null;<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> this.fileName = fileName;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> this.filePattern = filePattern;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> this.advertiser = advertiser;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> @Override<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> setStopping();<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> super.stop(timeout, timeUnit, false);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> if (advertiser != null) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> advertiser.unadvertise(advertisement);<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> setStopped();<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> return true;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<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> * Write the log entry rolling over the file when required.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> *<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param event The LogEvent.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> @Override<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> public void append(final LogEvent event) {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> final RollingRandomAccessFileManager manager = getManager();<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> manager.checkRollover(event);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> // Leverage the nice batching behaviour of async Loggers/Appenders:<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> // we can signal the file manager that it needs to flush the buffer<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> // to disk at the end of a batch.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> // From a user's point of view, this means that all log events are<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> // _always_ available in the log file, without incurring the overhead<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> // of immediateFlush=true.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> manager.setEndOfBatch(event.isEndOfBatch()); // FIXME manager's EndOfBatch threadlocal can be deleted<a name="line.249"></a> |
| <span class="sourceLineNo">250</span><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> // LOG4J2-1292 utilize gc-free Layout.encode() method: taken care of in superclass<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> super.append(event);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<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> * Returns the File name for the Appender.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> *<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @return The file name.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> public String getFileName() {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> return fileName;<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> /**<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * Returns the file pattern used when rolling over.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> *<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @return The file pattern.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> */<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> public String getFilePattern() {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return filePattern;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> /**<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * Returns the size of the file manager's buffer.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @return the buffer size<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> */<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> public int getBufferSize() {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return getManager().getBufferSize();<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> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Create a RollingRandomAccessFileAppender.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> *<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param fileName The name of the file that is actively written to.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * (required).<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @param filePattern The pattern of the file name to use on rollover.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * (required).<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @param append If true, events are appended to the file. If false, the<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * file is overwritten when opened. Defaults to "true"<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * @param name The name of the Appender (required).<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * @param immediateFlush When true, events are immediately flushed. Defaults<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * to "true".<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * @param bufferSizeStr The buffer size, defaults to {@value RollingRandomAccessFileManager#DEFAULT_BUFFER_SIZE}.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @param policy The triggering policy. (required).<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param strategy The rollover strategy. Defaults to<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * DefaultRolloverStrategy.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * @param layout The layout to use (defaults to the default PatternLayout).<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * @param filter The Filter or null.<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @param ignoreExceptions If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * they are propagated to the caller.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * @param advertise "true" if the appender configuration should be<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * advertised, "false" otherwise.<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @param advertiseURI The advertised URI which can be used to retrieve the<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * file contents.<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * @param configuration The Configuration.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @return A RollingRandomAccessFileAppender.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @deprecated Use {@link #newBuilder()}.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> */<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> @Deprecated<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> public static <B extends Builder<B>> RollingRandomAccessFileAppender createAppender(<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> final String fileName,<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> final String filePattern,<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> final String append,<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> final String name,<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> final String immediateFlush,<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> final String bufferSizeStr,<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> final TriggeringPolicy policy,<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> final RolloverStrategy strategy,<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> final Layout<? extends Serializable> layout,<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> final Filter filter,<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> final String ignoreExceptions,<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> final String advertise,<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> final String advertiseURI,<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> final Configuration configuration) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span><a name="line.325"></a> |
| <span class="sourceLineNo">326</span> final boolean isAppend = Booleans.parseBoolean(append, true);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> final boolean isIgnoreExceptions = Booleans.parseBoolean(ignoreExceptions, true);<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> final boolean isImmediateFlush = Booleans.parseBoolean(immediateFlush, true);<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> final boolean isAdvertise = Boolean.parseBoolean(advertise);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> final int bufferSize = Integers.parseInt(bufferSizeStr, RollingRandomAccessFileManager.DEFAULT_BUFFER_SIZE);<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> return RollingRandomAccessFileAppender.<B>newBuilder()<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> .withAdvertise(isAdvertise)<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> .withAdvertiseURI(advertiseURI)<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> .withAppend(isAppend)<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> .withBufferSize(bufferSize)<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> .setConfiguration(configuration)<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> .withFileName(fileName)<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> .withFilePattern(filePattern).setFilter(filter).setIgnoreExceptions(isIgnoreExceptions)<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> .withImmediateFlush(isImmediateFlush).setLayout(layout).setName(name)<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> .withPolicy(policy)<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> .withStrategy(strategy)<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> .build();<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span><a name="line.345"></a> |
| <span class="sourceLineNo">346</span> @PluginBuilderFactory<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> return new Builder<B>().asBuilder();<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> }<a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span>}<a name="line.351"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
