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 */
023package dk.netarkivet.viewerproxy;
024
025import java.io.OutputStream;
026
027/**
028 * The Response interface is a very minimal version of a HTTP response. We use this to decouple the main parts of the
029 * proxy server from a given implementation.
030 */
031public interface Response {
032
033    /**
034     * Return outputstream response should be written to.
035     *
036     * @return the outputstream response should be written to
037     */
038    OutputStream getOutputStream();
039
040    /**
041     * Set status code.
042     *
043     * @param statusCode should be valid http status ie. 200, 404,
044     */
045    void setStatus(int statusCode);
046
047    /**
048     * Set status code. and explanatory text string describing the status.
049     *
050     * @param statusCode should be valid http status ie. 200, 404,
051     * @param reason text string explaining status ie. OK, not found,
052     */
053    void setStatus(int statusCode, String reason);
054
055    /**
056     * Add an HTTP header to the response.
057     *
058     * @param name Name of the header, e.g. Last-Modified-Date
059     * @param value The value of the header
060     */
061    void addHeaderField(String name, String value);
062
063    /**
064     * Get the status code from this response.
065     *
066     * @return The statuscode.
067     */
068    int getStatus();
069
070}