org.springframework.boot.actuate.audit

Class AuditEvent

java.lang.Object

org.springframework.boot.actuate.audit.AuditEvent

All Implemented Interfaces:

java.io.Serializable

public class AuditEvent
extends java.lang.Object
implements java.io.Serializable

A value object representing an audit event: at a particular time, a particular user or agent carried out an action of a particular type. This object records the details of such an event.

Users can inject a AuditEventRepository to publish their own events or alternatively use Spring's ApplicationEventPublisher (usually obtained by implementing ApplicationEventPublisherAware) to publish AuditApplicationEvents (wrappers for AuditEvent).

Since:

1.0.0

See Also:

AuditEventRepository, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuditEvent(java.time.Instant timestamp, java.lang.String principal, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> data) Create a new audit event.
AuditEvent(java.lang.String principal, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> data) Create a new audit event for the current time.
AuditEvent(java.lang.String principal, java.lang.String type, java.lang.String... data) Create a new audit event for the current time from data provided as name-value pairs.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getData() Returns the event data.
java.lang.String	getPrincipal() Returns the user principal responsible for the event or an empty String if the principal is not available.
java.time.Instant	getTimestamp() Returns the date/time that the event was logged.
java.lang.String	getType() Returns the type of event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditEvent

public AuditEvent(java.lang.String principal,
                  java.lang.String type,
                  java.util.Map<java.lang.String,java.lang.Object> data)

Create a new audit event for the current time.

Parameters:

principal - the user principal responsible

type - the event type

data - the event data

AuditEvent

public AuditEvent(java.lang.String principal,
                  java.lang.String type,
                  java.lang.String... data)

Create a new audit event for the current time from data provided as name-value pairs.

Parameters:

principal - the user principal responsible

type - the event type

data - the event data in the form 'key=value' or simply 'key'

AuditEvent

public AuditEvent(java.time.Instant timestamp,
                  java.lang.String principal,
                  java.lang.String type,
                  java.util.Map<java.lang.String,java.lang.Object> data)

Create a new audit event.

Parameters:

timestamp - the date/time of the event

principal - the user principal responsible

type - the event type

data - the event data

Method Detail

getTimestamp

public java.time.Instant getTimestamp()

Returns the date/time that the event was logged.

Returns:

the timestamp

getPrincipal

public java.lang.String getPrincipal()

Returns the user principal responsible for the event or an empty String if the principal is not available.

Returns:

the principal

getType

public java.lang.String getType()

Returns the type of event.

Returns:

the event type

getData

public java.util.Map<java.lang.String,java.lang.Object> getData()

Returns the event data.

Returns:

the event data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object