com.atlassian.crowd.manager.audit

Interface AuditService

All Known Subinterfaces:

InternalAuditService

All Known Implementing Classes:

AuditServiceImpl

public interface AuditService

The service for interacting with the audit log. It allows to create new audit log entries or query the audit log.

Since:

v2.12

Method Summary

Modifier and Type	Method and Description
AuditLogConfiguration	getConfiguration() Returns current auditing configuration
boolean	isEnabled()
void	saveAudit(AuditLogChangeset changeset) Persists an audit log changeset and all of its entries.
void	saveConfiguration(AuditLogConfiguration auditLogConfiguration) Sets the new configuration for auditing
List<AuditLogChangeset>	searchAuditLog(EntityQuery<AuditLogChangeset> query) Queries the audit log.

Method Detail

saveAudit

void saveAudit(AuditLogChangeset changeset)

Persists an audit log changeset and all of its entries. The timestamp will be set to the current time. Will not do anything when audit log is disabled.

Parameters:

changeset - the changeset that will be persisted

searchAuditLog

List<AuditLogChangeset> searchAuditLog(EntityQuery<AuditLogChangeset> query)

Queries the audit log. Returns a List of AuditLogChangesets, which match the criteria specified in the query. The results will be sorted according to the column and order specified in the query.

Parameters:

query - the search query

Returns:

List of AuditLogEntry matching the query

isEnabled

boolean isEnabled()

Returns:

true if the audit log is enabled, false otherwise. A disabled audit log will not persist any new entries.

saveConfiguration

void saveConfiguration(AuditLogConfiguration auditLogConfiguration)

Sets the new configuration for auditing

Parameters:

auditLogConfiguration - new configuration

getConfiguration

AuditLogConfiguration getConfiguration()

Returns current auditing configuration

Returns:

current configuration