com.atlassian.confluence.api.impl.service.audit

Class AuditServiceImpl

java.lang.Object

com.atlassian.confluence.api.impl.service.audit.AuditServiceImpl

All Implemented Interfaces:

AuditService

public class AuditServiceImpl
extends Object
implements AuditService

Since:

5.10

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.api.service.audit.AuditService

AuditService.AuditCSVWriter, AuditService.AuditRecordFinder, AuditService.Validator

Constructor Summary

Constructors

Constructor and Description

AuditServiceImpl(AuditManager auditManager, AuditRecordFactory recordFactory, AuditRecordEntityFactory recordEntityFactory, PaginationService paginationService, UserAccessor userAccessor, PermissionManager permissionManager, SettingsManager settingsManager, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.sal.api.timezone.TimeZoneManager timeZoneManager, I18NBeanFactory i18NBeanFactory)

Method Summary

Modifier and Type	Method and Description
void	deleteRecords(Instant before) Clean up all old audit records from before a certain time
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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditServiceImpl

public AuditServiceImpl(AuditManager auditManager,
                        AuditRecordFactory recordFactory,
                        AuditRecordEntityFactory recordEntityFactory,
                        PaginationService paginationService,
                        UserAccessor userAccessor,
                        PermissionManager permissionManager,
                        SettingsManager settingsManager,
                        com.atlassian.event.api.EventPublisher eventPublisher,
                        com.atlassian.sal.api.timezone.TimeZoneManager timeZoneManager,
                        I18NBeanFactory i18NBeanFactory)

Method Detail

storeRecord

public AuditRecord storeRecord(AuditRecord record)
                        throws ServiceException

Description copied from interface: AuditService

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)

Specified by:

storeRecord in interface AuditService

Parameters:

record - The record to store

Returns:

The final record that was stored.

Throws:

ServiceException - if the record is invalid

getRecords

public AuditService.AuditRecordFinder getRecords(Instant startDate,
                                                 Instant endDate)

Description copied from interface: AuditService

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

Specified by:

getRecords in interface AuditService

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

public RetentionPeriod getRetentionPeriod()

Specified by:

getRetentionPeriod in interface AuditService

Returns:

the configured retention period for audit records.

setRetentionPeriod

public RetentionPeriod setRetentionPeriod(RetentionPeriod retentionPeriod)

Description copied from interface: AuditService

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

Specified by:

setRetentionPeriod in interface AuditService

Parameters:

retentionPeriod - the period to set

Returns:

The final retention period if successful.

deleteRecords

public void deleteRecords(Instant before)

Description copied from interface: AuditService

Clean up all old audit records from before a certain time

Specified by:

deleteRecords in interface AuditService

validator

public AuditService.Validator validator()

Specified by:

validator in interface AuditService

exportCSV

public AuditService.AuditCSVWriter exportCSV()

Specified by:

exportCSV in interface AuditService