RecordsManagementAuditServiceImpl (Alfresco Records Management Community Repo 2.5.a API)

java.lang.Object
- org.springframework.extensions.surf.util.AbstractLifecycleBean
- - org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditServiceImpl

All Implemented Interfaces:

EventListener, RecordsManagementAuditService, RecordsManagementAuditServiceDeprecated, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener
```
public class RecordsManagementAuditServiceImpl
extends org.springframework.extensions.surf.util.AbstractLifecycleBean
implements RecordsManagementAuditService
```
Records Management Audit Service Implementation.

Since:

3.2

Author:

Gavin Cornwell

Nested Class Summary
- Nested classes/interfaces inherited from interface org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditService
  RecordsManagementAuditService.ReportFormat

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`AUDIT_TRAIL_FILE_PREFIX`
`protected static String`	`AUDIT_TRAIL_HTML_FILE_SUFFIX`
`protected static String`	`AUDIT_TRAIL_JSON_FILE_SUFFIX`
`protected CapabilityService`	`capabilityService`
`protected static String`	`DOD5015_AUDIT_APPLICATION_NAME`
`protected static String`	`DOD5015_AUDIT_DATA_EVENT_NAME`
`protected static String`	`DOD5015_AUDIT_DATA_LOGIN_ERROR`
`protected static String`	`DOD5015_AUDIT_DATA_LOGIN_FULLNAME`
`protected static String`	`DOD5015_AUDIT_DATA_LOGIN_USERNAME`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_CHANGES_AFTER`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_CHANGES_BEFORE`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_IDENTIFIER`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_NAME`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_NAMEPATH`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_NODEREF`
`protected static String`	`DOD5015_AUDIT_DATA_NODE_TYPE`
`protected static String`	`DOD5015_AUDIT_DATA_PERSON_FULLNAME`
`protected static String`	`DOD5015_AUDIT_DATA_PERSON_ROLES`
`protected static String`	`DOD5015_AUDIT_PATH_ROOT`
`protected static String`	`DOD5015_AUDIT_SNIPPET_AFTER`
`protected static String`	`DOD5015_AUDIT_SNIPPET_BEFORE`
`protected static String`	`DOD5015_AUDIT_SNIPPET_CHANGES`
`protected static String`	`DOD5015_AUDIT_SNIPPET_EVENT`
`protected static String`	`DOD5015_AUDIT_SNIPPET_NAME`
`protected static String`	`DOD5015_AUDIT_SNIPPET_NODE`
`protected static String`	`DOD5015_AUDIT_SNIPPET_PERSON`
`protected static String`	`RM_AUDIT_APPLICATION_NAME`
`protected static String`	`RM_AUDIT_DATA_EVENT_NAME`
`protected static String`	`RM_AUDIT_DATA_LOGIN_ERROR`
`protected static String`	`RM_AUDIT_DATA_LOGIN_FULLNAME`
`protected static String`	`RM_AUDIT_DATA_LOGIN_USERNAME`
`protected static String`	`RM_AUDIT_DATA_NODE_CHANGES_AFTER`
`protected static String`	`RM_AUDIT_DATA_NODE_CHANGES_BEFORE`
`protected static String`	`RM_AUDIT_DATA_NODE_IDENTIFIER`
`protected static String`	`RM_AUDIT_DATA_NODE_NAME`
`protected static String`	`RM_AUDIT_DATA_NODE_NAMEPATH`
`protected static String`	`RM_AUDIT_DATA_NODE_NODEREF`
`protected static String`	`RM_AUDIT_DATA_NODE_TYPE`
`protected static String`	`RM_AUDIT_DATA_PERSON_FULLNAME`
`protected static String`	`RM_AUDIT_DATA_PERSON_ROLES`
`protected static String`	`RM_AUDIT_EVENT_LOGIN_FAILURE`
`protected static String`	`RM_AUDIT_EVENT_LOGIN_SUCCESS`
`protected static String`	`RM_AUDIT_PATH_ROOT`
`protected static String`	`RM_AUDIT_SNIPPET_AFTER`
`protected static String`	`RM_AUDIT_SNIPPET_BEFORE`
`protected static String`	`RM_AUDIT_SNIPPET_CHANGES`
`protected static String`	`RM_AUDIT_SNIPPET_EVENT`
`protected static String`	`RM_AUDIT_SNIPPET_NAME`
`protected static String`	`RM_AUDIT_SNIPPET_NODE`
`protected static String`	`RM_AUDIT_SNIPPET_PERSON`

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean
log

Constructor Summary

Constructors
Constructor and Description

RecordsManagementAuditServiceImpl()

Constructors
Constructor and Description
`RecordsManagementAuditServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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`	`auditRMAction(RecordsManagementAction action, org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<String,Serializable> parameters)` Deprecated. since 2.1
`void`	`clear()` Deprecated.
`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.
`Date`	`getDateLastStarted()` Deprecated.
`Date`	`getDateLastStopped()` Deprecated.
`void`	`init()` Checks that all necessary properties have been set.
`boolean`	`isAuditLogEnabled(org.alfresco.service.cmr.repository.NodeRef filePlan)` Determines whether the RM audit log is currently enabled.
`boolean`	`isEnabled()` Deprecated.
`protected void`	`onBootstrap(org.springframework.context.ApplicationEvent event)`
`protected void`	`onShutdown(org.springframework.context.ApplicationEvent event)`
`void`	`registerAuditEvent(AuditEvent auditEvent)` Register audit event.
`void`	`registerAuditEvent(String name, String label)` Register audit event.
`void`	`setAuditComponent(org.alfresco.repo.audit.AuditComponent auditComponent)` The component to create audit events
`void`	`setAuditService(org.alfresco.service.cmr.audit.AuditService auditService)` Sets the AuditService instance
`void`	`setCapabilityService(CapabilityService capabilityService)`
`void`	`setContentService(org.alfresco.service.cmr.repository.ContentService contentService)` Sets the ContentService instance
`void`	`setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)` Provides user-readable names for types
`void`	`setFilePlanService(FilePlanService filePlanService)`
`void`	`setIgnoredAuditProperties(List<String> ignoredAuditProperties)`
`void`	`setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)`
`void`	`setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)` Sets the NodeService instance
`void`	`setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)` Set the component used to bind to behaviour callbacks
`void`	`setRecordsManagementActionService(RecordsManagementActionService rmActionService)` Sets the RecordsManagementActionService instance
`void`	`setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)` Set the component used to start new transactions
`void`	`start()` Deprecated.
`void`	`startAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan)` Start RM auditing.
`void`	`stop()` Deprecated.
`void`	`stopAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan)` Stop RM auditing.

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean
getApplicationContext, onApplicationEvent, setApplicationContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RM_AUDIT_EVENT_LOGIN_SUCCESS
```
protected static final String RM_AUDIT_EVENT_LOGIN_SUCCESS
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_EVENT_LOGIN_FAILURE
```
protected static final String RM_AUDIT_EVENT_LOGIN_FAILURE
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_APPLICATION_NAME
```
protected static final String RM_AUDIT_APPLICATION_NAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_PATH_ROOT
```
protected static final String RM_AUDIT_PATH_ROOT
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_EVENT
```
protected static final String RM_AUDIT_SNIPPET_EVENT
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_PERSON
```
protected static final String RM_AUDIT_SNIPPET_PERSON
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_NAME
```
protected static final String RM_AUDIT_SNIPPET_NAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_NODE
```
protected static final String RM_AUDIT_SNIPPET_NODE
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_CHANGES
```
protected static final String RM_AUDIT_SNIPPET_CHANGES
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_BEFORE
```
protected static final String RM_AUDIT_SNIPPET_BEFORE
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_SNIPPET_AFTER
```
protected static final String RM_AUDIT_SNIPPET_AFTER
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_PERSON_FULLNAME
```
protected static final String RM_AUDIT_DATA_PERSON_FULLNAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_PERSON_ROLES
```
protected static final String RM_AUDIT_DATA_PERSON_ROLES
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_EVENT_NAME
```
protected static final String RM_AUDIT_DATA_EVENT_NAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_NODEREF
```
protected static final String RM_AUDIT_DATA_NODE_NODEREF
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_NAME
```
protected static final String RM_AUDIT_DATA_NODE_NAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_TYPE
```
protected static final String RM_AUDIT_DATA_NODE_TYPE
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_IDENTIFIER
```
protected static final String RM_AUDIT_DATA_NODE_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_NAMEPATH
```
protected static final String RM_AUDIT_DATA_NODE_NAMEPATH
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_CHANGES_BEFORE
```
protected static final String RM_AUDIT_DATA_NODE_CHANGES_BEFORE
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_NODE_CHANGES_AFTER
```
protected static final String RM_AUDIT_DATA_NODE_CHANGES_AFTER
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_LOGIN_USERNAME
```
protected static final String RM_AUDIT_DATA_LOGIN_USERNAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_LOGIN_FULLNAME
```
protected static final String RM_AUDIT_DATA_LOGIN_FULLNAME
```
    See Also:
    
    Constant Field Values
  - RM_AUDIT_DATA_LOGIN_ERROR
```
protected static final String RM_AUDIT_DATA_LOGIN_ERROR
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_APPLICATION_NAME
```
protected static final String DOD5015_AUDIT_APPLICATION_NAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_PATH_ROOT
```
protected static final String DOD5015_AUDIT_PATH_ROOT
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_EVENT
```
protected static final String DOD5015_AUDIT_SNIPPET_EVENT
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_PERSON
```
protected static final String DOD5015_AUDIT_SNIPPET_PERSON
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_NAME
```
protected static final String DOD5015_AUDIT_SNIPPET_NAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_NODE
```
protected static final String DOD5015_AUDIT_SNIPPET_NODE
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_CHANGES
```
protected static final String DOD5015_AUDIT_SNIPPET_CHANGES
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_BEFORE
```
protected static final String DOD5015_AUDIT_SNIPPET_BEFORE
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_SNIPPET_AFTER
```
protected static final String DOD5015_AUDIT_SNIPPET_AFTER
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_PERSON_FULLNAME
```
protected static final String DOD5015_AUDIT_DATA_PERSON_FULLNAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_PERSON_ROLES
```
protected static final String DOD5015_AUDIT_DATA_PERSON_ROLES
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_EVENT_NAME
```
protected static final String DOD5015_AUDIT_DATA_EVENT_NAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_NODEREF
```
protected static final String DOD5015_AUDIT_DATA_NODE_NODEREF
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_NAME
```
protected static final String DOD5015_AUDIT_DATA_NODE_NAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_TYPE
```
protected static final String DOD5015_AUDIT_DATA_NODE_TYPE
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_IDENTIFIER
```
protected static final String DOD5015_AUDIT_DATA_NODE_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_NAMEPATH
```
protected static final String DOD5015_AUDIT_DATA_NODE_NAMEPATH
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_CHANGES_BEFORE
```
protected static final String DOD5015_AUDIT_DATA_NODE_CHANGES_BEFORE
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_NODE_CHANGES_AFTER
```
protected static final String DOD5015_AUDIT_DATA_NODE_CHANGES_AFTER
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_LOGIN_USERNAME
```
protected static final String DOD5015_AUDIT_DATA_LOGIN_USERNAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_LOGIN_FULLNAME
```
protected static final String DOD5015_AUDIT_DATA_LOGIN_FULLNAME
```
    See Also:
    
    Constant Field Values
  - DOD5015_AUDIT_DATA_LOGIN_ERROR
```
protected static final String DOD5015_AUDIT_DATA_LOGIN_ERROR
```
    See Also:
    
    Constant Field Values
  - AUDIT_TRAIL_FILE_PREFIX
```
protected static final String AUDIT_TRAIL_FILE_PREFIX
```
    See Also:
    
    Constant Field Values
  - AUDIT_TRAIL_JSON_FILE_SUFFIX
```
protected static final String AUDIT_TRAIL_JSON_FILE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - AUDIT_TRAIL_HTML_FILE_SUFFIX
```
protected static final String AUDIT_TRAIL_HTML_FILE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - capabilityService
```
protected CapabilityService capabilityService
```
- Constructor Detail
  - RecordsManagementAuditServiceImpl
```
public RecordsManagementAuditServiceImpl()
```
- Method Detail
  - setPolicyComponent
```
public void setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)
```
    Set the component used to bind to behaviour callbacks
  - setDictionaryService
```
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
```
    Provides user-readable names for types
  - setTransactionService
```
public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)
```
    Set the component used to start new transactions
  - setNodeService
```
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
```
    Sets the NodeService instance
  - setContentService
```
public void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
```
    Sets the ContentService instance
  - setAuditComponent
```
public void setAuditComponent(org.alfresco.repo.audit.AuditComponent auditComponent)
```
    The component to create audit events
  - setAuditService
```
public void setAuditService(org.alfresco.service.cmr.audit.AuditService auditService)
```
    Sets the AuditService instance
  - setRecordsManagementActionService
```
public void setRecordsManagementActionService(RecordsManagementActionService rmActionService)
```
    Sets the RecordsManagementActionService instance
  - setFilePlanService
```
public void setFilePlanService(FilePlanService filePlanService)
```
    Parameters:
    
    filePlanService - file plan service
  - setNamespaceService
```
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
```
    Parameters:
    
    namespaceService - namespace service
  - setCapabilityService
```
public void setCapabilityService(CapabilityService capabilityService)
```
    Parameters:
    
    capabilityService - capability service
  - setIgnoredAuditProperties
```
public void setIgnoredAuditProperties(List<String> ignoredAuditProperties)
```
    Parameters:
    
    ignoredAuditProperties -
  - registerAuditEvent
```
public void registerAuditEvent(String name,
                               String label)
```
    Description copied from interface: RecordsManagementAuditService
    
    Register audit event.
    Creates an instance of a simple audit event and registers it with the service.
    
    Specified by:
    
    registerAuditEvent in interface RecordsManagementAuditService
    
    Parameters:
    
    name - name of audit event
    
    label - display label of audit event
    
    See Also:
    
    RecordsManagementAuditService.registerAuditEvent(java.lang.String, java.lang.String)
  - registerAuditEvent
```
public void registerAuditEvent(AuditEvent auditEvent)
```
    Description copied from interface: RecordsManagementAuditService
    
    Register audit event.
    
    Specified by:
    
    registerAuditEvent in interface RecordsManagementAuditService
    
    Parameters:
    
    auditEvent - audit event
    
    See Also:
    
    RecordsManagementAuditService.registerAuditEvent(org.alfresco.module.org_alfresco_module_rm.audit.event.AuditEvent)
  - init
```
public void init()
```
    Checks that all necessary properties have been set.
  - onBootstrap
```
protected void onBootstrap(org.springframework.context.ApplicationEvent event)
```
    Specified by:
    
    onBootstrap in class org.springframework.extensions.surf.util.AbstractLifecycleBean
    
    See Also:
    
    AbstractLifecycleBean.onBootstrap(org.springframework.context.ApplicationEvent)
  - onShutdown
```
protected void onShutdown(org.springframework.context.ApplicationEvent event)
```
    Specified by:
    
    onShutdown in class org.springframework.extensions.surf.util.AbstractLifecycleBean
    
    See Also:
    
    AbstractLifecycleBean.onShutdown(org.springframework.context.ApplicationEvent)
  - isAuditLogEnabled
```
public boolean isAuditLogEnabled(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Description copied from interface: RecordsManagementAuditService
    
    Determines whether the RM audit log is currently enabled.
    
    Specified by:
    
    isAuditLogEnabled in interface RecordsManagementAuditService
    
    Parameters:
    
    filePlan - file plan
    
    Returns:
    
    true if RM auditing is active false otherwise
    
    See Also:
    
    RecordsManagementAuditService.isAuditLogEnabled(org.alfresco.service.cmr.repository.NodeRef)
  - startAuditLog
```
public void startAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Description copied from interface: RecordsManagementAuditService
    
    Start RM auditing.
    
    Specified by:
    
    startAuditLog in interface RecordsManagementAuditService
    
    Parameters:
    
    filePlan - file plan
    
    See Also:
    
    RecordsManagementAuditService.startAuditLog(org.alfresco.service.cmr.repository.NodeRef)
  - stopAuditLog
```
public void stopAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Description copied from interface: RecordsManagementAuditService
    
    Stop RM auditing.
    
    Specified by:
    
    stopAuditLog in interface RecordsManagementAuditService
    
    Parameters:
    
    filePlan - file plan
    
    See Also:
    
    RecordsManagementAuditService.stopAuditLog(org.alfresco.service.cmr.repository.NodeRef)
  - clearAuditLog
```
public void clearAuditLog(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Description copied from interface: RecordsManagementAuditService
    
    Clears the RM audit.
    
    Specified by:
    
    clearAuditLog in interface RecordsManagementAuditService
    
    Parameters:
    
    filePlan - file plan
    
    See Also:
    
    RecordsManagementAuditService.clearAuditLog(org.alfresco.service.cmr.repository.NodeRef)
  - getDateAuditLogLastStarted
```
public Date getDateAuditLogLastStarted(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Returns the date the RM audit was last started.
    
    Specified by:
    
    getDateAuditLogLastStarted in interface RecordsManagementAuditService
    
    Parameters:
    
    filePlan - file plan
    
    Returns:
    
    Date the audit was last started
  - getDateAuditLogLastStopped
```
public Date getDateAuditLogLastStopped(org.alfresco.service.cmr.repository.NodeRef filePlan)
```
    Description copied from interface: RecordsManagementAuditService
    
    Returns the date the RM audit was last stopped.
    
    Specified by:
    
    getDateAuditLogLastStopped in interface RecordsManagementAuditService
    
    Returns:
    
    Date the audit was last stopped
    
    See Also:
    
    RecordsManagementAuditService.getDateAuditLogLastStopped(org.alfresco.service.cmr.repository.NodeRef)
  - auditEvent
```
public void auditEvent(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       String eventName)
```
    Description copied from interface: RecordsManagementAuditService
    
    Audits an event, assumes no properties where modified and that the event should not be audited immediately.
    
    Specified by:
    
    auditEvent in interface RecordsManagementAuditService
    
    Parameters:
    
    nodeRef - node reference
    
    eventName - event name
    
    See Also:
    
    RecordsManagementAuditService.auditEvent(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
  - auditEvent
```
public 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)
```
    Description copied from interface: RecordsManagementAuditService
    
    Audits an event, assumes that the event should not be audited immediately and not be removed if no property is changed.
    
    Specified by:
    
    auditEvent in interface RecordsManagementAuditService
    
    Parameters:
    
    nodeRef - node reference
    
    eventName - event name
    
    before - property values before event
    
    after - property values after event
    
    See Also:
    
    RecordsManagementAuditService.auditEvent(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map, java.util.Map)
  - auditEvent
```
public 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)
```
    Description copied from interface: RecordsManagementAuditService
    
    Audit event, assumes not to be removed if no property is changed.
    
    Specified by:
    
    auditEvent in interface RecordsManagementAuditService
    
    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
    
    See Also:
    
    RecordsManagementAuditService.auditEvent(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map, java.util.Map, boolean)
  - auditEvent
```
public 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)
```
    Description copied from interface: RecordsManagementAuditService
    
    Audit event.
    
    Specified by:
    
    auditEvent in interface RecordsManagementAuditService
    
    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
    
    See Also:
    
    RecordsManagementAuditService.auditEvent(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map, java.util.Map, boolean)
  - getAuditTrailFile
```
public 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.
    
    Specified by:
    
    getAuditTrailFile in interface RecordsManagementAuditService
    
    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
```
public 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.
    
    Specified by:
    
    getAuditTrail in interface RecordsManagementAuditService
    
    Parameters:
    
    params - Parameters to use to retrieve audit trail (never null)
    
    Returns:
    
    All entries for the audit trail
  - fileAuditTrailAsRecord
```
public 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.
    
    Specified by:
    
    fileAuditTrailAsRecord in interface RecordsManagementAuditService
    
    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
  - getAuditEvents
```
public List<AuditEvent> getAuditEvents()
```
    Retrieves a list of audit events.
    
    Specified by:
    
    getAuditEvents in interface RecordsManagementAuditService
    
    Returns:
    
    List of audit events
  - isEnabled
```
@Deprecated
public boolean isEnabled()
```
    Deprecated.
    
    Specified by:
    
    isEnabled in interface RecordsManagementAuditServiceDeprecated
  - start
```
@Deprecated
public void start()
```
    Deprecated.
  - stop
```
@Deprecated
public void stop()
```
    Deprecated.
    
    Specified by:
    
    stop in interface RecordsManagementAuditServiceDeprecated
  - getDateLastStarted
```
@Deprecated
public Date getDateLastStarted()
```
    Deprecated.
    
    Specified by:
    
    getDateLastStarted in interface RecordsManagementAuditServiceDeprecated
  - getDateLastStopped
```
@Deprecated
public Date getDateLastStopped()
```
    Deprecated.
    
    Specified by:
    
    getDateLastStopped in interface RecordsManagementAuditServiceDeprecated
  - clear
```
@Deprecated
public void clear()
```
    Deprecated.
    
    Specified by:
    
    clear in interface RecordsManagementAuditServiceDeprecated
  - auditRMAction
```
@Deprecated
public void auditRMAction(RecordsManagementAction action,
                                      org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                      Map<String,Serializable> parameters)
```
    Deprecated. since 2.1
    
    Specified by:
    
    auditRMAction in interface RecordsManagementAuditServiceDeprecated
    
    Since:
    
    3.2

Class RecordsManagementAuditServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditService

Field Summary

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

Constructor Summary

Method Summary

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

Methods inherited from class java.lang.Object

Field Detail

RM_AUDIT_EVENT_LOGIN_SUCCESS

RM_AUDIT_EVENT_LOGIN_FAILURE

RM_AUDIT_APPLICATION_NAME

RM_AUDIT_PATH_ROOT

RM_AUDIT_SNIPPET_EVENT

RM_AUDIT_SNIPPET_PERSON

RM_AUDIT_SNIPPET_NAME

RM_AUDIT_SNIPPET_NODE

RM_AUDIT_SNIPPET_CHANGES

RM_AUDIT_SNIPPET_BEFORE

RM_AUDIT_SNIPPET_AFTER

RM_AUDIT_DATA_PERSON_FULLNAME

RM_AUDIT_DATA_PERSON_ROLES

RM_AUDIT_DATA_EVENT_NAME

RM_AUDIT_DATA_NODE_NODEREF

RM_AUDIT_DATA_NODE_NAME

RM_AUDIT_DATA_NODE_TYPE

RM_AUDIT_DATA_NODE_IDENTIFIER

RM_AUDIT_DATA_NODE_NAMEPATH

RM_AUDIT_DATA_NODE_CHANGES_BEFORE

RM_AUDIT_DATA_NODE_CHANGES_AFTER

RM_AUDIT_DATA_LOGIN_USERNAME

RM_AUDIT_DATA_LOGIN_FULLNAME

RM_AUDIT_DATA_LOGIN_ERROR

DOD5015_AUDIT_APPLICATION_NAME

DOD5015_AUDIT_PATH_ROOT

DOD5015_AUDIT_SNIPPET_EVENT

DOD5015_AUDIT_SNIPPET_PERSON

DOD5015_AUDIT_SNIPPET_NAME

DOD5015_AUDIT_SNIPPET_NODE

DOD5015_AUDIT_SNIPPET_CHANGES

DOD5015_AUDIT_SNIPPET_BEFORE

DOD5015_AUDIT_SNIPPET_AFTER

DOD5015_AUDIT_DATA_PERSON_FULLNAME

DOD5015_AUDIT_DATA_PERSON_ROLES

DOD5015_AUDIT_DATA_EVENT_NAME

DOD5015_AUDIT_DATA_NODE_NODEREF

DOD5015_AUDIT_DATA_NODE_NAME

DOD5015_AUDIT_DATA_NODE_TYPE

DOD5015_AUDIT_DATA_NODE_IDENTIFIER

DOD5015_AUDIT_DATA_NODE_NAMEPATH

DOD5015_AUDIT_DATA_NODE_CHANGES_BEFORE

DOD5015_AUDIT_DATA_NODE_CHANGES_AFTER

DOD5015_AUDIT_DATA_LOGIN_USERNAME

DOD5015_AUDIT_DATA_LOGIN_FULLNAME

DOD5015_AUDIT_DATA_LOGIN_ERROR

AUDIT_TRAIL_FILE_PREFIX

AUDIT_TRAIL_JSON_FILE_SUFFIX

AUDIT_TRAIL_HTML_FILE_SUFFIX

capabilityService

Constructor Detail

RecordsManagementAuditServiceImpl

Method Detail

setPolicyComponent

setDictionaryService

setTransactionService

setNodeService

setContentService

setAuditComponent

setAuditService

setRecordsManagementActionService

setFilePlanService

setNamespaceService

setCapabilityService

setIgnoredAuditProperties

registerAuditEvent

registerAuditEvent

init

onBootstrap

onShutdown