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.util.concurrent.ThreadLocalRandom;
20 import java.util.concurrent.TimeUnit;
21
22 import org.apache.logging.log4j.core.Core;
23 import org.apache.logging.log4j.core.LogEvent;
24 import org.apache.logging.log4j.core.config.plugins.Plugin;
25 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
26 import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
27 import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
28 import org.apache.logging.log4j.core.util.Integers;
29
30
31
32
33 @Plugin(name = "TimeBasedTriggeringPolicy", category = Core.CATEGORY_NAME, printObject = true)
34 public final class TimeBasedTriggeringPolicy extends AbstractTriggeringPolicy {
35
36
37 public static class Builder implements org.apache.logging.log4j.core.util.Builder<TimeBasedTriggeringPolicy> {
38
39 @PluginBuilderAttribute
40 private int interval = 1;
41
42 @PluginBuilderAttribute
43 private boolean modulate = false;
44
45 @PluginBuilderAttribute
46 private int maxRandomDelay = 0;
47
48 @Override
49 public TimeBasedTriggeringPolicy build() {
50 final long maxRandomDelayMillis = TimeUnit.SECONDS.toMillis(maxRandomDelay);
51 return new TimeBasedTriggeringPolicy(interval, modulate, maxRandomDelayMillis);
52 }
53
54 public int getInterval() {
55 return interval;
56 }
57
58 public boolean isModulate() {
59 return modulate;
60 }
61
62 public int getMaxRandomDelay() {
63 return maxRandomDelay;
64 }
65
66 public Builder withInterval(final int interval){
67 this.interval = interval;
68 return this;
69 }
70
71 public Builder withModulate(final boolean modulate){
72 this.modulate = modulate;
73 return this;
74 }
75
76 public Builder withMaxRandomDelay(final int maxRandomDelay){
77 this.maxRandomDelay = maxRandomDelay;
78 return this;
79 }
80
81 }
82
83 private long nextRolloverMillis;
84 private final int interval;
85 private final boolean modulate;
86 private final long maxRandomDelayMillis;
87
88 private RollingFileManager manager;
89
90 private TimeBasedTriggeringPolicy(final int interval, final boolean modulate, final long maxRandomDelayMillis) {
91 this.interval = interval;
92 this.modulate = modulate;
93 this.maxRandomDelayMillis = maxRandomDelayMillis;
94 }
95
96 public int getInterval() {
97 return interval;
98 }
99
100 public long getNextRolloverMillis() {
101 return nextRolloverMillis;
102 }
103
104
105
106
107
108 @Override
109 public void initialize(final RollingFileManager aManager) {
110 this.manager = aManager;
111
112
113 aManager.getPatternProcessor().getNextTime(aManager.getFileTime(), interval, modulate);
114
115 nextRolloverMillis = ThreadLocalRandom.current().nextLong(0, 1 + maxRandomDelayMillis)
116 + aManager.getPatternProcessor().getNextTime(aManager.getFileTime(), interval, modulate);
117 }
118
119
120
121
122
123
124 @Override
125 public boolean isTriggeringEvent(final LogEvent event) {
126 if (manager.getFileSize() == 0) {
127 return false;
128 }
129 final long nowMillis = event.getTimeMillis();
130 if (nowMillis >= nextRolloverMillis) {
131 nextRolloverMillis = ThreadLocalRandom.current().nextLong(0, 1 + maxRandomDelayMillis)
132 + manager.getPatternProcessor().getNextTime(nowMillis, interval, modulate);
133 return true;
134 }
135 return false;
136 }
137
138
139
140
141
142
143
144
145 @Deprecated
146 public static TimeBasedTriggeringPolicy createPolicy(
147 @PluginAttribute("interval") final String interval,
148 @PluginAttribute("modulate") final String modulate) {
149 return newBuilder()
150 .withInterval(Integers.parseInt(interval, 1))
151 .withModulate(Boolean.parseBoolean(modulate))
152 .build();
153 }
154
155 @PluginBuilderFactory
156 public static TimeBasedTriggeringPolicy.Builder newBuilder() {
157 return new Builder();
158 }
159
160 @Override
161 public String toString() {
162 return "TimeBasedTriggeringPolicy(nextRolloverMillis=" + nextRolloverMillis + ", interval=" + interval
163 + ", modulate=" + modulate + ")";
164 }
165
166 }