com.atlassian.audit.entity

Class AuditEvent

java.lang.Object

com.atlassian.audit.entity.AuditEvent

public class AuditEvent
extends Object

Represents domain specific information of audit entity. Other fields of AuditEntity will be determined automatically by the system.

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditEvent.Builder The Builder class for AuditEvent

Method Summary

Modifier and Type	Method and Description
static AuditEvent.Builder	builder(AuditType type)
static AuditEvent.Builder	builder(String action, String category, CoverageLevel level) Deprecated. since 1.7.0, use a variant with i18n keys fromI18nKeys(String, String, CoverageLevel) or fromI18nKeys(String, String, CoverageLevel, CoverageArea)
boolean	equals(Object o)
static AuditEvent.Builder	fromI18nKeys(String categoryI18nKey, String actionI18nKey, CoverageLevel level)
static AuditEvent.Builder	fromI18nKeys(String categoryI18nKey, String actionI18nKey, CoverageLevel level, CoverageArea area)
String	getAction() Deprecated. since 1.7.0, see getActionI18nKey()
String	getActionI18nKey()
List<AuditResource>	getAffectedObjects()
CoverageArea	getArea()
String	getCategory() Deprecated. since 1.7.0, see getCategoryI18nKey()
String	getCategoryI18nKey()
List<ChangedValue>	getChangedValues()
Optional<String>	getExtraAttribute(String name)
Optional<String>	getExtraAttributeByKey(String nameKey)
Collection<AuditAttribute>	getExtraAttributes()
CoverageLevel	getLevel()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getActionI18nKey

@Nonnull
public String getActionI18nKey()

Returns:

the i18n key of scenario of the event, e.g. audit.product.action.projects.create.

Since:

1.7.0

getAction

@Nullable
 @Deprecated
public String getAction()

Deprecated. since 1.7.0, see getActionI18nKey()

Returns:

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

getCategoryI18nKey

@Nonnull
public String getCategoryI18nKey()

Returns:

the Category i18n key.

Since:

1.7.0 Example - for category "Pull Requests" we return "audit.product.category.pr"

getCategory

@Nullable
 @Deprecated
public String getCategory()

Deprecated. since 1.7.0, see getCategoryI18nKey()

Returns:

the category of the event eg "Pull Requests"

getArea

@Nullable
public CoverageArea getArea()

getLevel

@Nonnull
public CoverageLevel getLevel()

Returns:

estimated verbosity of the event

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.

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)

Returns:

get a specific attribute from the entity.

getExtraAttributeByKey

public Optional<String> getExtraAttributeByKey(@Nonnull
                                               String nameKey)

Returns:

get a specific attribute from the entity via nameKey.

Since:

1.7.0

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

@Deprecated
public static AuditEvent.Builder builder(@Nonnull
                                                     String action,
                                                     @Nonnull
                                                     String category,
                                                     @Nonnull
                                                     CoverageLevel level)

Deprecated. since 1.7.0, use a variant with i18n keys fromI18nKeys(String, String, CoverageLevel) or fromI18nKeys(String, String, CoverageLevel, CoverageArea)

fromI18nKeys

public static AuditEvent.Builder fromI18nKeys(@Nonnull
                                              String categoryI18nKey,
                                              @Nonnull
                                              String actionI18nKey,
                                              @Nonnull
                                              CoverageLevel level,
                                              @Nullable
                                              CoverageArea area)

Since:

1.7.0

fromI18nKeys

public static AuditEvent.Builder fromI18nKeys(@Nonnull
                                              String categoryI18nKey,
                                              @Nonnull
                                              String actionI18nKey,
                                              @Nonnull
                                              CoverageLevel level)

Since:

1.7.0

builder

public static AuditEvent.Builder builder(@Nonnull
                                         AuditType type)