001/*
002 * #%L
003 * Netarchivesuite - common
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023package dk.netarkivet.common.distribute.arcrepository;
024
025import java.io.File;
026
027import dk.netarkivet.common.exceptions.ArgumentNotValid;
028import dk.netarkivet.common.exceptions.IOFailure;
029
030/**
031 * Implements the Facade pattern to shield off the methods in JMSArcRepositoryClient not to be used by the harvest
032 * system.
033 */
034public interface HarvesterArcRepositoryClient {
035
036    /**
037     * Call on shutdown to release external resources.
038     */
039    void close();
040
041    /**
042     * Store the given file in the ArcRepository. After storing, the file is deleted.
043     *
044     * @param file A file to be stored. Must exist.
045     * @throws IOFailure thrown if store is unsuccesful, or failed to clean up files after the store operation.
046     * @throws ArgumentNotValid if file parameter is null or file is not an existing file.
047     */
048    void store(File file) throws IOFailure, ArgumentNotValid;
049
050}