com.atlassian.bitbucket.audit

Interface AuditEntry

All Superinterfaces:

MinimalAuditEntry

Deprecated.

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

@Deprecated
public interface AuditEntry
extends MinimalAuditEntry

Legacy representation of an audited action.

AuditEntry has been replaced by AuditEvent in 7.0.

Instead of auditing an event with Audited, consumers are recommended to use the replacement Auditable. Using Audited means the supplied converter will only convert the event into an AuditEntry. The system will internally convert the generated AuditEntry to an AuditEvent via a best effort event agnostic conversion before processing the audited event, but this may result in some information loss. Using Auditable means the supplied converter will convert to an AuditEvent directly, giving the consumer more control.

An AuditEntry maps to an AuditEvent as follows:

• MinimalAuditEntry.getAction() has been replaced by AuditEvent.getActionI18nKey()
• MinimalAuditEntry.getTimestamp() will not be used anymore and system will assign current time to AuditEvent
• MinimalAuditEntry.getUser() will not be used anymore and system will assign current user in session to AuditEvent
• getProject() and getRepository()} have been replaced by AuditEvent.getAffectedObjects() (where projects and repositories are represented by an AuditResource)
• getSourceIpAddress() will not be used anymore and system will assign IP address from current HTTP session to AuditEvent
• MinimalAuditEntry.getDetails() and getTarget() have no direct replacement, but can be represented as extra attributes} (which is what the system will do internally when converting AuditEntrys to AuditEvents)

See Also:

AuditEntryBuilder, AuditEntryConverter, Audited

Method Summary

Modifier and Type	Method and Description
Project	getProject() Deprecated.
Repository	getRepository() Deprecated.
String	getSourceIpAddress() Deprecated.
String	getTarget() Deprecated. Details of the affected component (e.g.

Methods inherited from interface com.atlassian.bitbucket.audit.MinimalAuditEntry

getAction, getDetails, getTimestamp, getUser

Method Detail

getProject

@Nullable
Project getProject()

Deprecated.

getRepository

@Nullable
Repository getRepository()

Deprecated.

getSourceIpAddress

@Nullable
String getSourceIpAddress()

Deprecated.

getTarget

@Nullable
String getTarget()

Deprecated.

Details of the affected component (e.g. a plugin key or project slug).

This method was changed to Nullable in 7.0 to match implicit existing behaviour. Passing in a target value when creating an AuditEntry via AuditEntryBuilder has never been explicitly required. Consumers of getTarget() are advised to add null handling into their code.

Returns:

the target of the audit entry if present, otherwise null