AuditServiceInternalImpl (Crafter Studio 4.0.5 API)

java.lang.Object
- org.craftercms.studio.impl.v2.service.audit.internal.AuditServiceInternalImpl

All Implemented Interfaces:: AuditServiceInternal

public class AuditServiceInternalImpl
extends Object
implements AuditServiceInternal

Constructor Summary

Constructors
Constructor Description

AuditServiceInternalImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuditLog`	`createAuditLogEntry()`	Create Audit log entry and populate common properties
`void`	`deleteAuditLogForSite(long siteId)`	Delete audit log for site
`List<AuditLog>`	`getAuditDashboard(String siteId, int offset, int limit, String user, List<String> operations, ZonedDateTime dateFrom, ZonedDateTime dateTo, String target, String sort, String order)`	Get audit dashboard content filtered by parameters
`int`	`getAuditDashboardTotal(String siteId, String user, List<String> operations, ZonedDateTime dateFrom, ZonedDateTime dateTo, String target)`	Get total number of records for audit dashboard filtered by parameters
`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 filtered by parameters
`AuditLog`	`getAuditLogEntry(String siteId, long auditLogId)`	Get audit log entry by id
`List<AuditLog>`	`getAuditLogForSite(String site, int offset, int limit, String user, List<String> actions)`	Get audit log for site
`int`	`getAuditLogForSiteTotal(String site, String user, List<String> actions)`	Get total number of audit log entries for site
`int`	`getAuditLogTotal(String siteId, String user, List<String> operations, boolean includeParameters, ZonedDateTime dateFrom, ZonedDateTime dateTo, String target, String origin, String clusterNodeId)`	Get the audit log entry count given the provided filter parameters
`boolean`	`insertAuditLog(AuditLog auditLog)`	Insert log audit entry
`List<AuditLog>`	`selectUserFeedEntries(String user, String siteId, int offset, int limit, String contentType, boolean hideLiveItems)`
`void`	`setAuditDao(AuditDAO auditDao)`
`void`	`setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AuditServiceInternalImpl
```
public AuditServiceInternalImpl()
```

Method Detail

getAuditLogForSite

public List<AuditLog> getAuditLogForSite(String site,
                                         int offset,
                                         int limit,
                                         String user,
                                         List<String> actions)
                                  throws SiteNotFoundException

Description copied from interface: AuditServiceInternal

Get audit log for site

Specified by:: getAuditLogForSite in interface AuditServiceInternal
Parameters:: site - site; offset - offset of the first record; limit - number of records to return; user - filter logs by user; actions - filter logs by actions
Returns:: audit list
Throws:: SiteNotFoundException - thrown if site does not exist

getAuditLogForSiteTotal
```
public int getAuditLogForSiteTotal(String site,
                                   String user,
                                   List<String> actions)
                            throws SiteNotFoundException
```
Description copied from interface: AuditServiceInternal

Get total number of audit log entries for site

Specified by:

getAuditLogForSiteTotal in interface AuditServiceInternal

Parameters:

site - site

user - filter logs by user

actions - filter logs by actions

Returns:

number of audit log entries

Throws:

SiteNotFoundException - thrown if site does not exist

getAuditLog

public 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)

Description copied from interface: AuditServiceInternal

Get audit log filtered by parameters

Specified by:: getAuditLog in interface AuditServiceInternal
Parameters:: siteId - site identifier; offset - offset of first record in result set; limit - number of records to return as result set; user - filter by user; operations - filter by list of operations; includeParameters - include audit log parameters in result set; dateFrom - filter results by lower border for date; dateTo - filter results by upper border for date; target - filter results by target; origin - filter results by origin; clusterNodeId - filter results by cluster node; sort - sort strategy; order - order strategy
Returns:: List of audit log entries

getAuditLogTotal

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

Description copied from interface: AuditServiceInternal

Get the audit log entry count given the provided filter parameters

Specified by:: getAuditLogTotal in interface AuditServiceInternal
Parameters:: siteId - site ID; user - filter by user; operations - filter by list of operations; includeParameters - include audit log parameters in result set; dateFrom - filter results by lower border for date; dateTo - filter results by upper border for date; target - filter results by target; origin - filter results by origin; clusterNodeId - filter results by cluster node
Returns:: total number of records matching the filter

getAuditDashboardTotal

public int getAuditDashboardTotal(String siteId,
                                  String user,
                                  List<String> operations,
                                  ZonedDateTime dateFrom,
                                  ZonedDateTime dateTo,
                                  String target)

Description copied from interface: AuditServiceInternal

Get total number of records for audit dashboard filtered by parameters

Specified by:: getAuditDashboardTotal in interface AuditServiceInternal
Parameters:: siteId - site identifier; user - filter logs by user; operations - filter logs by action; dateFrom - lower boundary for operation timestamp; dateTo - upper boundary for operation timestamp; target - filter logs by target
Returns:: total number of records

getAuditDashboard

public List<AuditLog> getAuditDashboard(String siteId,
                                        int offset,
                                        int limit,
                                        String user,
                                        List<String> operations,
                                        ZonedDateTime dateFrom,
                                        ZonedDateTime dateTo,
                                        String target,
                                        String sort,
                                        String order)

Description copied from interface: AuditServiceInternal

Get audit dashboard content filtered by parameters

Specified by:: getAuditDashboard in interface AuditServiceInternal
Parameters:: siteId - site identifier; offset - offset of the first record; limit - number of records to return; user - filter logs by user; operations - filter logs by actions; dateFrom - lower boundary for operation timestamp; dateTo - upper boundary for operation timestamp; target - filter logs by target; sort - sort for records; order - order for records
Returns:: list of records for audit dashboard

getAuditLogEntry
```
public AuditLog getAuditLogEntry(String siteId,
                                 long auditLogId)
```
Description copied from interface: AuditServiceInternal

Get audit log entry by id

Specified by:

getAuditLogEntry in interface AuditServiceInternal

Parameters:

siteId - the site ID. When null or empty, it will retrieve entries for all sites and include admin activities.

auditLogId - id of audit log entry to get

Returns:

Audit log entry

insertAuditLog
```
public boolean insertAuditLog(AuditLog auditLog)
```
Description copied from interface: AuditServiceInternal

Insert log audit entry

Specified by:

insertAuditLog in interface AuditServiceInternal

Parameters:

auditLog - Audit log to insert

Returns:

true if successful, otherwise false

createAuditLogEntry
```
public AuditLog createAuditLogEntry()
```
Description copied from interface: AuditServiceInternal

Create Audit log entry and populate common properties

Specified by:

createAuditLogEntry in interface AuditServiceInternal

Returns:

Audit log entry

selectUserFeedEntries

public List<AuditLog> selectUserFeedEntries(String user,
                                            String siteId,
                                            int offset,
                                            int limit,
                                            String contentType,
                                            boolean hideLiveItems)

Specified by:: selectUserFeedEntries in interface AuditServiceInternal

deleteAuditLogForSite
```
public void deleteAuditLogForSite(long siteId)
```
Description copied from interface: AuditServiceInternal

Delete audit log for site

Specified by:

deleteAuditLogForSite in interface AuditServiceInternal

Parameters:

siteId - site id

setAuditDao

public void setAuditDao(AuditDAO auditDao)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)