com.atlassian.jira.auditing

Interface AuditingService

All Known Implementing Classes:

DefaultAuditingService

@ExperimentalApi
public interface AuditingService

Service for managing auditing records

Since:

v6.3

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Records>	getRecords(Integer offset, Integer maxResults, AuditingFilter filter)
Long	getTotalNumberOfRecords() Returns total number of audit records
ErrorCollection	storeRecord(String category, String summary, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems) Deprecated. since 7.0.0. Use storeRecord(String, String, AssociatedItem, Iterable, Iterable, String) instead
ErrorCollection	storeRecord(String category, String summary, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems, String description) Store record in Auditing Log
ErrorCollection	storeRecord(String category, String summary, String eventSourceKey, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems) Deprecated. since 7.0.0. Use storeRecord(String, String, String, AssociatedItem, Iterable, Iterable, String) instead
ErrorCollection	storeRecord(String category, String summary, String eventSourceKey, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems, String description) Store record in Auditing Log along with plugin name created the event

Method Detail

getRecords

@Nonnull
ServiceOutcome<Records> getRecords(@Nullable
                                            Integer offset,
                                            @Nullable
                                            Integer maxResults,
                                            @Nullable
                                            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

storeRecord

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

Deprecated. since 7.0.0. Use storeRecord(String, String, AssociatedItem, Iterable, Iterable, String) instead

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 - - other objects that were affected by this change

associatedItems - @return

storeRecord

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

Deprecated. since 7.0.0. Use storeRecord(String, String, String, AssociatedItem, Iterable, Iterable, String) instead

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 - - other objects that were affected by this change

associatedItems - @return

storeRecord

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

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 - - other objects that were affected by this change

description - - an optional description for this event

Returns:

a collection of any encountered errors

Since:

7.0.0

storeRecord

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

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 - - other objects that were affected by this change

description - - an optional description for this event

Returns:

a collection of any encountered errors

Since:

7.0.0

getTotalNumberOfRecords

@Nonnull
Long getTotalNumberOfRecords()

Returns total number of audit records

Returns:

total number of records