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.viewerproxy;
025
026/**
027 * Interface for all classes that may resolve requests and update response with result.
028 */
029public interface URIResolver {
030    /** Not HTTP response code used for unresolvable URI, i.e. not in archive. */
031    int NOT_FOUND = -1;
032
033    /**
034     * Do a lookup on a request and update response with the result.
035     *
036     * @param request The request to look up.
037     * @param response The response to optionally update.
038     * @return The HTTP response of this value, or NOT_FOUND for URLs that cannot be resolved. If HTTP response is
039     * returned it should ALWAYS be the same code as the code set in the response object. if NOT_FOUND is returned, the
040     * response object should contain a proper error page.
041     */
042    int lookup(Request request, Response response);
043}