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.sql;
021
022import java.util.Calendar;
023
024import org.nuxeo.ecm.core.api.repository.FulltextConfiguration;
025
026/**
027 * @author Florent Guillaume
028 */
029public interface RepositoryManagement {
030
031    /**
032     * Gets the repository name.
033     */
034    String getName();
035
036    /**
037     * Gets the number of active sessions.
038     */
039    int getActiveSessionsCount();
040
041    /**
042     * Evaluate number of elements in all caches
043     *
044     * @since 5.7.2
045     */
046    long getCacheSize();
047
048    /**
049     * Evaluate number of elements in hier cache
050     *
051     * @since 5.7.2
052     */
053    long getCachePristineSize();
054
055    /**
056     * Evaluate number of elements in selection cache
057     *
058     * @since 5.7.2
059     */
060    long getCacheSelectionSize();
061
062    /**
063     * Clears all the caches.
064     *
065     * @return an indicative count of objects removed
066     */
067    int clearCaches();
068
069    /**
070     * Makes sure that the next transaction will process cluster invalidations.
071     */
072    void processClusterInvalidationsNext();
073
074    /**
075     * Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
076     */
077    void markReferencedBinaries();
078
079    /**
080     * Cleans up (hard-deletes) any documents that have been soft-deleted in the database.
081     *
082     * @param max the maximum number of documents to delete at a time
083     * @param beforeTime the maximum deletion time of the documents to delete
084     * @return the number of documents deleted
085     */
086    int cleanupDeletedDocuments(int max, Calendar beforeTime);
087
088    /**
089     * Gets the fulltext configuration.
090     *
091     * @since 10.3
092     */
093    FulltextConfiguration getFulltextConfiguration();
094
095}