001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (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 *     Florent Guillaume
018 */
019
020package org.nuxeo.ecm.core.storage.dbs;
021
022import org.nuxeo.ecm.core.model.Repository;
023
024/**
025 * Encapsulates cluster node DBS invalidations management.
026 * <p>
027 * There is one cluster invalidator per cluster node (repository).
028 *
029 * @since 8.10
030 */
031public interface DBSClusterInvalidator {
032
033    /**
034     * Initializes the cluster invalidator.
035     *
036     * @param nodeId the cluster node id
037     * @param repository the repository
038     */
039    void initialize(String nodeId, Repository repository);
040
041    /**
042     * Closes this cluster invalidator and releases resources.
043     */
044    void close();
045
046    /**
047     * Receives invalidations from other cluster nodes.
048     */
049    DBSInvalidations receiveInvalidations();
050
051    /**
052     * Sends invalidations to other cluster nodes.
053     */
054    void sendInvalidations(DBSInvalidations invalidations);
055
056}