|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuditService
The public API by which applications can query the audit logs and enable or disable auditing.
Nested Class Summary | |
---|---|
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. |
Method Summary | |
---|---|
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(java.util.List auditEntryIds)
Delete a discrete list of audit entries. |
int |
clearAudit(java.lang.String applicationName)
Deprecated. Use AuditService.clearAudit(String, Long, Long) |
int |
clearAudit(java.lang.String applicationName,
java.lang.Long fromTime,
java.lang.Long toTime)
Remove audit entries for the given application between the time ranges. |
void |
disableAudit(java.lang.String applicationName,
java.lang.String path)
Disable auditing for an application path |
void |
enableAudit(java.lang.String applicationName,
java.lang.String path)
Enable auditing for an application path |
java.util.Map |
getAuditApplications()
Get all registered audit applications |
boolean |
isAuditEnabled()
|
boolean |
isAuditEnabled(java.lang.String applicationName,
java.lang.String path)
|
void |
setAuditEnabled(boolean enable)
Enable or disable the global auditing state |
Method Detail |
---|
boolean isAuditEnabled()
void setAuditEnabled(boolean enable)
enable
- true to enable auditing globally or false to disablejava.util.Map getAuditApplications()
boolean isAuditEnabled(java.lang.String applicationName, java.lang.String path)
applicationName
- the name of the application to checkpath
- the path to check
void enableAudit(java.lang.String applicationName, java.lang.String path)
applicationName
- the name of the application to checkpath
- the path to enablevoid disableAudit(java.lang.String applicationName, java.lang.String path)
applicationName
- the name of the application to checkpath
- the path to disableint clearAudit(java.lang.String applicationName)
AuditService.clearAudit(String, Long, Long)
applicationName
- the name of the application for which to remove entries
int clearAudit(java.lang.String applicationName, java.lang.Long fromTime, java.lang.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(java.util.List auditEntryIds)
query results
.
auditEntryIds
- the IDs of all audit entries to delete
void 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 (zero or negative to ignore)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |