Interface AuditProvider.TracedAuditEvent

All Superinterfaces:

AuditEvent

Enclosing interface:

AuditProvider

public static interface AuditProvider.TracedAuditEvent
extends AuditEvent

Audit event sent to Audit provider. Wraps tracing id and AuditEvent sent by a component/user.

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
AuditProvider.AuditSource	auditSource()	Source of this audit event (class, method, line number etc.).
default String	formatMessage()	Creates a formatted message from this events message format and parameters.
String	tracingId()	Tracing id of the current audit event, generated by SecurityContext.

Methods inherited from interface AuditEvent

eventType, messageFormat, params, severity, throwable

Modifier and Type	Method	Description
String	eventType()	Gets the type of this AuditEvent.
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.
Optional<Throwable>	throwable()	Gets an Throwable object from which additional audit information can be obtained.

Method Details

tracingId

String tracingId()

Tracing id of the current audit event, generated by SecurityContext.

Returns:

String with tracing id

auditSource

AuditProvider.AuditSource auditSource()

Source of this audit event (class, method, line number etc.).

Returns:

Source of the audit event

formatMessage

default String formatMessage()

Creates a formatted message from this events message format and parameters.

Returns:

formatted message