org.nuxeo.ecm.platform.audit.ws
Class WSAuditBean
java.lang.Object
org.nuxeo.ecm.platform.ws.AbstractNuxeoWebService
org.nuxeo.ecm.platform.audit.ws.WSAuditBean
- All Implemented Interfaces:
- java.io.Serializable, BaseNuxeoWebService, WSAudit, WSAuditLocal
public class WSAuditBean
- extends AbstractNuxeoWebService
- implements WSAuditLocal
Audit Web Service bean.
- Author:
- Julien Anguenot, Thierry Delprat
- See Also:
- Serialized Form
Method Summary |
ModifiedDocumentDescriptorPage |
listDeletedDocumentsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String path,
int page,
int pageSize)
Returns the list of deleted documents within a timestamp. |
EventDescriptorPage |
listDocumentEventsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String startDate,
java.lang.String path,
int page,
int pageSize)
Gets a filtered list of document events. |
EventDescriptorPage |
listEventsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
int page,
int pageSize)
|
ModifiedDocumentDescriptor[] |
listModifiedDocuments(java.lang.String sessionId,
java.lang.String dateRangeQuery)
Returns the list of modified document within a timestamp. |
ModifiedDocumentDescriptorPage |
listModifiedDocumentsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String path,
int page,
int pageSize)
|
EventDescriptorPage |
queryEventsByPage(java.lang.String sessionId,
java.lang.String whereClause,
int page,
int pageSize)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
WSAuditBean
public WSAuditBean()
listModifiedDocuments
public ModifiedDocumentDescriptor[] listModifiedDocuments(java.lang.String sessionId,
java.lang.String dateRangeQuery)
throws AuditException
- Description copied from interface:
WSAudit
- Returns the list of modified document within a timestamp.
- Specified by:
listModifiedDocuments
in interface WSAudit
- Parameters:
sessionId
- the Nuxeo core session id.dateRangeQuery
- the date range query.
- Returns:
- a list of modified document descriptors.
- Throws:
AuditException
listModifiedDocumentsByPage
public ModifiedDocumentDescriptorPage listModifiedDocumentsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String path,
int page,
int pageSize)
throws AuditException
- Specified by:
listModifiedDocumentsByPage
in interface WSAudit
- Throws:
AuditException
listDeletedDocumentsByPage
public ModifiedDocumentDescriptorPage listDeletedDocumentsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String path,
int page,
int pageSize)
throws AuditException
- Description copied from interface:
WSAudit
- Returns the list of deleted documents within a timestamp.
- Specified by:
listDeletedDocumentsByPage
in interface WSAudit
- Throws:
AuditException
listEventsByPage
public EventDescriptorPage listEventsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
int page,
int pageSize)
throws AuditException
- Specified by:
listEventsByPage
in interface WSAudit
- Throws:
AuditException
listDocumentEventsByPage
public EventDescriptorPage listDocumentEventsByPage(java.lang.String sessionId,
java.lang.String dateRangeQuery,
java.lang.String startDate,
java.lang.String path,
int page,
int pageSize)
throws AuditException
- Description copied from interface:
WSAudit
- Gets a filtered list of document events.
Expecting either a dateRangeQuery or a startDate.
- Specified by:
listDocumentEventsByPage
in interface WSAudit
- Parameters:
sessionId
- the Nuxeo core session id.dateRangeQuery
- the date range query like "24h" for the last 24 hours,
may be null
if startDate is set.startDate
- return events that occurs after startDate, expecting W3C date
time format. May be null
if dateRangeQuery is set.
Will be ignored if dateRangeQuery is set.path
- filter events for documents starting with this path.page
- page number starting with page 1.pageSize
- number of items in a page.
- Returns:
- a list of events descriptors..
- Throws:
AuditException
queryEventsByPage
public EventDescriptorPage queryEventsByPage(java.lang.String sessionId,
java.lang.String whereClause,
int page,
int pageSize)
throws AuditException
- Specified by:
queryEventsByPage
in interface WSAudit
- Throws:
AuditException
Copyright © 2010 Nuxeo SAS. All Rights Reserved.