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
022/**
023 * Encapsulates cluster node DBS invalidations management.
024 * <p>
025 * There is one cluster invalidator per cluster node (repository).
026 *
027 * @since 8.10
028 */
029public interface DBSClusterInvalidator {
030
031    /**
032     * Initializes the cluster invalidator.
033     *
034     * @param nodeId the cluster node id
035     * @param repositoryName the repository name
036     */
037    void initialize(String nodeId, String repositoryName);
038
039    /**
040     * Closes this cluster invalidator and releases resources.
041     */
042    void close();
043
044    /**
045     * Receives invalidations from other cluster nodes.
046     */
047    DBSInvalidations receiveInvalidations();
048
049    /**
050     * Sends invalidations to other cluster nodes.
051     */
052    void sendInvalidations(DBSInvalidations invalidations);
053
054}