public interface AuditService
Modifier and Type | Interface and Description |
---|---|
static class |
AuditService.AuditApplication
Helper bean to carry information about an audit application.
|
static interface |
AuditService.AuditQueryCallback
The interface that will be used to give query results to the calling code.
|
Modifier and Type | Method and Description |
---|---|
void |
auditQuery(AuditService.AuditQueryCallback callback,
AuditQueryParameters parameters,
int maxResults)
Issue an audit query using the given parameters and consuming results in the callback.
|
int |
clearAudit(List<Long> auditEntryIds)
Delete a discrete list of audit entries.
|
int |
clearAudit(String applicationName)
Deprecated.
|
int |
clearAudit(String applicationName,
Long fromTime,
Long toTime)
Remove audit entries for the given application between the time ranges.
|
void |
disableAudit(String applicationName,
String path)
Disable auditing for an application path
|
void |
enableAudit(String applicationName,
String path)
Enable auditing for an application path
|
Map<String,AuditService.AuditApplication> |
getAuditApplications()
Get all registered audit applications
|
boolean |
isAuditEnabled() |
boolean |
isAuditEnabled(String applicationName,
String path) |
void |
setAuditEnabled(boolean enable)
Enable or disable the global auditing state
|
boolean isAuditEnabled()
void setAuditEnabled(boolean enable)
enable
- true to enable auditing globally or false to disableMap<String,AuditService.AuditApplication> getAuditApplications()
boolean isAuditEnabled(String applicationName, String path)
applicationName
- the name of the application to checkpath
- the path to checkvoid enableAudit(String applicationName, String path)
applicationName
- the name of the application to checkpath
- the path to enablevoid disableAudit(String applicationName, String path)
applicationName
- the name of the application to checkpath
- the path to disableint clearAudit(String applicationName)
clearAudit(String, Long, Long)
applicationName
- the name of the application for which to remove entriesint clearAudit(String applicationName, Long fromTime, Long toTime)
applicationName
- the name of the application for which to remove entriesfromTime
- the start time of entries to remove (inclusive and optional)toTime
- the end time of entries to remove (exclusive and optional)int clearAudit(List<Long> auditEntryIds)
query results
.auditEntryIds
- the IDs of all audit entries to deletevoid auditQuery(AuditService.AuditQueryCallback callback, AuditQueryParameters parameters, int maxResults)
callback
- the callback that will handle resultsparameters
- 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.