com.atlassian.bitbucket.audit

Interface AuditEntryConverter<T>

Type Parameters:

T - the type of the original event

Deprecated.

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

@Deprecated
public interface AuditEntryConverter<T>

Converts an Audited event into an AuditEntry (a legacy representation suitable for auditing).

The supplied AuditEntryBuilder from convert(Object, AuditEntryBuilder) will have the source IP address already set.

Implementations must have a nullary (no argument) constructor and are intended to be lightweight, stateless classes. Converters are instantiated for each event and discarded after the event has been converted.

AuditEntryConverter has been replaced by AuditEventConverter in 7.0. Internally, an AuditEntry produced by an implementation of this converter 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 with an AuditEntryConverter.

See Also:

AuditEntry, AuditEntryBuilder, Audited

Method Summary

Modifier and Type	Method and Description
AuditEntry	convert(T event, AuditEntryBuilder builder) Deprecated. Converts an Audited event into an AuditEntry.

Method Detail

convert

@Nonnull
AuditEntry convert(@Nonnull
                            T event,
                            AuditEntryBuilder builder)

Deprecated.

Converts an Audited event into an AuditEntry.

Parameters:

builder - an audit entry builder which has the source IP address set by the caller

event - the original annotated event

Returns:

the details of the original event in the standard audit format