Package org.wildfly.security.audit

Audit logging related resources. Audit logging registers with the SecurityDomain by registering a Consumer to receive the emitted SecurityEvents. The audit logging framework is comprised of three core components.

1. Priority Mapper (Function<SecurityEvent, EventPriority>)
2. Event Formatter (Function<SecurityEvent, String>)
3. Audit Endpoint (ExceptionBiConsumer<EventPriority, String, IOException>)

The priority mapper takes an incoming security event and maps it to one of nine priority levels including a level 'OFF' to cause the event to be immediately discarded. The event formatter takes a security event and converts it to a formatted String ready to be recorded. The audit endpoint is the final component and takes the resulting priority and formatted String to be logged according to the endpoint's configuration.

Author:

Darran Lofthouse

Interface Summary

Interface	Description
AuditEndpoint	An endpoint that receives audit messages.
ElytronMessages	Log messages and exceptions for Elytron.

Class Summary

Class	Description
AuditLogger	The audit logger implementation.
AuditLogger.Builder	A builder for audit logger instances.
FileAuditEndpoint	An audit endpoint to record all audit events to a local file.
FileAuditEndpoint.Builder	A builder for file audit endpoints.
JsonSecurityEventFormatter	A formatter for security events that converts events into JSON strings.
JsonSecurityEventFormatter.Builder	A builder for JSON security event formatter.
PeriodicRotatingFileAuditEndpoint	An audit endpoint which rotates the log at a preset time interval.
PeriodicRotatingFileAuditEndpoint.Builder	A builder for periodic rotating file audit endpoints.
SimpleSecurityEventFormatter	A formatter for security events that converts events into human-readable strings.
SimpleSecurityEventFormatter.Builder	A builder for simple security event formatter.
SizeRotatingFileAuditEndpoint	An audit endpoint which rotates the log when log file size reach given value.
SizeRotatingFileAuditEndpoint.Builder	A builder for size rotating file audit endpoints.
SyslogAuditEndpoint	An audit endpoint that logs to syslog server.
SyslogAuditEndpoint.Builder	A builder for syslog audit endpoint.

Enum Summary

Enum	Description
EventPriority	The priority level of an audit event.
PeriodicRotatingFileAuditEndpoint.Period	Possible period values.