Interface RecordsManagementAuditService

    • Method Detail

      • getAuditEvents

        List<AuditEvent> getAuditEvents()
        Retrieves a list of audit events.
        Returns:
        List of audit events
      • registerAuditEvent

        void registerAuditEvent​(String name,
                                String label)
        Register audit event.

        Creates an instance of a simple audit event and registers it with the service.

        Parameters:
        name - name of audit event
        label - display label of audit event
      • registerAuditEvent

        void registerAuditEvent​(AuditEvent auditEvent)
        Register audit event.
        Parameters:
        auditEvent - audit event
      • auditEvent

        void auditEvent​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        String eventName)
        Audits an event, assumes no properties where modified and that the event should not be audited immediately.
        Parameters:
        nodeRef - node reference
        eventName - event name
      • auditEvent

        void auditEvent​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        String eventName,
                        Map<org.alfresco.service.namespace.QName,​Serializable> before,
                        Map<org.alfresco.service.namespace.QName,​Serializable> after)
        Audits an event, assumes that the event should not be audited immediately and not be removed if no property is changed.
        Parameters:
        nodeRef - node reference
        eventName - event name
        before - property values before event (this must be modifiable and may be changed by the method).
        after - property values after event (this must be modifiable and may be changed by the method).
      • auditEvent

        void auditEvent​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        String eventName,
                        Map<org.alfresco.service.namespace.QName,​Serializable> before,
                        Map<org.alfresco.service.namespace.QName,​Serializable> after,
                        boolean immediate)
        Audit event, assumes not to be removed if no property is changed.
        Parameters:
        nodeRef - node reference
        eventName - event name
        before - property values before event (this must be modifiable and may be changed by the method).
        after - property values after event (this must be modifiable and may be changed by the method).
        immediate - true if event is to be audited immediately, false otherwise
      • auditEvent

        void auditEvent​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        String eventName,
                        Map<org.alfresco.service.namespace.QName,​Serializable> before,
                        Map<org.alfresco.service.namespace.QName,​Serializable> after,
                        boolean immediate,
                        boolean removeIfNoPropertyChanged)
        Audit event.
        Parameters:
        nodeRef - node reference
        eventName - event name
        before - property values before event (this must be modifiable and may be changed by the method).
        after - property values after event (this must be modifiable and may be changed by the method).
        immediate - true if event is to be audited immediately, false otherwise
        removeIfNoPropertyChanged - true if event is not audited when there are no properties changed, false otherwise
      • auditOrUpdateEvent

        void auditOrUpdateEvent​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                String eventName,
                                Map<org.alfresco.service.namespace.QName,​Serializable> before,
                                Map<org.alfresco.service.namespace.QName,​Serializable> after,
                                boolean removeIfNoPropertyChanged)
        Supply incremental changes as part of an event. This will either create a new event or update the existing details to put any supplied properties into the map.
        Parameters:
        nodeRef - node reference
        eventName - event name
        before - additional property values before event (this must be modifiable and may be changed by the method).
        after - additional property values after event (this must be modifiable and may be changed by the method).
        removeIfNoPropertyChanged - true if event is not audited when there are no properties changed, false otherwise
      • isAuditLogEnabled

        boolean isAuditLogEnabled​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Determines whether the RM audit log is currently enabled.
        Parameters:
        filePlan - file plan
        Returns:
        true if RM auditing is active false otherwise
      • startAuditLog

        void startAuditLog​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Start RM auditing.
        Parameters:
        filePlan - file plan
      • stopAuditLog

        void stopAuditLog​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Stop RM auditing.
        Parameters:
        filePlan - file plan
      • clearAuditLog

        void clearAuditLog​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Clears the RM audit.
        Parameters:
        filePlan - file plan
      • getDateAuditLogLastStarted

        Date getDateAuditLogLastStarted​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Returns the date the RM audit was last started.
        Parameters:
        filePlan - file plan
        Returns:
        Date the audit was last started
      • getDateAuditLogLastStopped

        Date getDateAuditLogLastStopped​(org.alfresco.service.cmr.repository.NodeRef filePlan)
        Returns the date the RM audit was last stopped.
        Returns:
        Date the audit was last stopped
      • getAuditTrailFile

        File getAuditTrailFile​(RecordsManagementAuditQueryParameters params,
                               RecordsManagementAuditService.ReportFormat format)
        Retrieves a list of audit log entries using the provided parameters represented by the RecordsManagementAuditQueryParameters instance.

        The parameters are all optional so an empty RecordsManagementAuditQueryParameters object will result in ALL audit log entries for the RM system being returned. Setting the various parameters effectively filters the full audit trail.

        Parameters:
        params - Parameters to use to retrieve audit trail (never null)
        format - The format the report should be produced in
        Returns:
        File containing JSON representation of audit trail
      • getAuditTrail

        List<RecordsManagementAuditEntry> getAuditTrail​(RecordsManagementAuditQueryParameters params)
        Retrieves a list of audit log entries using the provided parameters represented by the RecordsManagementAuditQueryParameters instance.

        The parameters are all optional so an empty RecordsManagementAuditQueryParameters object will result in ALL audit log entries for the RM system being returned. Setting the various parameters effectively filters the full audit trail.

        Parameters:
        params - Parameters to use to retrieve audit trail (never null)
        Returns:
        All entries for the audit trail
      • fileAuditTrailAsRecord

        org.alfresco.service.cmr.repository.NodeRef fileAuditTrailAsRecord​(RecordsManagementAuditQueryParameters params,
                                                                           org.alfresco.service.cmr.repository.NodeRef destination,
                                                                           RecordsManagementAuditService.ReportFormat format)
        Retrieves a list of audit log entries using the provided parameters represented by the RecordsManagementAuditQueryParameters instance and then files the resulting log as an undeclared record in the record folder represented by the given NodeRef.

        The parameters are all optional so an empty RecordsManagementAuditQueryParameters object will result in ALL audit log entries for the RM system being returned. Setting the various parameters effectively filters the full audit trail.

        Parameters:
        params - Parameters to use to retrieve audit trail (never null)
        destination - NodeRef representing a record folder in which to file the audit log
        format - The format the report should be produced in
        Returns:
        NodeRef of the undeclared record filed