Package com.atlassian.confluence.impl.audit

Interface AuditHelper

  • All Known Implementing Classes:
    DefaultAuditHelper
    public interface AuditHelper
    Contains helper methods to build auditing entities.
    Since:
    7.5.0

    • Method Detail

      • buildTextKey

        static String buildTextKey​(String key)
        Prepends AUDIT_I18N_PREFIX to the key, helping to build auditing keys following the same naming convention
        Parameters:
        key - message key
        Returns:
        AUDIT_I18N_PREFIX + key

      • buildSummaryTextKey

        static String buildSummaryTextKey​(String summaryKey)
        Prepends AUDIT_SUMMARY_PREFIX to the key, helping to build auditing keys for summaries following the same naming convention
        Parameters:
        summaryKey - summary key
        Returns:
        AUDIT_SUMMARY_PREFIX + key

      • buildChangedValueTextKey

        static String buildChangedValueTextKey​(String changedValueKey)
        Prepends AUDIT_CHANGED_VALUE_PREFIX to the key, helping to build auditing keys for changed values following the same naming convention
        Parameters:
        changedValueKey - changed value key
        Returns:
        AUDIT_CHANGED_VALUE_PREFIX + key

      • buildDescriptionTextKey

        static String buildDescriptionTextKey​(String descriptionKey)
        Prepends AUDIT_DESCRIPTION_PREFIX to the key, helping to build auditing keys for descriptions following the same naming convention
        Parameters:
        descriptionKey - description key
        Returns:
        AUDIT_DESCRIPTION_PREFIX + key

      • buildExtraAttribute

        static String buildExtraAttribute​(String extraAttributeKey)
        Prepends AUDIT_EXTRA_ATTRIBUTE_PREFIX to the key, helping to build auditing keys for extra attributes following the same naming convention
        Parameters:
        extraAttributeKey - extra attribute key
        Returns:
        AUDIT_EXTRA_ATTRIBUTE_PREFIX + key

      • translate

        String translate​(String key)
        Replaces given key with appropriate message.
        Parameters:
        key - message key
        Returns:
        message for current locale.

      • fetchSpaceId

        @Nullable String fetchSpaceId​(@Nullable String spaceKey)

      • fetchSpaceDisplayName

        @Nullable String fetchSpaceDisplayName​(@Nullable String spaceKey)

      • fetchUserKey

        @Nullable String fetchUserKey​(@Nullable com.atlassian.crowd.model.user.User user)

      • fetchUserFullName

        @Nullable String fetchUserFullName​(@Nullable com.atlassian.crowd.model.user.User user)

      • fetchUserKey

        @Nullable String fetchUserKey​(@Nullable String username)

      • fetchUserFullName

        @Nullable String fetchUserFullName​(@Nullable String username)