WSAudit.java

/*
 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     anguenot
 *
 * $Id: WSAudit.java 28230 2007-12-18 15:21:51Z rdarlea $
 */

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

import javax.jws.WebParam;

import org.nuxeo.ecm.platform.api.ws.BaseNuxeoWebService;
import org.nuxeo.ecm.platform.audit.ws.EventDescriptorPage;
import org.nuxeo.ecm.platform.audit.ws.ModifiedDocumentDescriptor;
import org.nuxeo.ecm.platform.audit.ws.ModifiedDocumentDescriptorPage;

/**
 * Audit Web service interface.
 *
 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
 * @author <a href="mailto:td@nuxeo.com">Thierry Delprat</a>
 */
public interface WSAudit extends BaseNuxeoWebService {

    /**
     * Returns the list of modified document within a timestamp.
     *
     * @param sessionId the Nuxeo core session id.
     * @param dateRangeQuery the date range query.
     * @return a list of modified document descriptors.
     * @throws AuditException
     */
    ModifiedDocumentDescriptor[] listModifiedDocuments(String sessionId, String dateRangeQuery);

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

    /**
     * Returns the list of deleted documents within a timestamp.
     */
    ModifiedDocumentDescriptorPage listDeletedDocumentsByPage(@WebParam(name = "sessionId") String sessionId,
            @WebParam(name = "dataRangeQuery") String dateRangeQuery, @WebParam(name = "docPath") String path,
            @WebParam(name = "pageIndex") int page, @WebParam(name = "pageSize") int pageSize);

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

    /**
     * Gets a filtered list of document events.
     * <p>
     * Expecting either a dateRangeQuery or a startDate.
     *
     * @param sessionId the Nuxeo core session id.
     * @param dateRangeQuery the date range query like "24h" for the last 24 hours, may be <code>null</code> if
     *            startDate is set.
     * @param startDate return events that occurs after startDate, expecting W3C date time format. May be
     *            <code>null</code> if dateRangeQuery is set. Will be ignored if dateRangeQuery is set.
     * @param path filter events for documents starting with this path.
     * @param page page number starting with page 1.
     * @param pageSize number of items in a page.
     * @return a list of events descriptors..
     * @throws AuditException
     */
    EventDescriptorPage listDocumentEventsByPage(String sessionId, String dateRangeQuery, String startDate,
            String path, int page, int pageSize);

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

}