Package com.atlassian.upm.api.log

Interface PluginLogService

public interface PluginLogService
Provides a log of all events that change the state of the plugin system. An event is stored as a AuditLogEntry which consists of a date, user name, and message. The log can be retrieved as a collection of events.

Implementations should be thread safe. Multiple threads may assume they can call the interface methods safely, assuming no additional atomicity requirements are required between calls. Atomicity may be achieved by synchronizing on the service object and performing successive operations in that block.

Since:
1.6

  • Method Details

    • getLogEntries

      Iterable<AuditLogEntry> getLogEntries()
      Returns all plugin log entries.
      Returns:
      all plugin log entries.

    • getLogEntries

      Iterable<AuditLogEntry> getLogEntries(Integer maxResults, Integer startIndex)
      Returns maxResults number of plugin log entries, starting at startIndex.
      Parameters:
      maxResults - the maximum number of plugin log entries to return, or "all" if null
      startIndex - the starting index of plugin log entries, or 0 if null
      Returns:
      maxResults number of plugin log entries, starting at startIndex.

    • getLogEntries

      Iterable<AuditLogEntry> getLogEntries(Set<EntryType> entryTypes)
      Returns all plugin log entries with the specified EntryTypes.
      Parameters:
      entryTypes - the EntryTypes
      Returns:
      all plugin log entries with the specified EntryTypes.

    • getLogEntries

      Iterable<AuditLogEntry> getLogEntries(Integer maxResults, Integer startIndex, Set<EntryType> entryTypes)
      Returns maxResults number of plugin log entries of the specified types, starting at startIndex.
      Parameters:
      maxResults - the maximum number of plugin log entries to return, or "all" if null
      startIndex - the starting index of plugin log entries, or 0 if null
      entryTypes - the EntryTypes
      Returns:
      maxResults number of plugin log entries, starting at startIndex.