001/*
002 * #%L
003 * Netarchivesuite - harvester
004 * %%
005 * Copyright (C) 2005 - 2018 The Royal Danish 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.harvester.indexserver;
024
025import java.util.Set;
026
027import dk.netarkivet.common.distribute.indexserver.RequestType;
028
029/**
030 * An interface for all IndexRequestServer implementations.
031 */
032public interface IndexRequestServerInterface {
033
034    /**
035     * Define a FileBasedCache class to handle the given type of requests.
036     *
037     * @param type a given request type
038     * @param cache the FileBasedCache class to handle this request type
039     */
040    void setHandler(RequestType type, FileBasedCache<Set<Long>> cache);
041
042    /**
043     * The operation to the start the IndexRequestServer.
044     */
045    void start();
046
047    /**
048     * The operation to the close the IndexRequestServer. This closes all resources associated with the
049     * IndexRequestServer and shuts down the server.
050     */
051    void close();
052
053}