com.atlassian.confluence.api.service.audit

Interface AuditService

All Known Implementing Classes:

AuditServiceImpl

@ExperimentalApi
public interface AuditService

Provides methods for creating and retrieving audit records, as well as configuring the audit record retention period

Since:

5.10

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AuditService.AuditCSVWriter Streaming CSV writer for exporting audit records
static interface	AuditService.AuditRecordFinder Finder for audit records.
static interface	AuditService.Validator Validator for audit records

Method Summary

Modifier and Type	Method and Description
AuditService.AuditCSVWriter	exportCSV()
AuditService.AuditRecordFinder	getRecords(Instant startDate, Instant endDate) Retrieve audit records from the system via an AuditService.AuditRecordFinder instance.
RetentionPeriod	getRetentionPeriod()
RetentionPeriod	setRetentionPeriod(RetentionPeriod retentionPeriod) Set the configured retention period for audit records.
AuditRecord	storeRecord(AuditRecord record) Persist the given AuditRecord.
AuditService.Validator	validator()

Method Detail

storeRecord

AuditRecord storeRecord(AuditRecord record)
                 throws ServiceException

Persist the given AuditRecord. The sysadmin field will be set based on the current user's privileges before storing the record. Records will be validated using AuditService.Validator.validateCreate(AuditRecord)

Parameters:

record - The record to store

Returns:

The final record that was stored.

Throws:

ServiceException - if the record is invalid

getRecords

AuditService.AuditRecordFinder getRecords(@Nullable
                                          Instant startDate,
                                          @Nullable
                                          Instant endDate)

Retrieve audit records from the system via an AuditService.AuditRecordFinder instance.

Parameters:

startDate - The earliest date to fetch records from. Null indicates no limit.

endDate - The latest date to fetch records from. Null indicates no limit.

Returns:

An AuditRecordFinder instance that will search between the specified dates, if supplied.

getRetentionPeriod

RetentionPeriod getRetentionPeriod()

Returns:

the configured retention period for audit records.

setRetentionPeriod

RetentionPeriod setRetentionPeriod(RetentionPeriod retentionPeriod)
                            throws ServiceException

Set the configured retention period for audit records. A hard system limit is imposed by the sysprop: confluence.audit.retention.limit.months

Parameters:

retentionPeriod - the period to set

Returns:

The final retention period if successful.

Throws:

ServiceException - if the retention period is longer than the system limit.

validator

AuditService.Validator validator()

exportCSV

AuditService.AuditCSVWriter exportCSV()