package org.apache.logging.log4j.core.appender.rolling;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;
import org.apache.logging.log4j.core.Core;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
import org.apache.logging.log4j.core.util.Integers;
@Plugin(name = "TimeBasedTriggeringPolicy", category = Core.CATEGORY_NAME, printObject = true)
public final class TimeBasedTriggeringPolicy extends AbstractTriggeringPolicy {
public static class Builder implements org.apache.logging.log4j.core.util.Builder<TimeBasedTriggeringPolicy> {
@PluginBuilderAttribute
private int interval = 1;
@PluginBuilderAttribute
private boolean modulate = false;
@PluginBuilderAttribute
private int maxRandomDelay = 0;
@Override
public TimeBasedTriggeringPolicy build() {
final long maxRandomDelayMillis = TimeUnit.SECONDS.toMillis(maxRandomDelay);
return new TimeBasedTriggeringPolicy(interval, modulate, maxRandomDelayMillis);
}
public int getInterval() {
return interval;
}
public boolean isModulate() {
return modulate;
}
public int getMaxRandomDelay() {
return maxRandomDelay;
}
public Builder withInterval(final int interval){
this.interval = interval;
return this;
}
public Builder withModulate(final boolean modulate){
this.modulate = modulate;
return this;
}
public Builder withMaxRandomDelay(final int maxRandomDelay){
this.maxRandomDelay = maxRandomDelay;
return this;
}
}
private long nextRolloverMillis;
private final int interval;
private final boolean modulate;
private final long maxRandomDelayMillis;
private RollingFileManager manager;
private TimeBasedTriggeringPolicy(final int interval, final boolean modulate, final long maxRandomDelayMillis) {
this.interval = interval;
this.modulate = modulate;
this.maxRandomDelayMillis = maxRandomDelayMillis;
}
public int getInterval() {
return interval;
}
public long getNextRolloverMillis() {
return nextRolloverMillis;
}
@Override
public void initialize(final RollingFileManager aManager) {
this.manager = aManager;
aManager.getPatternProcessor().getNextTime(aManager.getFileTime(), interval, modulate);
nextRolloverMillis = ThreadLocalRandom.current().nextLong(0, 1 + maxRandomDelayMillis)
+ aManager.getPatternProcessor().getNextTime(aManager.getFileTime(), interval, modulate);
}
@Override
public boolean isTriggeringEvent(final LogEvent event) {
if (manager.getFileSize() == 0) {
return false;
}
final long nowMillis = event.getTimeMillis();
if (nowMillis >= nextRolloverMillis) {
nextRolloverMillis = ThreadLocalRandom.current().nextLong(0, 1 + maxRandomDelayMillis)
+ manager.getPatternProcessor().getNextTime(nowMillis, interval, modulate);
return true;
}
return false;
}
@Deprecated
public static TimeBasedTriggeringPolicy createPolicy(
@PluginAttribute("interval") final String interval,
@PluginAttribute("modulate") final String modulate) {
return newBuilder()
.withInterval(Integers.parseInt(interval, 1))
.withModulate(Boolean.parseBoolean(modulate))
.build();
}
@PluginBuilderFactory
public static TimeBasedTriggeringPolicy.Builder newBuilder() {
return new Builder();
}
@Override
public String toString() {
return "TimeBasedTriggeringPolicy(nextRolloverMillis=" + nextRolloverMillis + ", interval=" + interval
+ ", modulate=" + modulate + ")";
}
}