blob: a8c9ddbbadd1d0dc3534e86816b5e6be56b17b97 [file] [log] [blame]
<!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><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Appender;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Core;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Filter;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Layout;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.Property;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.net.Advertiser;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.util.Integers;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * File Appender.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>@Plugin(name = "RandomAccessFile", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.41"></a>
<span class="sourceLineNo">042</span>public final class RandomAccessFileAppender extends AbstractOutputStreamAppender&lt;RandomAccessFileManager&gt; {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Builds RandomAccessFileAppender instances.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @param &lt;B&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * The type to build<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractOutputStreamAppender.Builder&lt;B&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> implements org.apache.logging.log4j.core.util.Builder&lt;RandomAccessFileAppender&gt; {<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> @PluginBuilderAttribute("fileName")<a name="line.53"></a>
<span class="sourceLineNo">054</span> private String fileName;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @PluginBuilderAttribute("append")<a name="line.56"></a>
<span class="sourceLineNo">057</span> private boolean append = true;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @PluginBuilderAttribute("advertise")<a name="line.59"></a>
<span class="sourceLineNo">060</span> private boolean advertise;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> @PluginBuilderAttribute("advertiseURI")<a name="line.62"></a>
<span class="sourceLineNo">063</span> private String advertiseURI;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @Override<a name="line.65"></a>
<span class="sourceLineNo">066</span> public RandomAccessFileAppender build() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> final String name = getName();<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (name == null) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> LOGGER.error("No name provided for FileAppender");<a name="line.69"></a>
<span class="sourceLineNo">070</span> return null;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> if (fileName == null) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> LOGGER.error("No filename provided for FileAppender with name " + name);<a name="line.74"></a>
<span class="sourceLineNo">075</span> return null;<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> final Layout&lt;? extends Serializable&gt; layout = getOrCreateLayout();<a name="line.77"></a>
<span class="sourceLineNo">078</span> final boolean immediateFlush = isImmediateFlush();<a name="line.78"></a>
<span class="sourceLineNo">079</span> final RandomAccessFileManager manager = RandomAccessFileManager.getFileManager(fileName, append,<a name="line.79"></a>
<span class="sourceLineNo">080</span> immediateFlush, getBufferSize(), advertiseURI, layout, null);<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (manager == null) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return null;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> return new RandomAccessFileAppender(name, layout, getFilter(), manager, fileName, isIgnoreExceptions(),<a name="line.85"></a>
<span class="sourceLineNo">086</span> immediateFlush, advertise ? getConfiguration().getAdvertiser() : null, getPropertyArray());<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> public B setFileName(final String fileName) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> this.fileName = fileName;<a name="line.90"></a>
<span class="sourceLineNo">091</span> return asBuilder();<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> public B setAppend(final boolean append) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> this.append = append;<a name="line.95"></a>
<span class="sourceLineNo">096</span> return asBuilder();<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> public B setAdvertise(final boolean advertise) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> this.advertise = advertise;<a name="line.100"></a>
<span class="sourceLineNo">101</span> return asBuilder();<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> public B setAdvertiseURI(final String advertiseURI) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.advertiseURI = advertiseURI;<a name="line.105"></a>
<span class="sourceLineNo">106</span> return asBuilder();<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> private final String fileName;<a name="line.111"></a>
<span class="sourceLineNo">112</span> private Object advertisement;<a name="line.112"></a>
<span class="sourceLineNo">113</span> private final Advertiser advertiser;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> private RandomAccessFileAppender(final String name, final Layout&lt;? extends Serializable&gt; layout,<a name="line.115"></a>
<span class="sourceLineNo">116</span> final Filter filter, final RandomAccessFileManager manager, final String filename,<a name="line.116"></a>
<span class="sourceLineNo">117</span> final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser,<a name="line.117"></a>
<span class="sourceLineNo">118</span> final Property[] properties) {<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> super(name, layout, filter, ignoreExceptions, immediateFlush, properties, manager);<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (advertiser != null) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> final Map&lt;String, String&gt; configuration = new HashMap&lt;&gt;(<a name="line.122"></a>
<span class="sourceLineNo">123</span> layout.getContentFormat());<a name="line.123"></a>
<span class="sourceLineNo">124</span> configuration.putAll(manager.getContentFormat());<a name="line.124"></a>
<span class="sourceLineNo">125</span> configuration.put("contentType", layout.getContentType());<a name="line.125"></a>
<span class="sourceLineNo">126</span> configuration.put("name", name);<a name="line.126"></a>
<span class="sourceLineNo">127</span> advertisement = advertiser.advertise(configuration);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> this.fileName = filename;<a name="line.129"></a>
<span class="sourceLineNo">130</span> this.advertiser = advertiser;<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> @Override<a name="line.133"></a>
<span class="sourceLineNo">134</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> setStopping();<a name="line.135"></a>
<span class="sourceLineNo">136</span> super.stop(timeout, timeUnit, false);<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (advertiser != null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> advertiser.unadvertise(advertisement);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span> setStopped();<a name="line.140"></a>
<span class="sourceLineNo">141</span> return true;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
<span class="sourceLineNo">145</span> * Write the log entry rolling over the file when required.<a name="line.145"></a>
<span class="sourceLineNo">146</span> *<a name="line.146"></a>
<span class="sourceLineNo">147</span> * @param event The LogEvent.<a name="line.147"></a>
<span class="sourceLineNo">148</span> */<a name="line.148"></a>
<span class="sourceLineNo">149</span> @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span> public void append(final LogEvent event) {<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> // Leverage the nice batching behaviour of async Loggers/Appenders:<a name="line.152"></a>
<span class="sourceLineNo">153</span> // we can signal the file manager that it needs to flush the buffer<a name="line.153"></a>
<span class="sourceLineNo">154</span> // to disk at the end of a batch.<a name="line.154"></a>
<span class="sourceLineNo">155</span> // From a user's point of view, this means that all log events are<a name="line.155"></a>
<span class="sourceLineNo">156</span> // _always_ available in the log file, without incurring the overhead<a name="line.156"></a>
<span class="sourceLineNo">157</span> // of immediateFlush=true.<a name="line.157"></a>
<span class="sourceLineNo">158</span> getManager().setEndOfBatch(event.isEndOfBatch()); // FIXME manager's EndOfBatch threadlocal can be deleted<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> // LOG4J2-1292 utilize gc-free Layout.encode() method: taken care of in superclass<a name="line.160"></a>
<span class="sourceLineNo">161</span> super.append(event);<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> /**<a name="line.164"></a>
<span class="sourceLineNo">165</span> * Returns the file name this appender is associated with.<a name="line.165"></a>
<span class="sourceLineNo">166</span> *<a name="line.166"></a>
<span class="sourceLineNo">167</span> * @return The File name.<a name="line.167"></a>
<span class="sourceLineNo">168</span> */<a name="line.168"></a>
<span class="sourceLineNo">169</span> public String getFileName() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return this.fileName;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Returns the size of the file manager's buffer.<a name="line.174"></a>
<span class="sourceLineNo">175</span> * @return the buffer size<a name="line.175"></a>
<span class="sourceLineNo">176</span> */<a name="line.176"></a>
<span class="sourceLineNo">177</span> public int getBufferSize() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> return getManager().getBufferSize();<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> // difference from standard File Appender:<a name="line.181"></a>
<span class="sourceLineNo">182</span> // locking is not supported and buffering cannot be switched off<a name="line.182"></a>
<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
<span class="sourceLineNo">184</span> * Create a File Appender.<a name="line.184"></a>
<span class="sourceLineNo">185</span> *<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @param fileName The name and path of the file.<a name="line.186"></a>
<span class="sourceLineNo">187</span> * @param append "True" if the file should be appended to, "false" if it<a name="line.187"></a>
<span class="sourceLineNo">188</span> * should be overwritten. The default is "true".<a name="line.188"></a>
<span class="sourceLineNo">189</span> * @param name The name of the Appender.<a name="line.189"></a>
<span class="sourceLineNo">190</span> * @param immediateFlush "true" if the contents should be flushed on every<a name="line.190"></a>
<span class="sourceLineNo">191</span> * write, "false" otherwise. The default is "true".<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @param bufferSizeStr The buffer size, defaults to {@value RandomAccessFileManager#DEFAULT_BUFFER_SIZE}.<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.193"></a>
<span class="sourceLineNo">194</span> * they are propagated to the caller.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param layout The layout to use to format the event. If no layout is<a name="line.195"></a>
<span class="sourceLineNo">196</span> * provided the default PatternLayout will be used.<a name="line.196"></a>
<span class="sourceLineNo">197</span> * @param filter The filter, if any, to use.<a name="line.197"></a>
<span class="sourceLineNo">198</span> * @param advertise "true" if the appender configuration should be<a name="line.198"></a>
<span class="sourceLineNo">199</span> * advertised, "false" otherwise.<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @param advertiseURI The advertised URI which can be used to retrieve the<a name="line.200"></a>
<span class="sourceLineNo">201</span> * file contents.<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @param configuration The Configuration.<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @return The FileAppender.<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @deprecated Use {@link #newBuilder()}.<a name="line.204"></a>
<span class="sourceLineNo">205</span> */<a name="line.205"></a>
<span class="sourceLineNo">206</span> @Deprecated<a name="line.206"></a>
<span class="sourceLineNo">207</span> public static &lt;B extends Builder&lt;B&gt;&gt; RandomAccessFileAppender createAppender(<a name="line.207"></a>
<span class="sourceLineNo">208</span> final String fileName,<a name="line.208"></a>
<span class="sourceLineNo">209</span> final String append,<a name="line.209"></a>
<span class="sourceLineNo">210</span> final String name,<a name="line.210"></a>
<span class="sourceLineNo">211</span> final String immediateFlush,<a name="line.211"></a>
<span class="sourceLineNo">212</span> final String bufferSizeStr,<a name="line.212"></a>
<span class="sourceLineNo">213</span> final String ignore,<a name="line.213"></a>
<span class="sourceLineNo">214</span> final Layout&lt;? extends Serializable&gt; layout,<a name="line.214"></a>
<span class="sourceLineNo">215</span> final Filter filter,<a name="line.215"></a>
<span class="sourceLineNo">216</span> final String advertise,<a name="line.216"></a>
<span class="sourceLineNo">217</span> final String advertiseURI,<a name="line.217"></a>
<span class="sourceLineNo">218</span> final Configuration configuration) {<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> final boolean isAppend = Booleans.parseBoolean(append, true);<a name="line.220"></a>
<span class="sourceLineNo">221</span> final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);<a name="line.221"></a>
<span class="sourceLineNo">222</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.222"></a>
<span class="sourceLineNo">223</span> final boolean isAdvertise = Boolean.parseBoolean(advertise);<a name="line.223"></a>
<span class="sourceLineNo">224</span> final int bufferSize = Integers.parseInt(bufferSizeStr, RandomAccessFileManager.DEFAULT_BUFFER_SIZE);<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> return RandomAccessFileAppender.&lt;B&gt;newBuilder()<a name="line.226"></a>
<span class="sourceLineNo">227</span> .setAdvertise(isAdvertise)<a name="line.227"></a>
<span class="sourceLineNo">228</span> .setAdvertiseURI(advertiseURI)<a name="line.228"></a>
<span class="sourceLineNo">229</span> .setAppend(isAppend)<a name="line.229"></a>
<span class="sourceLineNo">230</span> .withBufferSize(bufferSize)<a name="line.230"></a>
<span class="sourceLineNo">231</span> .setConfiguration(configuration)<a name="line.231"></a>
<span class="sourceLineNo">232</span> .setFileName(fileName).setFilter(filter).setIgnoreExceptions(ignoreExceptions)<a name="line.232"></a>
<span class="sourceLineNo">233</span> .withImmediateFlush(isFlush).setLayout(layout).setName(name)<a name="line.233"></a>
<span class="sourceLineNo">234</span> .build();<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<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> * Creates a builder for a RandomAccessFileAppender.<a name="line.238"></a>
<span class="sourceLineNo">239</span> * @return a builder for a RandomAccessFileAppender.<a name="line.239"></a>
<span class="sourceLineNo">240</span> */<a name="line.240"></a>
<span class="sourceLineNo">241</span> @PluginBuilderFactory<a name="line.241"></a>
<span class="sourceLineNo">242</span> public static &lt;B extends Builder&lt;B&gt;&gt; B newBuilder() {<a name="line.242"></a>
<span class="sourceLineNo">243</span> return new Builder&lt;B&gt;().asBuilder();<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span>}<a name="line.246"></a>
</pre>
</div>
</body>
</html>