public interface AuditComponent
Modifier and Type | Method and Description |
---|---|
boolean |
areAuditValuesRequired()
Determine whether the audit infrastructure expects audit values to be passed in.
|
boolean |
areAuditValuesRequired(String path)
Determines if audit values are required based on whether there are any audit applications
registered to record data for the given path.
|
void |
auditQuery(AuditService.AuditQueryCallback callback,
AuditQueryParameters parameters,
int maxResults)
Find audit entries using the given parameters
|
int |
deleteAuditEntries(List<Long> auditEntryIds)
Delete a discrete list of audit entries based on ID
|
int |
deleteAuditEntries(String applicationName,
Long fromTime,
Long toTime)
Delete audit entries for the given application and time range
|
void |
disableAudit(String applicationName,
String path)
Disable auditing (if it is not already disabled) for all paths that contain the given path.
|
void |
enableAudit(String applicationName,
String path)
Enable auditing (if it is not already enabled) for all paths that contain the given path.
|
Map<String,AuditApplication> |
getAuditApplications()
Get all registered audit applications, whether active or not.
|
boolean |
isAuditEnabled()
Determines whether audit is globally enabled or disabled.
|
boolean |
isAuditPathEnabled(String applicationName,
String path)
Check if an audit path is enabled.
|
Map<String,Serializable> |
recordAuditValues(String rootPath,
Map<String,Serializable> values)
Create an audit entry for the given map of values.
|
Map<String,Serializable> |
recordAuditValuesWithUserFilter(String rootPath,
Map<String,Serializable> values,
boolean useUserFilter)
The same as
recordAuditValues(String, Map) , but with controlled usage of userFilter |
void |
resetDisabledPaths(String applicationName)
Remove all disabled paths i.e.
|
void |
setAuditEnabled(boolean enable)
Switch auditing on or off
|
void |
setUserAuditFilter(UserAuditFilter userAuditFilter) |
boolean isAuditEnabled()
true
if audit is enabledvoid setAuditEnabled(boolean enable)
enable
- true to enable auditing or false to disablevoid setUserAuditFilter(UserAuditFilter userAuditFilter)
userAuditFilter
- UserAuditFilterMap<String,AuditApplication> getAuditApplications()
boolean areAuditValuesRequired()
true
if the calling code (data producers)
should go ahead and generate the data for
recording
.boolean areAuditValuesRequired(String path)
path
- the audit pathint deleteAuditEntries(String applicationName, Long fromTime, 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)int deleteAuditEntries(List<Long> auditEntryIds)
auditEntryIds
- the audit entry IDs to deleteboolean isAuditPathEnabled(String applicationName, String path)
applicationName
- the name of the application being logged topath
- the audit path to check or null to assume the
application's root pathvoid enableAudit(String applicationName, String path)
If the enabled
applicationName
- the name of the application being logged topath
- the audit path to check or null to assume the
application's root pathvoid disableAudit(String applicationName, String path)
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 check or null to assume the
application's root pathvoid resetDisabledPaths(String applicationName)
enabling
or
disabled
.applicationName
- the name of the applicationMap<String,Serializable> recordAuditValues(String rootPath, Map<String,Serializable> 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)IllegalStateException
- if the transaction state could not be determinedMap<String,Serializable> recordAuditValuesWithUserFilter(String rootPath, Map<String,Serializable> values, boolean useUserFilter)
recordAuditValues(String, Map)
, but with controlled usage of userFilterrootPath
- 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)useUserFilter
- if false the user filter is disabled.IllegalStateException
- if the transaction state could not be determinedvoid 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 (must be greater than 0)IllegalArgumentException
- if maxResults less or equal to zeroCopyright © 2005–2017 Alfresco Software. All rights reserved.