com.atlassian.audit.entity

Class AuditEntity

java.lang.Object

com.atlassian.audit.entity.AuditEntity

public class AuditEntity
extends Object

Represents an Auditing Entity AKA as an Audit Event

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditEntity.Builder The builder class for AuditEntity

Method Summary

Modifier and Type	Method and Description
static AuditEntity.Builder	builder(AuditType type)
boolean	equals(Object o)
List<AuditResource>	getAffectedObjects()
AuditType	getAuditType()
AuditAuthor	getAuthor()
List<ChangedValue>	getChangedValues()
Optional<String>	getExtraAttribute(String name)
Optional<String>	getExtraAttributeByI18nKey(String i18nKey)
Collection<AuditAttribute>	getExtraAttributes()
Long	getId()
String	getMethod()
String	getNode()
String	getSource()
String	getSystem()
Instant	getTimestamp()
String	getVersion()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

@Nullable
public Long getId()

Returns:

Unique id of event. The id will be assigned by the backing storage and thus will only be returned when retrieving or searching stored AuditEntity objects

getVersion

@Nonnull
public String getVersion()

Returns:

version of event type.

getTimestamp

@Nonnull
public Instant getTimestamp()

Returns:

when the event occurs in millisecond precision.

getAuthor

@Nonnull
public AuditAuthor getAuthor()

Returns:

the author who initiated the event.

getAuditType

@Nonnull
public AuditType getAuditType()

Returns:

the scenario and category of the event, e.g. create issue.

getAffectedObjects

@Nonnull
public List<AuditResource> getAffectedObjects()

Returns:

the objects affected due to the event.

getChangedValues

@Nonnull
public List<ChangedValue> getChangedValues()

Returns:

the values changed due to the event.

getSource

@Nullable
public String getSource()

Returns:

the client's IP address that triggered this event.

getSystem

@Nullable
public String getSystem()

Returns:

the product instance where the event is generated, e.g. base url of Jira.

getNode

@Nullable
public String getNode()

Returns:

the node id where the event is generated, e.g. an node id in a Jira DC cluster.

getMethod

@Nullable
public String getMethod()

Returns:

how the event occurred, e.g. Browser or Mobile or System or Unknown

getExtraAttributes

@Nonnull
public Collection<AuditAttribute> getExtraAttributes()

Returns:

extra details of the events, not all events have such attributes.

getExtraAttribute

public Optional<String> getExtraAttribute(@Nonnull
                                          String name)

Parameters:

name - - the attribute name

Returns:

get a specific attribute value from the entity found by name.

getExtraAttributeByI18nKey

public Optional<String> getExtraAttributeByI18nKey(@Nonnull
                                                   String i18nKey)

Parameters:

i18nKey - - the attribute name i18n key

Returns:

get a specific attribute value from the entity found by i18nKey.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static AuditEntity.Builder builder(AuditType type)