Package org.craftercms.studio.api.v2.service.audit

Interface AuditService

All Known Implementing Classes:

AuditServiceImpl

public interface AuditService

Audit Service

Method Summary

Modifier and Type	Method	Description
List<AuditLog>	getAuditLog(String siteId, int offset, int limit, String user, List<String> operations, boolean includeParameters, ZonedDateTime dateFrom, ZonedDateTime dateTo, String target, String origin, String clusterNodeId, String sort, String order)	Get audit log
AuditLog	getAuditLogEntry(String siteId, long auditLogId)	Get audit log entry by id
int	getAuditLogTotal(String siteId, String user, List<String> operations, boolean includeParameters, ZonedDateTime dateFrom, ZonedDateTime dateTo, String target, String origin, String clusterNodeId)	Get total number of audit log entries for given filters
List<ContentItemTO>	getUserActivities(String site, int limit, String sort, boolean ascending, boolean excludeLive, String filterType)	Get user activities

Method Details

getAuditLog

List<AuditLog> getAuditLog(String siteId,
 int offset,
 int limit,
 String user,
 List<String> operations,
 boolean includeParameters,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 String target,
 String origin,
 String clusterNodeId,
 String sort,
 String order)
                    throws SiteNotFoundException

Get audit log

Parameters:

siteId - filter logs by given site ID. It can be null or empty when user is system admin, it will then retrieve entries for all sites and include admin activities.

offset - offset of the first record

limit - number of records to return

user - filter logs by given user

operations - filter logs by given operations

includeParameters - include audit log parameters into result set

dateFrom - filter logs by date starting from given date

dateTo - filter logs by date until given date

target - filter logs by given operation target

origin - filter logs by origin

clusterNodeId - filter logs by given cluster node id

sort - sort logs by given sort type

order - order logs

Returns:

audit log result set

Throws:

SiteNotFoundException

getAuditLogTotal

int getAuditLogTotal(String siteId,
 String user,
 List<String> operations,
 boolean includeParameters,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 String target,
 String origin,
 String clusterNodeId)
              throws SiteNotFoundException

Get total number of audit log entries for given filters

Parameters:

siteId - filter logs by given site ID. It can be null or empty when user is system admin, it will then retrieve entries for all sites and include admin activities.

user - filter logs by given user

operations - filter logs by given operations

includeParameters - include audit log parameters into result set

dateFrom - filter logs by date starting from given date

dateTo - filter logs by date until given date

target - filter logs by given operation target

origin - filter logs by origin

clusterNodeId - filter logs by given cluster node id

Returns:

number of audit log entries

Throws:

SiteNotFoundException

getAuditLogEntry

AuditLog getAuditLogEntry(String siteId,
 long auditLogId)
                   throws SiteNotFoundException

Get audit log entry by id

Parameters:

siteId - site ID. It can be null or empty when user is system admin

auditLogId - audit log id

Returns:

audit log entry

Throws:

SiteNotFoundException

getUserActivities

List<ContentItemTO> getUserActivities(String site,
 int limit,
 String sort,
 boolean ascending,
 boolean excludeLive,
 String filterType)
                               throws ServiceLayerException

Get user activities

Parameters:

site - site

limit - limit

sort - sort by

ascending - true if ascending order, otherwise false

excludeLive - exclude live items

filterType - filter type

Returns:

list of content items

Throws:

ServiceLayerException - general service error