Package org.wildfly.security.audit

Class JsonSecurityEventFormatter

java.lang.Object

org.wildfly.security.auth.server.event.SecurityEventVisitor<Void,String>

org.wildfly.security.audit.JsonSecurityEventFormatter

public class JsonSecurityEventFormatter
extends SecurityEventVisitor<Void,String>

A formatter for security events that converts events into JSON strings.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSecurityEventFormatter.Builder	A builder for JSON security event formatter.

Field Summary

Fields

Modifier and Type	Field	Description
private Supplier<DateTimeFormatter>	dateTimeFormatterSupplier
private jakarta.json.spi.JsonProvider	jsonProvider

Constructor Summary

Constructors

Constructor	Description
JsonSecurityEventFormatter(JsonSecurityEventFormatter.Builder builder)

Method Summary

Modifier and Type	Method	Description
static JsonSecurityEventFormatter.Builder	builder()	Obtain a new JsonSecurityEventFormatter.Builder capable of building a JsonSecurityEventFormatter.
private void	handleAuthenticationFailedEvent(SecurityAuthenticationFailedEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handleAuthenticationFailedEvent(SecurityAuthenticationFailedEvent event, Void param)	Handle a security authentication failed event.
private void	handleDefiniteOutcomeEvent(SecurityDefiniteOutcomeEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handleDefiniteOutcomeEvent(SecurityDefiniteOutcomeEvent event, Void param)	Handle a security definite outcome event.
private void	handlePermissionCheckEvent(SecurityPermissionCheckEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handlePermissionCheckEvent(SecurityPermissionCheckEvent event, Void param)	Handle a security permission check event.
private void	handleRealmUnavailableEvent(SecurityRealmUnavailableEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handleRealmUnavailableEvent(SecurityRealmUnavailableEvent event, Void param)	Handle a security realm unavailable event.
private void	handleSyslogAuditEvent(SyslogAuditEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handleSyslogAuditEvent(SyslogAuditEvent event, Void param)	Handle an auditable event that is to be logged to syslog.
private void	handleUnknownEvent(SecurityEvent event, jakarta.json.JsonObjectBuilder objectBuilder)
String	handleUnknownEvent(SecurityEvent event, Void param)	Handle any unhandled security event.

Methods inherited from class org.wildfly.security.auth.server.event.SecurityEventVisitor

handleAuthenticationEvent, handleAuthenticationSuccessfulEvent, handlePermissionCheckFailedEvent, handlePermissionCheckSuccessfulEvent

Methods inherited from class java.lang.Object

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

Field Detail

dateTimeFormatterSupplier

private final Supplier<DateTimeFormatter> dateTimeFormatterSupplier

jsonProvider

private final jakarta.json.spi.JsonProvider jsonProvider

Constructor Detail

JsonSecurityEventFormatter

JsonSecurityEventFormatter(JsonSecurityEventFormatter.Builder builder)

Method Detail

handleUnknownEvent

public String handleUnknownEvent(SecurityEvent event,
                                 Void param)

Description copied from class: SecurityEventVisitor

Handle any unhandled security event.

Overrides:

handleUnknownEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handleUnknownEvent

private void handleUnknownEvent(SecurityEvent event,
                                jakarta.json.JsonObjectBuilder objectBuilder)

handleDefiniteOutcomeEvent

public String handleDefiniteOutcomeEvent(SecurityDefiniteOutcomeEvent event,
                                         Void param)

Description copied from class: SecurityEventVisitor

Handle a security definite outcome event.

Overrides:

handleDefiniteOutcomeEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handleDefiniteOutcomeEvent

private void handleDefiniteOutcomeEvent(SecurityDefiniteOutcomeEvent event,
                                        jakarta.json.JsonObjectBuilder objectBuilder)

handleAuthenticationFailedEvent

public String handleAuthenticationFailedEvent(SecurityAuthenticationFailedEvent event,
                                              Void param)

Description copied from class: SecurityEventVisitor

Handle a security authentication failed event.

Overrides:

handleAuthenticationFailedEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handleAuthenticationFailedEvent

private void handleAuthenticationFailedEvent(SecurityAuthenticationFailedEvent event,
                                             jakarta.json.JsonObjectBuilder objectBuilder)

handlePermissionCheckEvent

public String handlePermissionCheckEvent(SecurityPermissionCheckEvent event,
                                         Void param)

Description copied from class: SecurityEventVisitor

Handle a security permission check event.

Overrides:

handlePermissionCheckEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handlePermissionCheckEvent

private void handlePermissionCheckEvent(SecurityPermissionCheckEvent event,
                                        jakarta.json.JsonObjectBuilder objectBuilder)

handleSyslogAuditEvent

public String handleSyslogAuditEvent(SyslogAuditEvent event,
                                     Void param)

Description copied from class: SecurityEventVisitor

Handle an auditable event that is to be logged to syslog.

Overrides:

handleSyslogAuditEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handleSyslogAuditEvent

private void handleSyslogAuditEvent(SyslogAuditEvent event,
                                    jakarta.json.JsonObjectBuilder objectBuilder)

handleRealmUnavailableEvent

public String handleRealmUnavailableEvent(SecurityRealmUnavailableEvent event,
                                          Void param)

Description copied from class: SecurityEventVisitor

Handle a security realm unavailable event.

Overrides:

handleRealmUnavailableEvent in class SecurityEventVisitor<Void,String>

Parameters:

event - the security event

param - the visitor parameter

Returns:

the visitor return value

handleRealmUnavailableEvent

private void handleRealmUnavailableEvent(SecurityRealmUnavailableEvent event,
                                         jakarta.json.JsonObjectBuilder objectBuilder)

builder

public static JsonSecurityEventFormatter.Builder builder()

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

Returns:

a new JsonSecurityEventFormatter.Builder capable of building a JsonSecurityEventFormatter