com.atlassian.jira.auditing

Class AuditEntitiesUtils

java.lang.Object

com.atlassian.jira.auditing.AuditEntitiesUtils

public class AuditEntitiesUtils
extends Object

Utility class for the Auditing feature. Current purpose is to have a single source of truth for creating audit plugin entities.

Since:

v8.9.0

Method Summary

Modifier and Type	Method and Description
static Optional<String>	getExtraAttributeByI18nKeyOrName(com.atlassian.audit.entity.AuditEntity auditEntity, String i18nKey, String name) Returns extra attribute value of the audit entity.
static com.atlassian.audit.entity.AuditAttribute	newAuditAttribute(String nameI18nKey, String value) Creates a new instance of AuditAttribute using the passed parameters.
static List<com.atlassian.audit.entity.AuditAttribute>	newAuditAttributes(Map<String,String> attributes) Creates a new list of AuditAttributes using the passed attribute map.
static com.atlassian.audit.entity.AuditResource	newAuditResource(String name, String type, String id) Creates a new instace of AuditResource using the passed parameters
static com.atlassian.audit.entity.AuditType	newAuditType(com.atlassian.audit.entity.CoverageArea area, AuditingCategory category, String actionI18nKey, com.atlassian.audit.entity.CoverageLevel level) Deprecated. since v8.12.2 Instead use newAuditType(CoverageArea, String, String, CoverageLevel).
static com.atlassian.audit.entity.AuditType	newAuditType(com.atlassian.audit.entity.CoverageArea area, String categoryI18nKey, String actionI18nKey, com.atlassian.audit.entity.CoverageLevel level) Creates a new AuditType instance using the passed parameters.
static com.atlassian.audit.entity.AuditType	newAuditTypeWithTranslations(com.atlassian.audit.entity.CoverageArea area, String categoryI18nKey, String actionI18nKey, com.atlassian.audit.entity.CoverageLevel level, String categoryTranslation, String actionTranslation) Creates a new AuditType instance using the passed parameters.
static com.atlassian.audit.entity.ChangedValue	newChangedValue(String i18nKey, String to) Creates a new instance of ChangedValue using the passed parameters.
static com.atlassian.audit.entity.ChangedValue	newChangedValue(String i18nKey, String from, String to) Creates a new instance of ChangedValue using the passed parameters.
static com.atlassian.audit.entity.ChangedValue	newChangedValueWithTranslation(String i18nKey, String from, String to, String keyTranslation) Creates a new instance of ChangedValue using the passed parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newAuditTypeWithTranslations

public static com.atlassian.audit.entity.AuditType newAuditTypeWithTranslations(@Nonnull
                                                                                com.atlassian.audit.entity.CoverageArea area,
                                                                                @Nonnull
                                                                                String categoryI18nKey,
                                                                                @Nonnull
                                                                                String actionI18nKey,
                                                                                @Nonnull
                                                                                com.atlassian.audit.entity.CoverageLevel level,
                                                                                @Nullable
                                                                                String categoryTranslation,
                                                                                @Nullable
                                                                                String actionTranslation)

Creates a new AuditType instance using the passed parameters.
Required at the moment by the AuditEntityConverter to perform migration of the old audit logs to the new system in case the category or action I18n Keys are empty. Avoid in favor of newAuditType(CoverageArea, String, String, CoverageLevel).

Parameters:

area - coverage area

categoryI18nKey - auditing category i18n key

actionI18nKey - action i18n key

level - coverage level

categoryTranslation - the translation for the category key

actionTranslation - the translation for the action key

Returns:

a new instance of AuditType

newAuditType

@Deprecated
public static com.atlassian.audit.entity.AuditType newAuditType(@Nonnull
                                                                            com.atlassian.audit.entity.CoverageArea area,
                                                                            @Nonnull
                                                                            AuditingCategory category,
                                                                            @Nonnull
                                                                            String actionI18nKey,
                                                                            @Nonnull
                                                                            com.atlassian.audit.entity.CoverageLevel level)

Deprecated. since v8.12.2
Instead use newAuditType(CoverageArea, String, String, CoverageLevel).

Creates a new AuditType instance using the passed parameters.

Parameters:

area - coverage area

category - auditing category

actionI18nKey - action i18n key

level - coverage level

Returns:

a new instance of AuditType

newAuditType

public static com.atlassian.audit.entity.AuditType newAuditType(@Nonnull
                                                                com.atlassian.audit.entity.CoverageArea area,
                                                                @Nonnull
                                                                String categoryI18nKey,
                                                                @Nonnull
                                                                String actionI18nKey,
                                                                @Nonnull
                                                                com.atlassian.audit.entity.CoverageLevel level)

Creates a new AuditType instance using the passed parameters.

Parameters:

area - coverage area

categoryI18nKey - auditing category i18n key. It is recommended to use categories from AuditCategory.

actionI18nKey - action i18n key

level - coverage level

Returns:

a new instance of AuditType

newAuditAttribute

public static com.atlassian.audit.entity.AuditAttribute newAuditAttribute(@Nonnull
                                                                          String nameI18nKey,
                                                                          @Nullable
                                                                          String value)

Creates a new instance of AuditAttribute using the passed parameters.

Parameters:

nameI18nKey - attribute i18n key name

value - attribute value

Returns:

a new instance of AuditAttribute

newAuditAttributes

public static List<com.atlassian.audit.entity.AuditAttribute> newAuditAttributes(@Nonnull
                                                                                 Map<String,String> attributes)

Creates a new list of AuditAttributes using the passed attribute map.

Parameters:

attributes - map containing attributes with i18n key name as a key and attribute value as a value

Returns:

a new list of AuditAttributes

newChangedValue

public static com.atlassian.audit.entity.ChangedValue newChangedValue(@Nonnull
                                                                      String i18nKey,
                                                                      @Nullable
                                                                      String to)

Creates a new instance of ChangedValue using the passed parameters.

Parameters:

i18nKey - changed value i18n key

to - changed value to

Returns:

a new instance of ChangedValue

newChangedValue

public static com.atlassian.audit.entity.ChangedValue newChangedValue(@Nonnull
                                                                      String i18nKey,
                                                                      @Nullable
                                                                      String from,
                                                                      @Nullable
                                                                      String to)

Creates a new instance of ChangedValue using the passed parameters.

Parameters:

i18nKey - changed value i18n key

from - changed value from

to - changed value to

Returns:

a new instance of ChangedValue

newChangedValueWithTranslation

public static com.atlassian.audit.entity.ChangedValue newChangedValueWithTranslation(@Nonnull
                                                                                     String i18nKey,
                                                                                     @Nullable
                                                                                     String from,
                                                                                     @Nullable
                                                                                     String to,
                                                                                     @Nullable
                                                                                     String keyTranslation)

Creates a new instance of ChangedValue using the passed parameters.

Parameters:

i18nKey - changed value i18n key

from - changed value from

to - changed value to

keyTranslation - translation for the key

Returns:

a new instance of ChangedValue

newAuditResource

public static com.atlassian.audit.entity.AuditResource newAuditResource(@Nonnull
                                                                        String name,
                                                                        @Nonnull
                                                                        String type,
                                                                        @Nonnull
                                                                        String id)

Creates a new instace of AuditResource using the passed parameters

Parameters:

name - the unique name of the resource

type - of the resource see AssociatedItem.Type

id - of the resource

Returns:

a new instance of AuditResource

getExtraAttributeByI18nKeyOrName

public static Optional<String> getExtraAttributeByI18nKeyOrName(@Nonnull
                                                                com.atlassian.audit.entity.AuditEntity auditEntity,
                                                                @Nonnull
                                                                String i18nKey,
                                                                @Nonnull
                                                                String name)

Returns extra attribute value of the audit entity. First it tries to fetch by i18n key, otherwise name is used.

Parameters:

auditEntity - entity containing extra attributes

i18nKey - the i18n key of the audit entity extra attribute

name - the name of the audit entity extra attribute

Returns:

value of the extra attribute if found