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.indexserver; 024 025import java.util.Set; 026 027/** 028 * An interface to a cache of data for jobs. 029 */ 030public interface JobIndexCache { 031 032 /** 033 * Get an index for the given list of job IDs. The resulting file contains a suitably sorted list. This method 034 * should always be safe for asynchronous calling. This method may use a cached version of the file. 035 * 036 * @param jobIDs Set of job IDs to generate index for. 037 * @return An index, consisting of a file and the set this is an index for. This file must not be modified or 038 * deleted, since it is part of the cache of data. 039 */ 040 Index<Set<Long>> getIndex(Set<Long> jobIDs); 041 042 /** 043 * Request an index from the indexserver. Prepare the index but don't give it to me. 044 * 045 * @param jobSet Set of job IDs to generate index for. 046 * @param harvestId Harvestdefinition associated with this set of jobs 047 */ 048 void requestIndex(Set<Long> jobSet, Long harvestId); 049 050}