Package io.helidon.security

Interface AuditEvent

All Known Subinterfaces:

AuditProvider.TracedAuditEvent

public interface AuditEvent

An audit event to store using an Audit provider. You should provide your own implementation class.

See Also:

SecurityContext.audit(AuditEvent), AuditProvider

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventType() Gets the type of this AuditEvent.
java.lang.String	getMessageFormat() Gets the message format of this AuditEvent to be used with String.format(String, Object...).
java.util.List<AuditEvent.AuditParam>	getParams() Parameters of this audit event, used in String.format(String, Object...) when creating the audit message.
AuditEvent.AuditSeverity	getSeverity() Gets the severity of this AuditEvent.
java.util.Optional<java.lang.Throwable>	getThrowable() Gets an Throwable object from which additional audit information can be obtained.

Field Detail

SECURITY_TYPE_PREFIX

static final java.lang.String SECURITY_TYPE_PREFIX

Reserved event type prefix for security component.

See Also:

Constant Field Values

AUTHN_TYPE_PREFIX

static final java.lang.String AUTHN_TYPE_PREFIX

Reserved event type prefix for authentication events. You may trigger such audit events (e.g. when writing an authentication provider, or from app), yet they MUST be related to authentication.

See Also:

Constant Field Values

AUTHZ_TYPE_PREFIX

static final java.lang.String AUTHZ_TYPE_PREFIX

Reserved event type prefix for authorization events. You may trigger such audit events (e.g. when writing an authorization provider, or from app), yet they MUST be related to authorization.

See Also:

Constant Field Values

OUTBOUND_TYPE_PREFIX

static final java.lang.String OUTBOUND_TYPE_PREFIX

Reserved event type prefix for outbound security (such as identity propagation) events. You may trigger such audit events (e.g. when writing an identity propagation provider, or from app), yet they MUST be related to identity propagation.

See Also:

Constant Field Values

AUDIT_TYPE_PREFIX

static final java.lang.String AUDIT_TYPE_PREFIX

Reserved event type prefix for audit events. You may trigger such events ONLY when writing audit providers.

See Also:

Constant Field Values

Method Detail

getEventType

java.lang.String getEventType()

Gets the type of this AuditEvent.

Returns:

the type of this AuditEvent represented as String.

getThrowable

java.util.Optional<java.lang.Throwable> getThrowable()

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

Returns:

an Throwable with additional information if available.

getParams

java.util.List<AuditEvent.AuditParam> getParams()

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

Returns:

parameters of this audit message

getMessageFormat

java.lang.String getMessageFormat()

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

Returns:

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

getSeverity

AuditEvent.AuditSeverity getSeverity()

Gets the severity of this AuditEvent.

Returns:

severity