org.alfresco.repo.audit
Interface AuditComponent

All Known Implementing Classes:
AuditComponentImpl

public interface AuditComponent

The audit component. Used by the AuditService and AuditMethodInterceptor to insert audit entries.

The V3.2 audit functionality is contained within the same component. When the newer audit implementation has been tested and approved, then older ones will be deprecated as necessary.


Method Summary
 java.lang.Object audit(org.aopalliance.intercept.MethodInvocation methodInvocation)
          Audit entry point for method interceptors.
 void audit(java.lang.String source, java.lang.String description, NodeRef key, java.lang.Object[] args)
           
 void auditQuery(AuditService.AuditQueryCallback callback, AuditQueryParameters parameters, int maxResults)
          Find audit entries using the given parameters
 void beforeMethodCallManualAudit(java.lang.Class clazz, java.lang.Object target, java.lang.String method, java.lang.Object[] args)
          Add an audit entry - without invoking the method invocation.
 void deleteAuditEntries(java.lang.String applicationName, java.lang.Long fromTime, java.lang.Long toTime)
          Delete audit entries for the given application and time range
 void disableAudit(java.lang.String applicationName, java.lang.String path)
          Disable auditing (if it is not already disabled) for all paths that contain the given path.
 void enableAudit(java.lang.String applicationName, java.lang.String path)
          Enable auditing (if it is not already enabled) for all paths that contain the given path.
 java.util.List getAuditTrail(NodeRef nodeRef)
          Get the audit trail for a node.
 boolean isAuditEnabled()
          Determines whether audit is globally enabled or disabled.
 boolean isAuditPathEnabled(java.lang.String applicationName, java.lang.String path)
          Check if an audit path is enabled.
 boolean isSourcePathMapped(java.lang.String sourcePath)
          Determines whether the given source path is mapped to any audit applications.
 java.util.Map recordAuditValues(java.lang.String rootPath, java.util.Map values)
          Create an audit entry for the given map of values.
 void resetDisabledPaths(java.lang.String applicationName)
          Remove all disabled paths i.e.
 

Method Detail

audit

java.lang.Object audit(org.aopalliance.intercept.MethodInvocation methodInvocation)
                       throws java.lang.Throwable
Audit entry point for method interceptors.

Returns:
- the return onbject from the normal invocation of the audited method.
Throws:
java.lang.Throwable
Since:
2.1

audit

void audit(java.lang.String source,
           java.lang.String description,
           NodeRef key,
           java.lang.Object[] args)
Parameters:
source - - a string that represents the application
description - - the audit entry *
key - - a node ref to use as the key for filtering etc
args - - an arbitrary list of parameters
Since:
2.1

beforeMethodCallManualAudit

void beforeMethodCallManualAudit(java.lang.Class clazz,
                                 java.lang.Object target,
                                 java.lang.String method,
                                 java.lang.Object[] args)
Add an audit entry - without invoking the method invocation. Only the method arguments can be audited.

Since:
3.2

getAuditTrail

java.util.List getAuditTrail(NodeRef nodeRef)
Get the audit trail for a node.

Parameters:
nodeRef - - the node ref for which we want the audit trail
Returns:
- a list of AuditInfo objects that represent the audit trail for the given node reference.
Since:
2.1

isAuditEnabled

boolean isAuditEnabled()
Determines whether audit is globally enabled or disabled.

Returns:
true, if audit is enabled

isSourcePathMapped

boolean isSourcePathMapped(java.lang.String sourcePath)
Determines whether the given source path is mapped to any audit applications. Allows optimizations to be made in calling components.

Returns:
true if the given source path is mapped to one or more audit applications
Since:
3.3

deleteAuditEntries

void deleteAuditEntries(java.lang.String applicationName,
                        java.lang.Long fromTime,
                        java.lang.Long toTime)
Delete audit entries for the given application and time range

Parameters:
applicationName - the name of the application being logged to
fromTime - the start time of entries to remove (inclusive and optional)
toTime - the end time of entries to remove (exclusive and optional)
Since:
3.2

isAuditPathEnabled

boolean isAuditPathEnabled(java.lang.String applicationName,
                           java.lang.String path)
Check if an audit path is enabled. The path will be disabled if it or any higher path has been explicitly disabled. Any disabled path will not be processed when data is audited.

Parameters:
applicationName - the name of the application being logged to
path - the audit path to check
Returns:
Returns true if the audit path has been disabled
Since:
3.2

enableAudit

void enableAudit(java.lang.String applicationName,
                 java.lang.String path)
Enable auditing (if it is not already enabled) for all paths that contain the given path. The path is the path as originally logged (see #audit(String, String, Map)) and not the path that the generated data may contain - although this would be similarly enabled.

If the enabled

Parameters:
applicationName - the name of the application being logged to
path - the audit path to enable auditing on
Since:
3.2

disableAudit

void disableAudit(java.lang.String applicationName,
                  java.lang.String path)
Disable auditing (if it is not already disabled) for all paths that contain the given path. The path is the path as originally logged (see #audit(String, String, Map)) and not the path that the generated data may contain - although this would be similarly disabled.

If the path is /x/y then any data paths that start with /x/y will be stripped out before data generators and data recorders are applied. If the path represents the root path of the application, then auditing for that application is effectively disabled.

Parameters:
applicationName - the name of the application being logged to
path - the audit path to enable auditing on
Since:
3.2

resetDisabledPaths

void resetDisabledPaths(java.lang.String applicationName)
Remove all disabled paths i.e. enable all per-path based auditing. Auditing may still be disabled globally. This is primarily for test purposes; applications should know which paths need enabling or disabling.

Parameters:
applicationName - the name of the application
Since:
3.2

recordAuditValues

java.util.Map recordAuditValues(java.lang.String rootPath,
                                java.util.Map values)
Create an audit entry for the given map of values. The map key is a path - starting with '/' (AuditApplication.AUDIT_PATH_SEPARATOR) - relative to the root path provided. The root path and value keys are combined to produce a map of data keyed by full path. This fully-pathed map is then passed through the audit path mapper. The result may yield data destined for several different audit applications. depending on the data extraction and generation defined in the applications, values (or derived values) may be recorded against several audit entries (one per application represented).

The return values reflect what was actually persisted and is controlled by the data extractors defined in the audit configuration.

A new read-write transaction is started if there are values to write that there is not a viable transaction present.

Parameters:
rootPath - a base path of AuditPath key entries concatenated with the path separator '/' (AuditApplication.AUDIT_PATH_SEPARATOR)
values - the values to audit mapped by AuditPath key relative to root path (may be null)
Returns:
Returns the values that were actually persisted, keyed by their full path.
Throws:
java.lang.IllegalStateException - if there is not a writable transaction present
Since:
3.2

auditQuery

void auditQuery(AuditService.AuditQueryCallback callback,
                AuditQueryParameters parameters,
                int maxResults)
Find audit entries using the given parameters

Parameters:
callback - the data callback per entry
parameters - the parameters for the query (may not be null)
maxResults - the maximum number of results to retrieve (zero or negative to ignore)
Since:
3.2


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.