Package org.wildfly.security.audit

Class FileAuditEndpoint

java.lang.Object

org.wildfly.security.audit.FileAuditEndpoint

All Implemented Interfaces:

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

Direct Known Subclasses:

PeriodicRotatingFileAuditEndpoint, SizeRotatingFileAuditEndpoint

public class FileAuditEndpoint
extends Object
implements AuditEndpoint

An audit endpoint to record all audit events to a local file.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileAuditEndpoint.Builder	A builder for file audit endpoints.

Field Summary

Fields

Modifier and Type	Field	Description
protected Clock	clock	Clock providing access to current time.

Method Summary

Modifier and Type	Method	Description
void	accept(EventPriority priority, String message)	Accept formatted security event message to be processed written into target local file.
static FileAuditEndpoint.Builder	builder()	Obtain a new FileAuditEndpoint.Builder capable of building a FileAuditEndpoint.
void	close()	Close the endpoint and stop handling further events immediately.

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

clock

protected final Clock clock

Clock providing access to current time.

Method Detail

accept

public void accept(EventPriority priority,
                   String message)
            throws IOException

Accept formatted security event message to be processed written into target local file.

Specified by:

accept in interface org.wildfly.common.function.ExceptionBiConsumer<EventPriority,String,IOException>

Parameters:

priority - priority of the logged message

message - the logged message

Throws:

IOException - when writing into the target local file fails

close

public void close()
           throws IOException

Description copied from interface: AuditEndpoint

Close the endpoint and stop handling further events immediately.

Specified by:

close in interface AuditEndpoint

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an error occurs closing the endpoint.

builder

public static FileAuditEndpoint.Builder builder()

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

Returns:

a new FileAuditEndpoint.Builder capable of building a FileAuditEndpoint.