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