001/*
002 * (C) Copyright 2017 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Funsho David
018 *
019 */
020
021package org.nuxeo.ecm.platform.audit.api;
022
023import java.util.List;
024
025import org.nuxeo.ecm.core.api.ScrollResult;
026import org.nuxeo.ecm.core.query.sql.model.QueryBuilder;
027
028/**
029 * Audit storage interface to append and scroll {@link LogEntry} represented as JSON. The {@link LogEntry} has to be
030 * serialized to JSON with {@link BuiltinLogEntryData} field names.
031 *
032 * @since 9.3
033 */
034public interface AuditStorage {
035
036    void append(List<String> jsonEntries);
037
038    ScrollResult<String> scroll(QueryBuilder queryBuilder, int batchSize, int keepAliveSeconds);
039
040    ScrollResult<String> scroll(String scrollId);
041
042}