Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / rolling / CronTriggeringPolicy.html
blob: 2ca4d4bf6a9549257959612b275522d370d8ee70 [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.rolling;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.text.ParseException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Date;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Objects;<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.Core;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.ConfigurationScheduler;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.CronScheduledFuture;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Scheduled;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.util.CronExpression;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Rolls a file over based on a cron schedule.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@Plugin(name = "CronTriggeringPolicy", category = Core.CATEGORY_NAME, printObject = true)<a name="line.39"></a>
<span class="sourceLineNo">040</span>@Scheduled<a name="line.40"></a>
<span class="sourceLineNo">041</span>public final class CronTriggeringPolicy extends AbstractTriggeringPolicy {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> private static final String defaultSchedule = "0 0 0 * * ?";<a name="line.43"></a>
<span class="sourceLineNo">044</span> private RollingFileManager manager;<a name="line.44"></a>
<span class="sourceLineNo">045</span> private final CronExpression cronExpression;<a name="line.45"></a>
<span class="sourceLineNo">046</span> private final Configuration configuration;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private final boolean checkOnStartup;<a name="line.47"></a>
<span class="sourceLineNo">048</span> private volatile Date lastRollDate;<a name="line.48"></a>
<span class="sourceLineNo">049</span> private CronScheduledFuture&lt;?&gt; future;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private CronTriggeringPolicy(final CronExpression schedule, final boolean checkOnStartup,<a name="line.51"></a>
<span class="sourceLineNo">052</span> final Configuration configuration) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.cronExpression = Objects.requireNonNull(schedule, "schedule");<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.configuration = Objects.requireNonNull(configuration, "configuration");<a name="line.54"></a>
<span class="sourceLineNo">055</span> this.checkOnStartup = checkOnStartup;<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> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Initializes the policy.<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param aManager<a name="line.61"></a>
<span class="sourceLineNo">062</span> * The RollingFileManager.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> @Override<a name="line.64"></a>
<span class="sourceLineNo">065</span> public void initialize(final RollingFileManager aManager) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.manager = aManager;<a name="line.66"></a>
<span class="sourceLineNo">067</span> final Date now = new Date();<a name="line.67"></a>
<span class="sourceLineNo">068</span> final Date lastRollForFile = cronExpression.getPrevFireTime(new Date(this.manager.getFileTime()));<a name="line.68"></a>
<span class="sourceLineNo">069</span> final Date lastRegularRoll = cronExpression.getPrevFireTime(new Date());<a name="line.69"></a>
<span class="sourceLineNo">070</span> aManager.getPatternProcessor().setCurrentFileTime(lastRegularRoll.getTime());<a name="line.70"></a>
<span class="sourceLineNo">071</span> LOGGER.debug("LastRollForFile {}, LastRegularRole {}", lastRollForFile, lastRegularRoll);<a name="line.71"></a>
<span class="sourceLineNo">072</span> aManager.getPatternProcessor().setPrevFileTime(lastRegularRoll.getTime());<a name="line.72"></a>
<span class="sourceLineNo">073</span> aManager.getPatternProcessor().setTimeBased(true);<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (checkOnStartup &amp;&amp; lastRollForFile != null &amp;&amp; lastRegularRoll != null &amp;&amp;<a name="line.74"></a>
<span class="sourceLineNo">075</span> lastRollForFile.before(lastRegularRoll)) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> lastRollDate = lastRollForFile;<a name="line.76"></a>
<span class="sourceLineNo">077</span> rollover();<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> final ConfigurationScheduler scheduler = configuration.getScheduler();<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (!scheduler.isExecutorServiceSet()) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> // make sure we have a thread pool<a name="line.82"></a>
<span class="sourceLineNo">083</span> scheduler.incrementScheduledItems();<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> if (!scheduler.isStarted()) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> scheduler.start();<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> lastRollDate = lastRegularRoll;<a name="line.88"></a>
<span class="sourceLineNo">089</span> future = scheduler.scheduleWithCron(cronExpression, now, new CronTrigger());<a name="line.89"></a>
<span class="sourceLineNo">090</span> LOGGER.debug(scheduler.toString());<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<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> * Determines whether a rollover should occur.<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param event<a name="line.96"></a>
<span class="sourceLineNo">097</span> * A reference to the currently event.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @return true if a rollover should occur.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public boolean isTriggeringEvent(final LogEvent event) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return false;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public CronExpression getCronExpression() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return cronExpression;<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> * Creates a ScheduledTriggeringPolicy.<a name="line.110"></a>
<span class="sourceLineNo">111</span> *<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param configuration<a name="line.112"></a>
<span class="sourceLineNo">113</span> * the Configuration.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param evaluateOnStartup<a name="line.114"></a>
<span class="sourceLineNo">115</span> * check if the file should be rolled over immediately.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @param schedule<a name="line.116"></a>
<span class="sourceLineNo">117</span> * the cron expression.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return a ScheduledTriggeringPolicy.<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> @PluginFactory<a name="line.120"></a>
<span class="sourceLineNo">121</span> public static CronTriggeringPolicy createPolicy(@PluginConfiguration final Configuration configuration,<a name="line.121"></a>
<span class="sourceLineNo">122</span> @PluginAttribute("evaluateOnStartup") final String evaluateOnStartup,<a name="line.122"></a>
<span class="sourceLineNo">123</span> @PluginAttribute("schedule") final String schedule) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> CronExpression cronExpression;<a name="line.124"></a>
<span class="sourceLineNo">125</span> final boolean checkOnStartup = Boolean.parseBoolean(evaluateOnStartup);<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (schedule == null) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> LOGGER.info("No schedule specified, defaulting to Daily");<a name="line.127"></a>
<span class="sourceLineNo">128</span> cronExpression = getSchedule(defaultSchedule);<a name="line.128"></a>
<span class="sourceLineNo">129</span> } else {<a name="line.129"></a>
<span class="sourceLineNo">130</span> cronExpression = getSchedule(schedule);<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (cronExpression == null) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> LOGGER.error("Invalid expression specified. Defaulting to Daily");<a name="line.132"></a>
<span class="sourceLineNo">133</span> cronExpression = getSchedule(defaultSchedule);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span> return new CronTriggeringPolicy(cronExpression, checkOnStartup, configuration);<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> private static CronExpression getSchedule(final String expression) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> try {<a name="line.140"></a>
<span class="sourceLineNo">141</span> return new CronExpression(expression);<a name="line.141"></a>
<span class="sourceLineNo">142</span> } catch (final ParseException pe) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> LOGGER.error("Invalid cron expression - " + expression, pe);<a name="line.143"></a>
<span class="sourceLineNo">144</span> return null;<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><a name="line.147"></a>
<span class="sourceLineNo">148</span> private void rollover() {<a name="line.148"></a>
<span class="sourceLineNo">149</span> manager.rollover(cronExpression.getPrevFireTime(new Date()), lastRollDate);<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (future != null) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> lastRollDate = future.getFireTime();<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> @Override<a name="line.155"></a>
<span class="sourceLineNo">156</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> setStopping();<a name="line.157"></a>
<span class="sourceLineNo">158</span> final boolean stopped = stop(future);<a name="line.158"></a>
<span class="sourceLineNo">159</span> setStopped();<a name="line.159"></a>
<span class="sourceLineNo">160</span> return stopped;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span> public String toString() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return "CronTriggeringPolicy(schedule=" + cronExpression.getCronExpression() + ")";<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> private class CronTrigger implements Runnable {<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> @Override<a name="line.170"></a>
<span class="sourceLineNo">171</span> public void run() {<a name="line.171"></a>
<span class="sourceLineNo">172</span> rollover();<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span>}<a name="line.175"></a>
</pre>
</div>
</body>
</html>