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:

Serializable, BaseNuxeoWebService, WSAudit

public class WSAuditBean
extends AbstractNuxeoWebService
implements WSAudit

Audit Web Service bean.

Author:

Julien Anguenot, Thierry Delprat

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEPRECATION_DONE

Constructor Summary

Constructors

Constructor and Description
WSAuditBean()

Method Summary

Modifier and Type	Method and Description
protected Logs	getLogsBean()
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)
protected static void	logDeprecation()
EventDescriptorPage	queryEventsByPage(String sessionId, String whereClause, int page, int pageSize)

Methods inherited from class org.nuxeo.ecm.platform.ws.AbstractNuxeoWebService

connect, connectOnRepository, disconnect, getSessionsManager, initSession, login

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

connect, disconnect

Field Detail

DEPRECATION_DONE

protected static boolean DEPRECATION_DONE

Constructor Detail

WSAuditBean

public WSAuditBean()

Method Detail

logDeprecation

protected static void logDeprecation()

getLogsBean

protected final Logs getLogsBean()

listModifiedDocuments

public ModifiedDocumentDescriptor[] listModifiedDocuments(String sessionId,
                                                          String dateRangeQuery)

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.

listModifiedDocumentsByPage

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

Specified by:

listModifiedDocumentsByPage in interface WSAudit

listDeletedDocumentsByPage

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

Description copied from interface: WSAudit

Returns the list of deleted documents within a timestamp.

Specified by:

listDeletedDocumentsByPage in interface WSAudit

listEventsByPage

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

Specified by:

listEventsByPage in interface WSAudit

listDocumentEventsByPage

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

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..

queryEventsByPage

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

Specified by:

queryEventsByPage in interface WSAudit