com.atlassian.confluence.plugins.restapi.resources

Class AuditResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.AuditResource

public class AuditResource
extends Object

Since:

5.10

Constructor Summary

Constructors

Constructor and Description
AuditResource(AuditService auditService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	export(JodaDate startDate, JodaDate endDate, String searchString, String format, javax.ws.rs.core.UriInfo uriInfo)
List<AuditRecord>	getAuditRecords(JodaDate startDate, JodaDate endDate, int start, int limit, String searchString, javax.ws.rs.core.UriInfo uriInfo) Fetch a paginated list of AuditRecord instances based on a date range.
List<AuditRecord>	getAuditRecords(long number, ChronoUnitCaseInsensitive units, int start, int limit, String searchString, javax.ws.rs.core.UriInfo uriInfo) Fetch a paginated list of AuditRecord instances dating back to a certain time
RetentionPeriod	getRetentionPeriod(javax.ws.rs.core.UriInfo uriInfo) Fetches the current retention period
RetentionPeriod	setRetentionPeriod(RetentionPeriod retentionPeriod, javax.ws.rs.core.UriInfo uriInfo) Set the retention period to a new value.
AuditRecord	storeRecord(AuditRecord record, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditResource

public AuditResource(AuditService auditService)

Method Detail

getAuditRecords

public List<AuditRecord> getAuditRecords(long number,
                                         ChronoUnitCaseInsensitive units,
                                         int start,
                                         int limit,
                                         String searchString,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

Fetch a paginated list of AuditRecord instances dating back to a certain time

Parameters:

number - the amount of time periods

units - the units to use for the time periods eg. 'days', 'months' etc

start - where to start within results set

limit - the maximum results to fetch

uriInfo - (injected) information about the request

Returns:

A paginated list of records

getRetentionPeriod

public RetentionPeriod getRetentionPeriod(@Context
                                          javax.ws.rs.core.UriInfo uriInfo)

Fetches the current retention period

Parameters:

uriInfo - (injected) information about the request

Returns:

A paginated list of records

setRetentionPeriod

public RetentionPeriod setRetentionPeriod(RetentionPeriod retentionPeriod,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)

Set the retention period to a new value. Can throw ServiceException if the retention period is too long

Parameters:

retentionPeriod - The new retention period to store

uriInfo - (injected) information about the request

Returns:

A paginated list of records

getAuditRecords

public List<AuditRecord> getAuditRecords(JodaDate startDate,
                                         JodaDate endDate,
                                         int start,
                                         int limit,
                                         String searchString,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

Fetch a paginated list of AuditRecord instances based on a date range.

Parameters:

startDate - earlier date to fetch records for

endDate - latest date to fetch records for

start - where to start within results set

limit - the maximum results to fetch

uriInfo - (injected) information about the request

Returns:

A paginated list of records

export

public javax.ws.rs.core.Response export(JodaDate startDate,
                                        JodaDate endDate,
                                        String searchString,
                                        String format,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo)

storeRecord

public AuditRecord storeRecord(AuditRecord record,
                               @Context
                               javax.ws.rs.core.UriInfo uriInfo)