|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicService public interface AuditService
The public API by which applications can create audit entries. This does not affect auditing using method interceptors. The information recorded can not be confused between the two. This API could be used by an audit action.
Nested Class Summary | |
---|---|
static interface |
AuditService.AuditQueryCallback
The interface that will be used to give query results to the calling code. |
Method Summary | |
---|---|
void |
audit(java.lang.String source,
java.lang.String description)
Add an application audit entry. |
void |
audit(java.lang.String source,
java.lang.String description,
NodeRef key)
|
void |
audit(java.lang.String source,
java.lang.String description,
NodeRef key,
java.lang.Object[] args)
|
void |
audit(java.lang.String source,
java.lang.String description,
java.lang.Object[] args)
|
void |
auditQuery(AuditService.AuditQueryCallback callback,
AuditQueryParameters parameters,
int maxResults)
Issue an audit query using the given parameters and consuming results in the callback. |
void |
auditQuery(AuditService.AuditQueryCallback callback,
boolean forward,
java.lang.String applicationName,
java.lang.String user,
java.lang.Long from,
java.lang.Long to,
int maxResults)
Deprecated. Use #auditQuery(AuditQueryCallback, AuditQueryParameters) |
void |
auditQuery(AuditService.AuditQueryCallback callback,
boolean forward,
java.lang.String applicationName,
java.lang.String user,
java.lang.Long from,
java.lang.Long to,
java.lang.String searchKey,
java.io.Serializable searchValue,
int maxResults)
Deprecated. Use #auditQuery(AuditQueryCallback, AuditQueryParameters) |
void |
clearAudit(java.lang.String applicationName)
Remove all audit entries for the given application |
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.List |
getAuditTrail(NodeRef nodeRef)
Get the audit trail for a node ref. |
boolean |
isAuditEnabled(java.lang.String applicationName,
java.lang.String path)
|
Method Detail |
---|
@NotAuditable void audit(java.lang.String source, java.lang.String description)
source
- -
a string that represents the applicationdescription
- -
the audit entry@NotAuditable void audit(java.lang.String source, java.lang.String description, NodeRef key)
source
- -
a string that represents the applicationdescription
- -
the audit entrykey
- -
a node ref to use as the key for filtering etc@NotAuditable void audit(java.lang.String source, java.lang.String description, java.lang.Object[] args)
source
- -
a string that represents the applicationdescription
- -
the audit entryargs
- -
an arbitrary list of parameters@NotAuditable 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 parameters@NotAuditable java.util.List getAuditTrail(NodeRef nodeRef)
nodeRef
- - the node ref for which to get the audit trail.
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 disablevoid clearAudit(java.lang.String applicationName)
applicationName
- the name of the application for which to remove entriesvoid 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)void auditQuery(AuditService.AuditQueryCallback callback, boolean forward, java.lang.String applicationName, java.lang.String user, java.lang.Long from, java.lang.Long to, int maxResults)
#auditQuery(AuditQueryCallback, AuditQueryParameters)
callback
- the callback that will handle resultsforward
- true for results to ordered from first to last,
or false to order from last to firstapplicationName
- if not null, find entries logged against this applicationuser
- if not null, find entries logged against this userfrom
- the start search time (null to start at the beginning)to
- the end search time (null for no limit)maxResults
- the maximum number of results to retrieve (zero or negative to ignore)void auditQuery(AuditService.AuditQueryCallback callback, boolean forward, java.lang.String applicationName, java.lang.String user, java.lang.Long from, java.lang.Long to, java.lang.String searchKey, java.io.Serializable searchValue, int maxResults)
#auditQuery(AuditQueryCallback, AuditQueryParameters)
callback
- the callback that will handle resultsforward
- true for results to ordered from first to last,
or false to order from last to firstapplicationName
- if not null, find entries logged against this applicationuser
- if not null, find entries logged against this userfrom
- the start search time (null to start at the beginning)to
- the end search time (null for no limit)searchKey
- the audit key path that must exist (null to ignore)searchValue
- an audit value that must exist (null to ignore)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 |