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     * Evaluate number of elements in all caches
038     *
039     * @since 5.7.2
040     */
041    long getCacheSize();
042
043    /**
044     * Evaluate number of elements in hier cache
045     *
046     * @since 5.7.2
047     */
048    long getCachePristineSize();
049
050    /**
051     * Evaluate number of elements in selection cache
052     *
053     * @since 5.7.2
054     */
055    long getCacheSelectionSize();
056
057    /**
058     * Clears all the caches.
059     *
060     * @return an indicative count of objects removed
061     */
062    int clearCaches();
063
064    /**
065     * Makes sure that the next transaction will process cluster invalidations.
066     */
067    void processClusterInvalidationsNext();
068
069    /**
070     * Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
071     */
072    void markReferencedBinaries();
073
074    /**
075     * Cleans up (hard-deletes) any documents that have been soft-deleted in the database.
076     *
077     * @param max the maximum number of documents to delete at a time
078     * @param beforeTime the maximum deletion time of the documents to delete
079     * @return the number of documents deleted
080     */
081    int cleanupDeletedDocuments(int max, Calendar beforeTime);
082
083    /**
084     * Gets the fulltext configuration.
085     *
086     * @since 10.3
087     */
088    FulltextConfiguration getFulltextConfiguration();
089
090}