| <!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.log4j.builders.appender;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.log4j.Appender;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.log4j.Layout;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.log4j.bridge.AppenderWrapper;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.log4j.bridge.FilterAdapter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.log4j.bridge.FilterWrapper;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.log4j.bridge.LayoutAdapter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.log4j.bridge.LayoutWrapper;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.log4j.builders.AbstractBuilder;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.log4j.builders.BooleanHolder;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.log4j.builders.Holder;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.log4j.config.Log4j1Configuration;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.log4j.config.PropertiesConfiguration;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.log4j.spi.Filter;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.log4j.xml.XmlConfiguration;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.Logger;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.appender.RollingFileAppender;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.appender.rolling.CompositeTriggeringPolicy;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.appender.rolling.SizeBasedTriggeringPolicy;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.w3c.dom.Element;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import java.util.Properties;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import static org.apache.log4j.builders.BuilderManager.CATEGORY;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import static org.apache.log4j.config.Log4j1Configuration.THRESHOLD_PARAM;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import static org.apache.log4j.xml.XmlConfiguration.FILTER_TAG;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import static org.apache.log4j.xml.XmlConfiguration.LAYOUT_TAG;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import static org.apache.log4j.xml.XmlConfiguration.NAME_ATTR;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import static org.apache.log4j.xml.XmlConfiguration.PARAM_TAG;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import static org.apache.log4j.xml.XmlConfiguration.VALUE_ATTR;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import static org.apache.log4j.xml.XmlConfiguration.forEachElement;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span>/**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Build a File Appender<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>@Plugin(name = "org.apache.log4j.RollingFileAppender", category = CATEGORY)<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>public class RollingFileAppenderBuilder extends AbstractBuilder implements AppenderBuilder {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public RollingFileAppenderBuilder() {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public RollingFileAppenderBuilder(String prefix, Properties props) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> super(prefix, props);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> @Override<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public Appender parseAppender(Element appenderElement, XmlConfiguration config) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> String name = appenderElement.getAttribute(NAME_ATTR);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> Holder<Layout> layout = new Holder<>();<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> Holder<Filter> filter = new Holder<>();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> Holder<String> fileName = new Holder<>();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> Holder<Boolean> immediateFlush = new BooleanHolder();<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> Holder<Boolean> append = new BooleanHolder();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> Holder<Boolean> bufferedIo = new BooleanHolder();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Holder<Integer> bufferSize = new Holder<>(8192);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> Holder<String> maxSize = new Holder<>();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> Holder<String> maxBackups = new Holder<>();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> Holder<String> level = new Holder<>();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> forEachElement(appenderElement.getChildNodes(), (currentElement) -> {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> switch (currentElement.getTagName()) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> case LAYOUT_TAG:<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> layout.set(config.parseLayout(currentElement));<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> break;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> case FILTER_TAG:<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> filter.set(config.parseFilters(currentElement));<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> break;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> case PARAM_TAG: {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> switch (currentElement.getAttribute(NAME_ATTR)) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> case FILE_PARAM:<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> fileName.set(currentElement.getAttribute(VALUE_ATTR));<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> break;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> case APPEND_PARAM: {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> String bool = currentElement.getAttribute(VALUE_ATTR);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> if (bool != null) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> append.set(Boolean.parseBoolean(bool));<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> } else {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> LOGGER.warn("No value provided for append parameter");<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> break;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> case BUFFERED_IO_PARAM: {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> String bool = currentElement.getAttribute(VALUE_ATTR);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (bool != null) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> bufferedIo.set(Boolean.parseBoolean(bool));<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> } else {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> LOGGER.warn("No value provided for bufferedIo parameter");<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> break;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> case BUFFER_SIZE_PARAM: {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> String size = currentElement.getAttribute(VALUE_ATTR);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (size != null) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> bufferSize.set(Integer.parseInt(size));<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> } else {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> LOGGER.warn("No value provide for bufferSize parameter");<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> break;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> case MAX_BACKUP_INDEX: {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> String size = currentElement.getAttribute(VALUE_ATTR);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> if (size != null) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> maxBackups.set(size);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> } else {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> LOGGER.warn("No value provide for maxBackupIndex parameter");<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> break;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> case MAX_SIZE_PARAM: {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> String size = currentElement.getAttribute(VALUE_ATTR);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (size != null) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> maxSize.set(size);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> } else {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> LOGGER.warn("No value provide for bufferSize parameter");<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> break;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> case THRESHOLD_PARAM: {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> String value = currentElement.getAttribute(VALUE_ATTR);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (value == null) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> LOGGER.warn("No value supplied for Threshold parameter, ignoring.");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> } else {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> level.set(value);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> break;<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> break;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<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> return createAppender(name, config, layout.get(), filter.get(), bufferedIo.get(), immediateFlush.get(),<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> fileName.get(), level.get(), maxSize.get(), maxBackups.get());<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<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> @Override<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public Appender parseAppender(final String name, final String appenderPrefix, final String layoutPrefix,<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> final String filterPrefix, final Properties props, final PropertiesConfiguration configuration) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> Layout layout = configuration.parseLayout(layoutPrefix, name, props);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> Filter filter = configuration.parseAppenderFilters(props, filterPrefix, name);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> String fileName = getProperty(FILE_PARAM);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> String level = getProperty(THRESHOLD_PARAM);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> boolean immediateFlush = false;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> boolean bufferedIo = getBooleanProperty(BUFFERED_IO_PARAM);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> String maxSize = getProperty(MAX_SIZE_PARAM);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> String maxBackups = getProperty(MAX_BACKUP_INDEX);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return createAppender(name, configuration, layout, filter, bufferedIo, immediateFlush, fileName, level, maxSize,<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> maxBackups);<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> private Appender createAppender(final String name, final Log4j1Configuration config, final Layout layout,<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> final Filter filter, final boolean bufferedIo, boolean immediateFlush, final String fileName,<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> final String level, final String maxSize, final String maxBackups) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> org.apache.logging.log4j.core.Layout<?> fileLayout = null;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> if (bufferedIo) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> immediateFlush = true;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> if (layout instanceof LayoutWrapper) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> fileLayout = ((LayoutWrapper) layout).getLayout();<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> } else if (layout != null) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> fileLayout = new LayoutAdapter(layout);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> org.apache.logging.log4j.core.Filter fileFilter = buildFilters(level, filter);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> if (fileName == null) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> LOGGER.warn("Unable to create File Appender, no file name provided");<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> return null;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> String filePattern = fileName +"%d{yyy-MM-dd}";<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> TriggeringPolicy timePolicy = TimeBasedTriggeringPolicy.newBuilder().withModulate(true).build();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> SizeBasedTriggeringPolicy sizePolicy = SizeBasedTriggeringPolicy.createPolicy(maxSize);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> CompositeTriggeringPolicy policy = CompositeTriggeringPolicy.createPolicy(sizePolicy, timePolicy);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> .withConfig(config)<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> .withMax(maxBackups)<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> .build();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return new AppenderWrapper(RollingFileAppender.newBuilder()<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> .setName(name)<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> .setConfiguration(config)<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> .setLayout(fileLayout)<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> .setFilter(fileFilter)<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> .withBufferedIo(bufferedIo)<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> .withImmediateFlush(immediateFlush)<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> .withFileName(fileName)<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> .withFilePattern(filePattern)<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> .withPolicy(policy)<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> .withStrategy(strategy)<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> .build());<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
