Package org.wildfly.security.audit

Class SimpleSecurityEventFormatter

java.lang.Object

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

org.wildfly.security.audit.SimpleSecurityEventFormatter

public class SimpleSecurityEventFormatter
extends SecurityEventVisitor<Void,String>

A formatter for security events that converts events into human-readable strings.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleSecurityEventFormatter.Builder	A builder for simple security event formatter.

Method Summary

Modifier and Type	Method	Description
static SimpleSecurityEventFormatter.Builder	builder()	Create a new builder.
String	handleAuthenticationFailedEvent(SecurityAuthenticationFailedEvent event, Void param)	Handle a security authentication failed event.
String	handleDefiniteOutcomeEvent(SecurityDefiniteOutcomeEvent event, Void param)	Handle a security definite outcome event.
String	handlePermissionCheckEvent(SecurityPermissionCheckEvent event, Void param)	Handle a security permission check event.
String	handleRealmUnavailableEvent(SecurityRealmUnavailableEvent event, Void param)	Handle a security realm unavailable event.
String	handleSyslogAuditEvent(SyslogAuditEvent event, Void param)	Handle an auditable event that is to be logged to syslog.
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

Method Details

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

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

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

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

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

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

builder

public static SimpleSecurityEventFormatter.Builder builder()

Create a new builder.

Returns:

a new builder