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    void initialize(RepositoryImpl repository);
034
035    /**
036     * Initializes the {@link ModelSetup}. Called once lazily at repository initialization.
037     */
038    void initializeModelSetup(ModelSetup modelSetup);
039
040    /**
041     * Initializes what's needed after the {@link Model} has been created. Called once lazily at repository
042     * initialization.
043     */
044    void initializeModel(Model model);
045
046    /**
047     * Sets the cluster invalidator, to be used by future mappers created.
048     *
049     * @since 7.4
050     */
051    void setClusterInvalidator(ClusterInvalidator clusterInvalidator);
052
053    /**
054     * Creates a new instance a {@link Mapper}. Called once for every new session.
055     *
056     * @param model the model
057     * @param pathResolver the path resolver
058     * @param useInvalidations whether this mapper participates in invalidation propagation
059     */
060    Mapper newMapper(Model model, PathResolver pathResolver, boolean useInvalidations);
061
062    /**
063     * Shuts down the backend.
064     */
065    void shutdown();
066
067}