com.atlassian.confluence.internal.audit

Interface AuditManager

All Known Implementing Classes:

DefaultAuditManager

public interface AuditManager

Internal audit record manager

Since:

5.10

Method Summary

Modifier and Type	Method and Description
void	cleanOldRecords(Instant before) Remove all old audit records from before a certain time
PageResponse<AuditRecordEntity>	getRecords(LimitedRequest limitedRequest, Instant startDate, Instant endDate, boolean isSysAdmin, String searchString) Fetch AuditRecordEntities from the database according to some search criteria
com.atlassian.fugue.Option<AuditRecordEntity>	storeRecord(AuditRecordEntity auditRecord) Persist an AuditRecordEntity to the database.

Method Detail

storeRecord

com.atlassian.fugue.Option<AuditRecordEntity> storeRecord(AuditRecordEntity auditRecord)

Persist an AuditRecordEntity to the database.

Parameters:

auditRecord - the record to store

Returns:

the record that was stored, or an empty optional if the operation fails

getRecords

PageResponse<AuditRecordEntity> getRecords(LimitedRequest limitedRequest,
                                           Instant startDate,
                                           Instant endDate,
                                           boolean isSysAdmin,
                                           String searchString)

Fetch AuditRecordEntities from the database according to some search criteria

Parameters:

limitedRequest - The pagination limits on this request

startDate - The earliest date to look back to

endDate - The latest date to look up to

isSysAdmin - Whether or not to include audit entries that were trigger by sysadmin users

searchString - Filter audit entries based on this search string. Empty string or null indicates no filtering.

Returns:

A paginated result set of AuditRecordEntities

cleanOldRecords

void cleanOldRecords(Instant before)

Remove all old audit records from before a certain time

Parameters:

before -