com.citytechinc.aem.groovy.console.audit.AuditService.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-groovy-console Show documentation

The AEM Groovy Console provides an interface for running Groovy scripts in the AEM (Adobe CQ) container. Scripts can be created to manipulate content in the JCR, call OSGi services, or execute arbitrary code using the AEM, Sling, or JCR APIs.

There is a newer version: 8.1.0

Show newest version

package com.citytechinc.aem.groovy.console.audit

import com.citytechinc.aem.groovy.console.response.RunScriptResponse

import javax.jcr.RepositoryException

interface AuditService {

    /**
     * Create an audit record for the given script execution response.
     *
     * @param response response containing execution result or exception
     */
    AuditRecord createAuditRecord(RunScriptResponse response)

    /**
     * Delete all audit records.
     *
     * @throws RepositoryException if an error occurs while deleting audit nodes
     */
    void deleteAllAuditRecords() throws RepositoryException

    /**
     * Delete an audit record.
     *
     * @param relativePath relative path to audit record from parent audit node
     * @throws RepositoryException if an error occurs while deleting the audit record node
     */
    void deleteAuditRecord(String relativePath) throws RepositoryException

    /**
     * Get all audit records.
     *
     * @return all audit records
     * @throws RepositoryException if error occurs getting audit records
     */
    List getAllAuditRecords() throws RepositoryException

    /**
     * Get the audit record at the given relative path.
     *
     * @param relativePath relative path to audit record from parent audit node
     * @return audit record or null if none exists
     */
    AuditRecord getAuditRecord(String relativePath)

    /**
     * Get a list of audit records for the given date range.
     *
     * @param startDate start date
     * @param endDate end date
     * @return list of audit records in the given date range
     * @throws RepositoryException if error occurs getting audit records
     */
    List getAuditRecords(Calendar startDate, Calendar endDate) throws RepositoryException
}