Package com.atlassian.upm.api.log

Interface AuditLogEntry

All Superinterfaces:
Comparable<AuditLogEntry>
public interface AuditLogEntry extends Comparable<AuditLogEntry>
Represents a single entry in the UPM's Audit Log. Entries can represent any kind of plugin event: plugin installation, plugin uninstallation, plugin enablement, and more.
Since:
1.6

  • Method Summary

    Modifier and Type
    Method
    Description
    Date
    getDate()
    Returns the date at which this log entry was created
    EntryType
    getEntryType()
    Returns the entry type of the event
    String
    getI18nKey()
    Returns the i18n key of the event message
    String
    getMessage(com.atlassian.sal.api.message.I18nResolver i18nResolver)
    Returns the log entry's message content
    String
    getTitle(com.atlassian.sal.api.message.I18nResolver i18nResolver)
    Returns the log entry's title.
    String
    getUserKey()
    Returns the userKey of the user that was logged in and created this event, or the application name if event is executed by the app
    String
    getUsername()
    Deprecated.
    since 2.10.1, use getUserKey()

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • getTitle

      String getTitle(com.atlassian.sal.api.message.I18nResolver i18nResolver)
      Returns the log entry's title.
      Parameters:
      i18nResolver - the I18nResolver used to translate the title
      Returns:
      the log entry's title.

    • getMessage

      String getMessage(com.atlassian.sal.api.message.I18nResolver i18nResolver)
      Returns the log entry's message content
      Parameters:
      i18nResolver - the I18nResolver used to translate the title
      Returns:
      the log entry's message content

    • getDate

      Date getDate()
      Returns the date at which this log entry was created
      Returns:
      the date at which this log entry was created

    • getUsername

      @Deprecated String getUsername()
      Deprecated.
      since 2.10.1, use getUserKey()
      Returns the username of the user that was logged in and created this event, or the application name if event is executed by the app
      Returns:
      the username of the user that was logged in and created this event, or the application name if event is executed by the app

    • getUserKey

      String getUserKey()
      Returns the userKey of the user that was logged in and created this event, or the application name if event is executed by the app
      Returns:
      the userKey of the user that was logged in and created this event, or the application name if event is executed by the app
      Since:
      2.10.1

    • getI18nKey

      String getI18nKey()
      Returns the i18n key of the event message
      Returns:
      the i18n key of the event message

    • getEntryType

      EntryType getEntryType()
      Returns the entry type of the event
      Returns:
      the entry type of the event
      Since:
      1.6