001/*
002 * (C) Copyright 2006-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 *     Thierry Delprat
018 */
019package org.nuxeo.ecm.platform.audit.service;
020
021import org.nuxeo.ecm.platform.audit.api.AuditStorage;
022import org.nuxeo.ecm.platform.audit.api.Logs;
023
024/**
025 * Audit Backend SPI
026 *
027 * @author tiry
028 */
029public interface AuditBackend extends Logs {
030
031    int getApplicationStartedOrder();
032
033    void onApplicationStarted();
034
035    /**
036     * @since 9.2 with default backward compatibility by delegating to deprecated API {@link #onShutdown()}
037     */
038    default void onApplicationStopped() {
039        onShutdown();
040    }
041
042    /**
043     * @deprecated since 9.2 replaced with {@link #onApplicationStopped()}
044     */
045    @Deprecated
046    default void onShutdown() {
047        throw new UnsupportedOperationException("deprecated API, should not be invoked");
048    }
049
050    /**
051     * Restore the backend from the given {@link AuditStorage}
052     *
053     * @param auditStorage the audit storage
054     * @param batchSize the batch size
055     * @param keepAlive the keep alive duration
056     * @since 9.3
057     */
058    void restore(AuditStorage auditStorage, int batchSize, int keepAlive);
059
060}