com.atlassian.bitbucket.event.annotation

Annotation Type Audited

Deprecated.

in 7.0 for removal in 8.0. Auditable should be used instead.

@Deprecated
 @Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Audited

Legacy annotation for events that should be audited by the system.

Annotated actions are audited by being added to the audit log, database and potentially other channels.

This annotation only affects types used as arguments in EventPublisher.publish(java.lang.Object). An example usage would be creating a domain event which extends ApplicationEvent for a specific action and annotating the event with Audited to audit the action.

Audited was replaced by Auditable in 7.0. Internally, an AuditEntry produced by an implementation of AuditEntryConverter supplied by this annotation is then subsequently converted to an AuditEvent (possibly with some information loss or default values being used due to slight differences between the audit representations) before being processed for auditing. Consumers are recommended to use Auditable with an AuditEventConverter to convert to an AuditEvent directly, instead of using Audited.

See Also:

AuditEntry, AuditEntryConverter

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends AuditEntryConverter>	converter Deprecated.
Priority	priority Deprecated.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	channels Deprecated.

Element Detail

converter

public abstract Class<? extends AuditEntryConverter> converter

Deprecated.

Returns:

a converter to extract the details of the event to be audited

priority

public abstract Priority priority

Deprecated.

Returns:

the priority of the event

channels

public abstract String[] channels

Deprecated.

Returns:

additional channels the audit details should be sent to in addition to the audit log.

Default:

{}