Module io.helidon.security
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:

  • Field Details

    • SECURITY_TYPE_PREFIX

      static final String SECURITY_TYPE_PREFIX
      Reserved event type prefix for security component.
      See Also:

    • AUTHN_TYPE_PREFIX

      static final 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:

    • AUTHZ_TYPE_PREFIX

      static final 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:

    • OUTBOUND_TYPE_PREFIX

      static final 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:

    • AUDIT_TYPE_PREFIX

      static final String AUDIT_TYPE_PREFIX
      Reserved event type prefix for audit events. You may trigger such events ONLY when writing audit providers.
      See Also:

  • Method Details

    • eventType

      String eventType()
      Gets the type of this AuditEvent.
      Returns:
      the type of this AuditEvent represented as String.

    • throwable

      Optional<Throwable> throwable()
      Gets an Throwable object from which additional audit information can be obtained.
      Returns:
      an Throwable with additional information if available.

    • params

      List<AuditEvent.AuditParam> params()
      Parameters of this audit event, used in String.format(String, Object...) when creating the audit message.
      Returns:
      parameters of this audit message

    • messageFormat

      String messageFormat()
      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).

    • severity

      AuditEvent.AuditSeverity severity()
      Gets the severity of this AuditEvent.
      Returns:
      severity