Package org.wildfly.security.audit

Class PeriodicRotatingFileAuditEndpoint

java.lang.Object

org.wildfly.security.audit.FileAuditEndpoint

org.wildfly.security.audit.PeriodicRotatingFileAuditEndpoint

All Implemented Interfaces:

Closeable, AutoCloseable, org.wildfly.common.function.ExceptionBiConsumer<EventPriority,String,IOException>, AuditEndpoint

public class PeriodicRotatingFileAuditEndpoint
extends FileAuditEndpoint

An audit endpoint which rotates the log at a preset time interval. Depending on set suffix, moves old log records into files tagged by timestamp.

Based on PeriodicSizeRotatingFileHandler.

Author:

Jan Kalina, James R. Perkins, Yeray Borges

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PeriodicRotatingFileAuditEndpoint.Builder	A builder for periodic rotating file audit endpoints.
(package private) static class	PeriodicRotatingFileAuditEndpoint.Period	Possible period values.

Field Summary

Fields

Modifier and Type	Field	Description
private DateTimeFormatter	format
private long	nextRollover
private String	nextSuffix
private PeriodicRotatingFileAuditEndpoint.Period	period
private ZoneId	timeZone

Fields inherited from class org.wildfly.security.audit.FileAuditEndpoint

clock

Constructor Summary

Constructors

Constructor	Description
PeriodicRotatingFileAuditEndpoint(PeriodicRotatingFileAuditEndpoint.Builder builder)

Method Summary

Modifier and Type	Method	Description
static PeriodicRotatingFileAuditEndpoint.Builder	builder()	Obtain a new PeriodicRotatingFileAuditEndpoint.Builder capable of building a PeriodicRotatingFileAuditEndpoint.
private void	calcNextRollover(long fromTime)	For given time and period obtains time when should be new log file started
private static <T extends Comparable<? super T>> T	min(T a, T b)
protected void	preWrite(Instant instant)	Checks whether time-based log rotation should be done and if so, it moves current log file into time-tagged file and exchange target file to continue logging into new, non-time-tagged file.

Methods inherited from class org.wildfly.security.audit.FileAuditEndpoint

accept, close, closeStreams, getFile, setFile, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wildfly.common.function.ExceptionBiConsumer

andThen, compose

Field Detail

format

private final DateTimeFormatter format

period

private final PeriodicRotatingFileAuditEndpoint.Period period

timeZone

private final ZoneId timeZone

nextRollover

private long nextRollover

nextSuffix

private String nextSuffix

Constructor Detail

PeriodicRotatingFileAuditEndpoint

PeriodicRotatingFileAuditEndpoint(PeriodicRotatingFileAuditEndpoint.Builder builder)
                           throws IOException

Throws:

IOException

Method Detail

preWrite

protected void preWrite(Instant instant)

Checks whether time-based log rotation should be done and if so, it moves current log file into time-tagged file and exchange target file to continue logging into new, non-time-tagged file.

Overrides:

preWrite in class FileAuditEndpoint

Parameters:

instant - time of the message acceptance

calcNextRollover

private void calcNextRollover(long fromTime)

For given time and period obtains time when should be new log file started

builder

public static PeriodicRotatingFileAuditEndpoint.Builder builder()

Obtain a new PeriodicRotatingFileAuditEndpoint.Builder capable of building a PeriodicRotatingFileAuditEndpoint.

Returns:

a new PeriodicRotatingFileAuditEndpoint.Builder capable of building a PeriodicRotatingFileAuditEndpoint.

min

private static <T extends Comparable<? super T>> T min(T a,
                                                       T b)