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 */
019package org.nuxeo.ecm.core.storage.sql;
020
021import org.nuxeo.ecm.core.storage.sql.Session.PathResolver;
022
023/**
024 * Interface for the backend-specific initialization code of a {@link Repository}.
025 *
026 * @see RepositoryImpl
027 */
028public interface RepositoryBackend {
029
030    /**
031     * Initializer.
032     */
033    Model initialize(RepositoryImpl repository);
034
035    /**
036     * Sets the cluster invalidator, to be used by future mappers created.
037     *
038     * @since 7.4
039     */
040    void setClusterInvalidator(ClusterInvalidator clusterInvalidator);
041
042    /**
043     * Creates a new instance a {@link Mapper}. Called once for every new session.
044     *
045     * @param pathResolver the path resolver
046     * @param useInvalidations whether this mapper participates in invalidation propagation
047     */
048    Mapper newMapper(PathResolver pathResolver, boolean useInvalidations);
049
050    /**
051     * Shuts down the backend.
052     */
053    void shutdown();
054
055}