Class SecurityAuditEvent

java.lang.Object

io.helidon.security.internal.SecurityAuditEvent

All Implemented Interfaces:

AuditEvent

public final class SecurityAuditEvent
extends Object
implements AuditEvent

A default implementation of AuditEvent, used by security itself.

Nested Class Summary

Nested classes/interfaces inherited from interface AuditEvent

AuditEvent.AuditParam, AuditEvent.AuditSeverity

Modifier and Type	Interface	Description
static final class	AuditEvent.AuditParam	Named parameters of audit event.
static enum	AuditEvent.AuditSeverity	Severity of AuditEvent.

Field Summary

Fields inherited from interface AuditEvent

AUDIT_TYPE_PREFIX, AUTHN_TYPE_PREFIX, AUTHZ_TYPE_PREFIX, OUTBOUND_TYPE_PREFIX, SECURITY_TYPE_PREFIX

Modifier and Type	Field	Description
static final String	AUDIT_TYPE_PREFIX	Reserved event type prefix for audit events.
static final String	AUTHN_TYPE_PREFIX	Reserved event type prefix for authentication events.
static final String	AUTHZ_TYPE_PREFIX	Reserved event type prefix for authorization events.
static final String	OUTBOUND_TYPE_PREFIX	Reserved event type prefix for outbound security (such as identity propagation) events.
static final String	SECURITY_TYPE_PREFIX	Reserved event type prefix for security component.

Method Summary

Modifier and Type	Method	Description
SecurityAuditEvent	addParam(AuditEvent.AuditParam param)	Add a parameter to this event.
static SecurityAuditEvent	audit(AuditEvent.AuditSeverity severity, String eventType, String messageFormat)	Create a new audit event.
static SecurityAuditEvent	auditFailure(String eventType, String messageFormat)	Factory method to create a security audit event.
static SecurityAuditEvent	auditFailure(String eventType, String messageFormat, Throwable e)	Factory method to create a security audit event.
static SecurityAuditEvent	error(String eventType, String messageFormat)	Factory method to create a security audit event.
static SecurityAuditEvent	error(String eventType, String messageFormat, Throwable e)	Factory method to create a security audit event.
String	eventType()	Gets the type of this AuditEvent.
static SecurityAuditEvent	failure(String eventType, String messageFormat)	Factory method to create a security audit event.
static SecurityAuditEvent	failure(String eventType, String messageFormat, Throwable e)	Factory method to create a security audit event.
static SecurityAuditEvent	info(String eventType, String messageFormat)	Factory method to create a security audit event.
String	messageFormat()	Gets the message format of this AuditEvent to be used with String.format(String, Object...).
List<AuditEvent.AuditParam>	params()	Parameters of this audit event, used in String.format(String, Object...) when creating the audit message.
AuditEvent.AuditSeverity	severity()	Gets the severity of this AuditEvent.
static SecurityAuditEvent	success(String eventType, String messageFormat)	Factory method to create a security audit event.
Optional<Throwable>	throwable()	Gets an Throwable object from which additional audit information can be obtained.
String	toString()
static SecurityAuditEvent	warn(String eventType, String messageFormat)	Factory method to create a security audit event.
static SecurityAuditEvent	warn(String eventType, String messageFormat, Throwable e)	Factory method to create a security audit event.

Methods inherited from class Object

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

Method Details

info

public static SecurityAuditEvent info(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

success

public static SecurityAuditEvent success(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

warn

public static SecurityAuditEvent warn(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

warn

public static SecurityAuditEvent warn(String eventType,
 String messageFormat,
 Throwable e)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

e - Throwable to be audited

Returns:

event instance

error

public static SecurityAuditEvent error(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

error

public static SecurityAuditEvent error(String eventType,
 String messageFormat,
 Throwable e)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

e - Throwable to be audited

Returns:

event instance

failure

public static SecurityAuditEvent failure(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

failure

public static SecurityAuditEvent failure(String eventType,
 String messageFormat,
 Throwable e)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

e - Throwable to be audited

Returns:

event instance

auditFailure

public static SecurityAuditEvent auditFailure(String eventType,
 String messageFormat)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

Returns:

event instance

auditFailure

public static SecurityAuditEvent auditFailure(String eventType,
 String messageFormat,
 Throwable e)

Factory method to create a security audit event.

Parameters:

eventType - Type of event

messageFormat - Format of event message

e - Throwable to be audited

Returns:

event instance

audit

public static SecurityAuditEvent audit(AuditEvent.AuditSeverity severity,
 String eventType,
 String messageFormat)

Create a new audit event.

Parameters:

severity - Severity of this event

eventType - Event type

messageFormat - Message format to print this event out (default - may be overridden by AuditProvider)

Returns:

event instance

addParam

public SecurityAuditEvent addParam(AuditEvent.AuditParam param)

Add a parameter to this event.

Parameters:

param - parameter to add, e.g. using AuditEvent.AuditParam.plain(String, Object)

Returns:

updated instance

eventType

public String eventType()

Description copied from interface: AuditEvent

Gets the type of this AuditEvent.

Specified by:

eventType in interface AuditEvent

Returns:

the type of this AuditEvent represented as String.

throwable

public Optional<Throwable> throwable()

Description copied from interface: AuditEvent

Gets an Throwable object from which additional audit information can be obtained.

Specified by:

throwable in interface AuditEvent

Returns:

an Throwable with additional information if available.

params

public List<AuditEvent.AuditParam> params()

Description copied from interface: AuditEvent

Parameters of this audit event, used in String.format(String, Object...) when creating the audit message.

Specified by:

params in interface AuditEvent

Returns:

parameters of this audit message

messageFormat

public String messageFormat()

Description copied from interface: AuditEvent

Gets the message format of this AuditEvent to be used with String.format(String, Object...).

Specified by:

messageFormat in interface AuditEvent

Returns:

English message format (this is a fallback if internationalization is not configured).

severity

public AuditEvent.AuditSeverity severity()

Description copied from interface: AuditEvent

Gets the severity of this AuditEvent.

Specified by:

severity in interface AuditEvent

Returns:

severity

toString

public String toString()

Overrides:

toString in class Object