001/*
002 * #%L
003 * Netarchivesuite - harvester
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 */
023
024package dk.netarkivet.harvester.indexserver;
025
026import java.io.File;
027import java.util.Map;
028import java.util.Set;
029
030/**
031 * An interface for getting raw data out of the bitarchives based on job IDs.
032 */
033public interface RawDataCache {
034
035    /**
036     * Cache the raw data associated with the given ID as a file, or null if we could not find any such data. The data
037     * can be found in the file specified by getCacheFile(ID), if this call is successfull.
038     *
039     * @param id The job ID to look for data for.
040     * @return The data found, or null on failure.
041     */
042    Long cache(Long id);
043
044    /**
045     * Get the raw data files for a set of job IDs. This is commonly a convenience wrapper around cache(Long) and
046     * getCacheFile(Long), but may reduce overhead.
047     *
048     * @param ids Set of job IDs to get data for.
049     * @return Map of ID to file containing data for that ID, or to null if data could not be found.
050     */
051    Map<Long, File> get(Set<Long> ids);
052
053}