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

Interface AuditServiceInternal

All Known Implementing Classes:
AuditServiceInternalImpl
public interface AuditServiceInternal

  • Method Details

    • getAuditLogForSite

      List<AuditLog> getAuditLogForSite(String site, int offset, int limit, String user, List<String> actions) throws SiteNotFoundException
      Get audit log for site
      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

      int getAuditLogForSiteTotal(String site, String user, List<String> actions) throws SiteNotFoundException
      Get total number of audit log entries for site
      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

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

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

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

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

      AuditLog getAuditLogEntry(String siteId, long auditLogId)
      Get audit log entry by id
      Parameters:
      auditLogId - id of audit log entry to get
      siteId - the site ID. When null or empty, it will retrieve entries for all sites and include admin activities.
      Returns:
      Audit log entry

    • insertAuditLog

      boolean insertAuditLog(AuditLog auditLog)
      Insert log audit entry
      Parameters:
      auditLog - Audit log to insert
      Returns:
      true if successful, otherwise false

    • createAuditLogEntry

      AuditLog createAuditLogEntry()
      Create Audit log entry and populate common properties
      Returns:
      Audit log entry

    • selectUserFeedEntries

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

    • deleteAuditLogForSite

      void deleteAuditLogForSite(long siteId)
      Delete audit log for site
      Parameters:
      siteId - site id

    • getAuthor

      Person getAuthor(String commitId)
      Get author of the commit. This will look in the audit data and retrieve a Person when:
      • There is an audit entry for the given commit id
      • AND the audit entry origin is API
      Parameters:
      commitId - commit id
      Returns:
      author of the commit, if found, otherwise null