Summary: Methods | [Expand All]
@ExperimentalApi public interface

AuditingService

com.atlassian.jira.auditing.AuditingService
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Service for managing auditing records

Summary

Public Methods
@Nonnull ServiceOutcome<Records> getRecords(Integer offset, Integer maxResults, AuditingFilter filter)
@Nonnull Long getTotalNumberOfRecords()
Returns total number of audit records
@Nonnull ErrorCollection storeRecord(String category, String summary, String eventSourceKey, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems)
/** Store record in Auditing Log along with plugin name created the event
@Nonnull ErrorCollection storeRecord(String category, String summary, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems)
Store record in Auditing Log

Public Methods

@Nonnull public ServiceOutcome<Records> getRecords (Integer offset, Integer maxResults, AuditingFilter filter)

Parameters
offset the offset from which search starts
maxResults maximum number of returned results
filter defines how records should be filtered out before being returned, if null records will not be filtered
Returns
  • Records instance wrapped in ServiceOutcome

@Nonnull public Long getTotalNumberOfRecords ()

Returns total number of audit records

Returns
  • total number of records

@Nonnull public ErrorCollection storeRecord (String category, String summary, String eventSourceKey, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems)

/** Store record in Auditing Log along with plugin name created the event

Parameters
category - category of the log record
summary - description of the change
eventSourceKey - key of plugin which creates the record
objectItem - changed object
values - changed values of the object item
associatedItems

@Nonnull public ErrorCollection storeRecord (String category, String summary, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems)

Store record in Auditing Log

Parameters
category - category of the log record
summary - description of the change
objectItem - changed object
values - changed values of the object item
associatedItems