com.atlassian.bitbucket.event.audit

Class AuditEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.audit.AuditEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TransactionAwareAuditEvent

Deprecated.

the system internally publishing AuditEvent for consumers to listen to will be removed in 7.0. A replacement API for consuming auditable actions will be available in 7.0.

@AsynchronousPreferred
 @Deprecated
public class AuditEvent
extends ApplicationEvent

Represents an AuditEvent derived from an Audited annotated event or an internal auditable action.

This class can be used in two different ways. The primary (intended) use case is for consuming all auditable actions, thus offering a consumer API for these actions. The system publishes this event internally for every auditable action, and a listener can be created to listen to AuditEvent and process it (e.g. add it to a file log, persist it in the database, etc.).

The secondary use case is a low level API for providing auditable actions to the system, thus offering a provider API for these actions. An AuditEvent can be published directly to add an auditable action, instead of using the Audited annotation and an AuditEntryConverter. However this is not the preferred method of providing an auditable action (as it skips over system processing applied to every Audited event as it is transformed into an AuditEvent), and as such it is only recommended to be used if Audited is not suitable in a particular situation.

The AuditEvent class will be retained until 8.0 to continue supporting provider API for auditable actions. However, the consumer API would be removed in 7.0, i.e., the system would stop publishing AuditEvents and so, listeners of this event would no longer receive it and be notified of auditable actions.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AuditEvent(Object source, AuditEntry entry, Set<String> channels, Priority priority) Deprecated.

Method Summary

Modifier and Type	Method and Description
Set<String>	getChannels() Deprecated.
AuditEntry	getEntry() Deprecated.
Priority	getPriority() Deprecated.

Methods inherited from class com.atlassian.bitbucket.event.ApplicationEvent

getDate, getUser

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditEvent

public AuditEvent(@Nonnull
                  Object source,
                  @Nonnull
                  AuditEntry entry,
                  @Nonnull
                  Set<String> channels,
                  Priority priority)

Deprecated.

Method Detail

getEntry

@Nonnull
public AuditEntry getEntry()

Deprecated.

Returns:

the details of the original event in a standard audit format

getChannels

@Nonnull
public Set<String> getChannels()

Deprecated.

Returns:

the channels which the original annotated event indicated would be interested in auditing the original event

getPriority

@Nonnull
public Priority getPriority()

Deprecated.

Returns:

the priority of the event