Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / rolling / PatternProcessor.html
blob: 02193a8fd6f47317abcd85a3d9965fb5868c5a62 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender.rolling;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.core.pattern.ArrayPatternConverter;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.pattern.DatePatternConverter;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.pattern.FormattingInfo;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.pattern.PatternConverter;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.pattern.PatternParser;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.ArrayList;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.Calendar;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.Date;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.List;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * Parse the rollover pattern.<a name="line.31"></a>
<FONT color="green">032</FONT> */<a name="line.32"></a>
<FONT color="green">033</FONT> public class PatternProcessor {<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> private static final String KEY = "FileConverter";<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> private static final char YEAR_CHAR = 'y';<a name="line.37"></a>
<FONT color="green">038</FONT> private static final char MONTH_CHAR = 'M';<a name="line.38"></a>
<FONT color="green">039</FONT> private static final char[] WEEK_CHARS = {'w', 'W'};<a name="line.39"></a>
<FONT color="green">040</FONT> private static final char[] DAY_CHARS = {'D', 'd', 'F', 'E'};<a name="line.40"></a>
<FONT color="green">041</FONT> private static final char[] HOUR_CHARS = {'H', 'K', 'h', 'k'};<a name="line.41"></a>
<FONT color="green">042</FONT> private static final char MINUTE_CHAR = 'm';<a name="line.42"></a>
<FONT color="green">043</FONT> private static final char SECOND_CHAR = 's';<a name="line.43"></a>
<FONT color="green">044</FONT> private static final char MILLIS_CHAR = 'S';<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> private final ArrayPatternConverter[] patternConverters;<a name="line.46"></a>
<FONT color="green">047</FONT> private final FormattingInfo[] patternFields;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> private RolloverFrequency frequency = null;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Constructor.<a name="line.52"></a>
<FONT color="green">053</FONT> * @param pattern The file pattern.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> public PatternProcessor(String pattern) {<a name="line.55"></a>
<FONT color="green">056</FONT> PatternParser parser = createPatternParser();<a name="line.56"></a>
<FONT color="green">057</FONT> List&lt;PatternConverter&gt; converters = new ArrayList&lt;PatternConverter&gt;();<a name="line.57"></a>
<FONT color="green">058</FONT> List&lt;FormattingInfo&gt; fields = new ArrayList&lt;FormattingInfo&gt;();<a name="line.58"></a>
<FONT color="green">059</FONT> parser.parse(pattern, converters, fields);<a name="line.59"></a>
<FONT color="green">060</FONT> FormattingInfo[] infoArray = new FormattingInfo[fields.size()];<a name="line.60"></a>
<FONT color="green">061</FONT> patternFields = fields.toArray(infoArray);<a name="line.61"></a>
<FONT color="green">062</FONT> ArrayPatternConverter[] converterArray = new ArrayPatternConverter[converters.size()];<a name="line.62"></a>
<FONT color="green">063</FONT> patternConverters = converters.toArray(converterArray);<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> for (ArrayPatternConverter converter : patternConverters) {<a name="line.65"></a>
<FONT color="green">066</FONT> if (converter instanceof DatePatternConverter) {<a name="line.66"></a>
<FONT color="green">067</FONT> DatePatternConverter dateConverter = (DatePatternConverter) converter;<a name="line.67"></a>
<FONT color="green">068</FONT> frequency = calculateFrequency(dateConverter.getPattern());<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> /**<a name="line.73"></a>
<FONT color="green">074</FONT> * Return the next expire time.<a name="line.74"></a>
<FONT color="green">075</FONT> * @param current The current time.<a name="line.75"></a>
<FONT color="green">076</FONT> * @return The next expire time.<a name="line.76"></a>
<FONT color="green">077</FONT> */<a name="line.77"></a>
<FONT color="green">078</FONT> public long getNextTime(long current) {<a name="line.78"></a>
<FONT color="green">079</FONT> return getNextTime(current, 1);<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> /**<a name="line.82"></a>
<FONT color="green">083</FONT> * Return the next potential rollover time.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param current The current time.<a name="line.84"></a>
<FONT color="green">085</FONT> * @param increment The increment to the next time.<a name="line.85"></a>
<FONT color="green">086</FONT> * @return the next potential rollover time.<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> public long getNextTime(long current, int increment) {<a name="line.88"></a>
<FONT color="green">089</FONT> if (frequency == null) {<a name="line.89"></a>
<FONT color="green">090</FONT> throw new IllegalStateException("Pattern does not contain a date");<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> Calendar currentCal = Calendar.getInstance();<a name="line.92"></a>
<FONT color="green">093</FONT> currentCal.setTimeInMillis(current);<a name="line.93"></a>
<FONT color="green">094</FONT> Calendar cal = Calendar.getInstance();<a name="line.94"></a>
<FONT color="green">095</FONT> cal.set(currentCal.get(Calendar.YEAR), 0, 1, 0, 0, 0);<a name="line.95"></a>
<FONT color="green">096</FONT> cal.set(Calendar.MILLISECOND, 0);<a name="line.96"></a>
<FONT color="green">097</FONT> if (frequency == RolloverFrequency.ANNUALLY) {<a name="line.97"></a>
<FONT color="green">098</FONT> cal.add(Calendar.YEAR, increment);<a name="line.98"></a>
<FONT color="green">099</FONT> return cal.getTimeInMillis();<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> if (frequency == RolloverFrequency.MONTHLY) {<a name="line.101"></a>
<FONT color="green">102</FONT> cal.add(Calendar.MONTH, increment);<a name="line.102"></a>
<FONT color="green">103</FONT> return cal.getTimeInMillis();<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> if (frequency == RolloverFrequency.WEEKLY) {<a name="line.105"></a>
<FONT color="green">106</FONT> cal.set(Calendar.WEEK_OF_YEAR, currentCal.get(Calendar.WEEK_OF_YEAR) + increment);<a name="line.106"></a>
<FONT color="green">107</FONT> return cal.getTimeInMillis();<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> cal.set(Calendar.DAY_OF_YEAR, currentCal.get(Calendar.DAY_OF_YEAR));<a name="line.109"></a>
<FONT color="green">110</FONT> if (frequency == RolloverFrequency.DAILY) {<a name="line.110"></a>
<FONT color="green">111</FONT> cal.add(Calendar.DAY_OF_YEAR, increment);<a name="line.111"></a>
<FONT color="green">112</FONT> return cal.getTimeInMillis();<a name="line.112"></a>
<FONT color="green">113</FONT> }<a name="line.113"></a>
<FONT color="green">114</FONT> cal.set(Calendar.HOUR, currentCal.get(Calendar.HOUR));<a name="line.114"></a>
<FONT color="green">115</FONT> if (frequency == RolloverFrequency.HOURLY) {<a name="line.115"></a>
<FONT color="green">116</FONT> cal.add(Calendar.HOUR, increment);<a name="line.116"></a>
<FONT color="green">117</FONT> return cal.getTimeInMillis();<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> cal.set(Calendar.MINUTE, currentCal.get(Calendar.MINUTE));<a name="line.119"></a>
<FONT color="green">120</FONT> if (frequency == RolloverFrequency.EVERY_MINUTE) {<a name="line.120"></a>
<FONT color="green">121</FONT> cal.add(Calendar.MINUTE, increment);<a name="line.121"></a>
<FONT color="green">122</FONT> return cal.getTimeInMillis();<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> cal.set(Calendar.SECOND, currentCal.get(Calendar.SECOND));<a name="line.124"></a>
<FONT color="green">125</FONT> if (frequency == RolloverFrequency.EVERY_SECOND) {<a name="line.125"></a>
<FONT color="green">126</FONT> cal.add(Calendar.SECOND, increment);<a name="line.126"></a>
<FONT color="green">127</FONT> return cal.getTimeInMillis();<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> cal.set(Calendar.MILLISECOND, currentCal.get(Calendar.MILLISECOND) + increment);<a name="line.129"></a>
<FONT color="green">130</FONT> return cal.getTimeInMillis();<a name="line.130"></a>
<FONT color="green">131</FONT> }<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> /**<a name="line.133"></a>
<FONT color="green">134</FONT> * Format file name.<a name="line.134"></a>
<FONT color="green">135</FONT> *<a name="line.135"></a>
<FONT color="green">136</FONT> * @param obj object to be evaluated in formatting, may not be null.<a name="line.136"></a>
<FONT color="green">137</FONT> * @param buf string buffer to which formatted file name is appended, may not be null.<a name="line.137"></a>
<FONT color="green">138</FONT> */<a name="line.138"></a>
<FONT color="green">139</FONT> protected final void formatFileName(final Object obj, final StringBuilder buf) {<a name="line.139"></a>
<FONT color="green">140</FONT> Object[] objects = new Object[] {new Date(System.currentTimeMillis()), obj};<a name="line.140"></a>
<FONT color="green">141</FONT> formatFileName(objects, buf);<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> /**<a name="line.144"></a>
<FONT color="green">145</FONT> * Format file name.<a name="line.145"></a>
<FONT color="green">146</FONT> *<a name="line.146"></a>
<FONT color="green">147</FONT> * @param objects objects to be evaluated in formatting, may not be null.<a name="line.147"></a>
<FONT color="green">148</FONT> * @param buf string buffer to which formatted file name is appended, may not be null.<a name="line.148"></a>
<FONT color="green">149</FONT> */<a name="line.149"></a>
<FONT color="green">150</FONT> protected final void formatFileName(final Object[] objects, final StringBuilder buf) {<a name="line.150"></a>
<FONT color="green">151</FONT> for (int i = 0; i &lt; patternConverters.length; i++) {<a name="line.151"></a>
<FONT color="green">152</FONT> int fieldStart = buf.length();<a name="line.152"></a>
<FONT color="green">153</FONT> patternConverters[i].format(objects, buf);<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> if (patternFields[i] != null) {<a name="line.155"></a>
<FONT color="green">156</FONT> patternFields[i].format(fieldStart, buf);<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> <a name="line.160"></a>
<FONT color="green">161</FONT> private RolloverFrequency calculateFrequency(String pattern) {<a name="line.161"></a>
<FONT color="green">162</FONT> if (patternContains(pattern, MILLIS_CHAR)) {<a name="line.162"></a>
<FONT color="green">163</FONT> return RolloverFrequency.EVERY_MILLISECOND;<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> if (patternContains(pattern, SECOND_CHAR)) {<a name="line.165"></a>
<FONT color="green">166</FONT> return RolloverFrequency.EVERY_SECOND;<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> if (patternContains(pattern, MINUTE_CHAR)) {<a name="line.168"></a>
<FONT color="green">169</FONT> return RolloverFrequency.EVERY_MINUTE;<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
<FONT color="green">171</FONT> if (patternContains(pattern, HOUR_CHARS)) {<a name="line.171"></a>
<FONT color="green">172</FONT> return RolloverFrequency.HOURLY;<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> if (patternContains(pattern, DAY_CHARS)) {<a name="line.174"></a>
<FONT color="green">175</FONT> return RolloverFrequency.DAILY;<a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
<FONT color="green">177</FONT> if (patternContains(pattern, WEEK_CHARS)) {<a name="line.177"></a>
<FONT color="green">178</FONT> return RolloverFrequency.WEEKLY;<a name="line.178"></a>
<FONT color="green">179</FONT> }<a name="line.179"></a>
<FONT color="green">180</FONT> if (patternContains(pattern, MONTH_CHAR)) {<a name="line.180"></a>
<FONT color="green">181</FONT> return RolloverFrequency.MONTHLY;<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> if (patternContains(pattern, YEAR_CHAR)) {<a name="line.183"></a>
<FONT color="green">184</FONT> return RolloverFrequency.ANNUALLY;<a name="line.184"></a>
<FONT color="green">185</FONT> }<a name="line.185"></a>
<FONT color="green">186</FONT> return null;<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> <a name="line.188"></a>
<FONT color="green">189</FONT> private PatternParser createPatternParser() {<a name="line.189"></a>
<FONT color="green">190</FONT> <a name="line.190"></a>
<FONT color="green">191</FONT> return new PatternParser(null, KEY, null);<a name="line.191"></a>
<FONT color="green">192</FONT> }<a name="line.192"></a>
<FONT color="green">193</FONT> <a name="line.193"></a>
<FONT color="green">194</FONT> private boolean patternContains(String pattern, char[] chars) {<a name="line.194"></a>
<FONT color="green">195</FONT> for (char character : chars) {<a name="line.195"></a>
<FONT color="green">196</FONT> if (patternContains(pattern, character)) {<a name="line.196"></a>
<FONT color="green">197</FONT> return true;<a name="line.197"></a>
<FONT color="green">198</FONT> }<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> return false;<a name="line.200"></a>
<FONT color="green">201</FONT> }<a name="line.201"></a>
<FONT color="green">202</FONT> <a name="line.202"></a>
<FONT color="green">203</FONT> private boolean patternContains(String pattern, char character) {<a name="line.203"></a>
<FONT color="green">204</FONT> return pattern.indexOf(character) &gt;= 0;<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> }<a name="line.206"></a>
</PRE>
</BODY>
</HTML>