org.nuxeo.ecm.platform.audit.ws.api

Interface WSAudit

All Superinterfaces:

BaseNuxeoWebService, Serializable

All Known Subinterfaces:

WSExalead, WSIndexingGateway

All Known Implementing Classes:

WSAuditBean, WSExaleadBean, WSIndexingGatewayBean

public interface WSAudit
extends BaseNuxeoWebService

Audit Web service interface.

Author:

Julien Anguenot, Thierry Delprat

Method Summary

Modifier and Type	Method and Description
ModifiedDocumentDescriptorPage	listDeletedDocumentsByPage(String sessionId, String dateRangeQuery, String path, int page, int pageSize) Returns the list of deleted documents within a timestamp.
EventDescriptorPage	listDocumentEventsByPage(String sessionId, String dateRangeQuery, String startDate, String path, int page, int pageSize) Gets a filtered list of document events.
EventDescriptorPage	listEventsByPage(String sessionId, String dateRangeQuery, int page, int pageSize)
ModifiedDocumentDescriptor[]	listModifiedDocuments(String sessionId, String dateRangeQuery) Returns the list of modified document within a timestamp.
ModifiedDocumentDescriptorPage	listModifiedDocumentsByPage(String sessionId, String dateRangeQuery, String path, int page, int pageSize)
EventDescriptorPage	queryEventsByPage(String sessionId, String whereClause, int page, int pageSize)

Methods inherited from interface org.nuxeo.ecm.platform.api.ws.BaseNuxeoWebService

connect, disconnect

Method Detail

listModifiedDocuments

ModifiedDocumentDescriptor[] listModifiedDocuments(String sessionId,
                                                   String dateRangeQuery)

Returns the list of modified document within a timestamp.

Parameters:

sessionId - the Nuxeo core session id.

dateRangeQuery - the date range query.

Returns:

a list of modified document descriptors.

Throws:

AuditException

listModifiedDocumentsByPage

ModifiedDocumentDescriptorPage listModifiedDocumentsByPage(String sessionId,
                                                           String dateRangeQuery,
                                                           String path,
                                                           int page,
                                                           int pageSize)

listDeletedDocumentsByPage

ModifiedDocumentDescriptorPage listDeletedDocumentsByPage(String sessionId,
                                                          String dateRangeQuery,
                                                          String path,
                                                          int page,
                                                          int pageSize)

Returns the list of deleted documents within a timestamp.

listEventsByPage

EventDescriptorPage listEventsByPage(String sessionId,
                                     String dateRangeQuery,
                                     int page,
                                     int pageSize)

listDocumentEventsByPage

EventDescriptorPage listDocumentEventsByPage(String sessionId,
                                             String dateRangeQuery,
                                             String startDate,
                                             String path,
                                             int page,
                                             int pageSize)

Gets a filtered list of document events.

Expecting either a dateRangeQuery or a startDate.

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

EventDescriptorPage queryEventsByPage(String sessionId,
                                      String whereClause,
                                      int page,
                                      int pageSize)