1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.appender.rolling;
18
19 import java.text.ParseException;
20 import java.util.Calendar;
21 import java.util.Date;
22
23 import org.apache.logging.log4j.Logger;
24 import org.apache.logging.log4j.core.LogEvent;
25 import org.apache.logging.log4j.core.config.Configuration;
26 import org.apache.logging.log4j.core.config.CronScheduledFuture;
27 import org.apache.logging.log4j.core.config.Scheduled;
28 import org.apache.logging.log4j.core.config.plugins.Plugin;
29 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
30 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
31 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
32 import org.apache.logging.log4j.core.util.CronExpression;
33 import org.apache.logging.log4j.status.StatusLogger;
34
35
36
37
38 @Plugin(name = "CronTriggeringPolicy", category = "Core", printObject = true)
39 @Scheduled
40 public final class CronTriggeringPolicy implements TriggeringPolicy {
41
42 private static final Logger LOGGER = StatusLogger.getLogger();
43 private static final String defaultSchedule = "0 0 0 * * ?";
44 private RollingFileManager manager;
45 private final CronExpression cronExpression;
46 private final Configuration configuration;
47 private final boolean checkOnStartup;
48 private volatile Date nextRollDate;
49 private CronScheduledFuture future;
50
51 private CronTriggeringPolicy(final CronExpression schedule, final boolean checkOnStartup,
52 final Configuration configuration) {
53 this.cronExpression = schedule;
54 this.configuration = configuration;
55 this.checkOnStartup = checkOnStartup;
56 }
57
58
59
60
61
62 @Override
63 public void initialize(final RollingFileManager aManager) {
64 this.manager = aManager;
65 final Date nextDate = new Date(this.manager.getFileTime());
66 nextRollDate = cronExpression.getNextValidTimeAfter(nextDate);
67 if (checkOnStartup) {
68 if (nextRollDate.getTime() < System.currentTimeMillis()) {
69 rollover();
70 }
71 }
72 future = configuration.getScheduler().scheduleWithCron(cronExpression, new CronTrigger());
73 }
74
75
76
77
78
79
80 @Override
81 public boolean isTriggeringEvent(final LogEvent event) {
82 return false;
83 }
84
85 public CronExpression getCronExpression() {
86 return cronExpression;
87 }
88
89
90
91
92
93
94
95
96 @PluginFactory
97 public static CronTriggeringPolicy createPolicy(
98 @PluginConfiguration final Configuration configuration,
99 @PluginAttribute("evaluateOnStartup") final String evaluateOnStartup,
100 @PluginAttribute("schedule") final String schedule) {
101 CronExpression cronExpression;
102 final boolean checkOnStartup = Boolean.parseBoolean(evaluateOnStartup);
103 if (schedule == null) {
104 LOGGER.info("No schedule specified, defaulting to Daily");
105 cronExpression = getSchedule(defaultSchedule);
106 } else {
107 cronExpression = getSchedule(schedule);
108 if (cronExpression == null) {
109 LOGGER.error("Invalid expression specified. Defaulting to Daily");
110 cronExpression = getSchedule(defaultSchedule);
111 }
112 }
113 return new CronTriggeringPolicy(cronExpression, checkOnStartup, configuration);
114 }
115
116 private static CronExpression getSchedule(final String expression) {
117 try {
118 return new CronExpression(expression);
119 } catch (final ParseException pe) {
120 LOGGER.error("Invalid cron expression - " + expression, pe);
121 return null;
122 }
123 }
124
125 private void rollover() {
126 manager.getPatternProcessor().setPrevFileTime(nextRollDate.getTime());
127 manager.rollover();
128 final Date fireDate = future.getFireTime();
129 Calendar cal = Calendar.getInstance();
130 cal.setTime(fireDate);
131 cal.add(Calendar.SECOND, -1);
132 nextRollDate = cal.getTime();
133 }
134
135 @Override
136 public String toString() {
137 return "CronTriggeringPolicy(schedule=" + cronExpression.getCronExpression() + ")";
138 }
139
140 private class CronTrigger implements Runnable {
141
142 @Override
143 public void run() {
144 rollover();
145 }
146 }
147 }