Class BaseAuditRetrievalWebScript

  • All Implemented Interfaces:
    org.springframework.extensions.webscripts.WebScript
    Direct Known Subclasses:
    AuditLogGet, AuditLogPost

    public class BaseAuditRetrievalWebScript
    extends org.alfresco.repo.web.scripts.content.StreamContent
    Base class for all audit retrieval webscripts.
    Author:
    Gavin Cornwell
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

        org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.alfresco.service.namespace.NamespaceService namespaceService  
      protected RecordsManagementAuditService rmAuditService  
      • Fields inherited from class org.alfresco.repo.web.scripts.content.StreamContent

        delegate, mimetypeService, nodeService, permissionService, repository
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected RecordsManagementAuditQueryParameters parseQueryParameters​(org.springframework.extensions.webscripts.WebScriptRequest req)
      Parses the given request and builds an instance of RecordsManagementAuditQueryParameters to retrieve the relevant audit entries
      protected RecordsManagementAuditService.ReportFormat parseReportFormat​(org.springframework.extensions.webscripts.WebScriptRequest req)
      Parses the given request for the format the audit report should be returned in
      void setNamespaceService​(org.alfresco.service.namespace.NamespaceService namespaceService)
      Sets the NamespaceService instance
      void setRecordsManagementAuditService​(RecordsManagementAuditService rmAuditService)
      Sets the RecordsManagementAuditService instance
      • Methods inherited from class org.alfresco.repo.web.scripts.content.StreamContent

        createObjectReferenceFromUrl, execute, executeImpl, executeImpl, executeImpl, renderFormatTemplate, setAttachment, setDelegate, setMimetypeService, setNodeService, setPermissionService, setRepository, streamContent, streamContent, streamContent, streamContentImpl
      • Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

        addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString
    • Field Detail

      • namespaceService

        protected org.alfresco.service.namespace.NamespaceService namespaceService
    • Constructor Detail

      • BaseAuditRetrievalWebScript

        public BaseAuditRetrievalWebScript()
    • Method Detail

      • setRecordsManagementAuditService

        public void setRecordsManagementAuditService​(RecordsManagementAuditService rmAuditService)
        Sets the RecordsManagementAuditService instance
        Parameters:
        rmAuditService - The RecordsManagementAuditService instance
      • setNamespaceService

        public void setNamespaceService​(org.alfresco.service.namespace.NamespaceService namespaceService)
        Sets the NamespaceService instance
        Parameters:
        namespaceService - The NamespaceService instance
      • parseQueryParameters

        protected RecordsManagementAuditQueryParameters parseQueryParameters​(org.springframework.extensions.webscripts.WebScriptRequest req)
        Parses the given request and builds an instance of RecordsManagementAuditQueryParameters to retrieve the relevant audit entries
        Parameters:
        req - The request
        Returns:
        RecordsManagementAuditQueryParameters instance
      • parseReportFormat

        protected RecordsManagementAuditService.ReportFormat parseReportFormat​(org.springframework.extensions.webscripts.WebScriptRequest req)
        Parses the given request for the format the audit report should be returned in
        Parameters:
        req - The request
        Returns:
        The format for the report