|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.Object audit(org.aopalliance.intercept.MethodInvocation methodInvocation) throws java.lang.Throwable
java.lang.Throwable
void audit(java.lang.String source, java.lang.String description, NodeRef key, java.lang.Object[] args)
source
- -
a string that represents the applicationdescription
- -
the audit entry *key
- -
a node ref to use as the key for filtering etcargs
- -
an arbitrary list of parametersvoid beforeMethodCallManualAudit(java.lang.Class clazz, java.lang.Object target, java.lang.String method, java.lang.Object[] args)
java.util.List getAuditTrail(NodeRef nodeRef)
nodeRef
- -
the node ref for which we want the audit trail
boolean isAuditEnabled()
true
, if audit is enabledboolean isSourcePathMapped(java.lang.String sourcePath)
true
if the given source path is mapped to one or more audit applicationsvoid deleteAuditEntries(java.lang.String applicationName, java.lang.Long fromTime, java.lang.Long toTime)
applicationName
- the name of the application being logged tofromTime
- the start time of entries to remove (inclusive and optional)toTime
- the end time of entries to remove (exclusive and optional)boolean isAuditPathEnabled(java.lang.String applicationName, java.lang.String path)
applicationName
- the name of the application being logged topath
- the audit path to check
void enableAudit(java.lang.String applicationName, java.lang.String path)
#audit(String, String, Map)
) and
not the path that the generated data may contain - although this would be similarly
enabled.
If the enabled
applicationName
- the name of the application being logged topath
- the audit path to enable auditing onvoid disableAudit(java.lang.String applicationName, java.lang.String path)
#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.
applicationName
- the name of the application being logged topath
- the audit path to enable auditing onvoid resetDisabledPaths(java.lang.String applicationName)
enabling
or
disabling
.
applicationName
- the name of the applicationjava.util.Map recordAuditValues(java.lang.String rootPath, java.util.Map values)
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.
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)
java.lang.IllegalStateException
- if there is not a writable transaction presentvoid auditQuery(AuditService.AuditQueryCallback callback, AuditQueryParameters parameters, int maxResults)
callback
- the data callback per entryparameters
- the parameters for the query (may not be null)maxResults
- the maximum number of results to retrieve (zero or negative to ignore)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |