org.alfresco.module.org_alfresco_module_rm.audit

Interface RecordsManagementAuditService

All Superinterfaces:

RecordsManagementAuditServiceDeprecated

All Known Implementing Classes:

RecordsManagementAuditServiceImpl

public interface RecordsManagementAuditService
extends RecordsManagementAuditServiceDeprecated

Records management audit service.

Author:

Gavin Cornwell

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RecordsManagementAuditService.ReportFormat

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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.
void	clearAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan) Clears the RM audit.
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.
List<AuditEvent>	getAuditEvents() Retrieves a list of audit events.
List<RecordsManagementAuditEntry>	getAuditTrail(RecordsManagementAuditQueryParameters params) Retrieves a list of audit log entries using the provided parameters represented by the RecordsManagementAuditQueryParameters instance.
File	getAuditTrailFile(RecordsManagementAuditQueryParameters params, RecordsManagementAuditService.ReportFormat format) Retrieves a list of audit log entries using the provided parameters represented by the RecordsManagementAuditQueryParameters instance.
Date	getDateAuditLogLastStarted(org.alfresco.service.cmr.repository.NodeRef filePlan) Returns the date the RM audit was last started.
Date	getDateAuditLogLastStopped(org.alfresco.service.cmr.repository.NodeRef filePlan) Returns the date the RM audit was last stopped.
boolean	isAuditLogEnabled(org.alfresco.service.cmr.repository.NodeRef filePlan) Determines whether the RM audit log is currently enabled.
void	registerAuditEvent(AuditEvent auditEvent) Register audit event.
void	registerAuditEvent(String name, String label) Register audit event.
void	startAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan) Start RM auditing.
void	stopAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan) Stop RM auditing.

Methods inherited from interface org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditServiceDeprecated

auditRMAction, clear, getDateLastStarted, getDateLastStopped, isEnabled, stop

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

after - property values after event

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

after - property values after event

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

after - property values after event

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

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