001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.kernel.api.services;
019
020import java.io.File;
021import java.util.Collection;
022
023import javax.jcr.Session;
024
025/**
026 * @author bbpennel
027 * @since Feb 20, 2014
028 */
029public interface RepositoryService {
030
031    /**
032     * Calculate the total size of all the binary properties in the repository
033     *
034     * @return size in bytes
035     */
036    Long getRepositorySize();
037
038    /**
039     * Calculate the number of objects in the repository
040     *
041     * @return number of objects in the repository
042     */
043    Long getRepositoryObjectCount();
044
045    /**
046     * This method backups up a running repository
047     *
048     * @param session the session
049     * @param backupDirectory the backup directory
050     * @return problems
051     */
052    Collection<Throwable> backupRepository(Session session, File backupDirectory);
053
054    /**
055     * This methods restores the repository from a backup
056     *
057     * @param session the session
058     * @param backupDirectory the backup directory
059     * @return problems
060     */
061    Collection<Throwable> restoreRepository(Session session, File backupDirectory);
062
063}