/* * @(#)RoResponse.java 0.3-3 06/05/2001 * * This file is part of the HTTPClient package * Copyright (C) 1996-2001 Ronald Tschalär * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free * Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307, USA * * For questions, suggestions, bug-reports, enhancement-requests etc. * I may be contacted at: * * ronald@innovation.ch * * The HTTPClient's home page is located at: * * http://www.innovation.ch/java/HTTPClient/ * */ package HTTPClient; import java.io.InputStream; import java.io.IOException; import java.util.Date; /** * This interface represents read-only interface of an intermediate http * response. It is the compile-time type passed to various handlers which * might the response info but musn't modify the response. * * @version 0.3-3 06/05/2001 * @author Ronald Tschalär */ public interface RoResponse { /** * give the status code for this request. These are grouped as follows: * * * @return the status code * @exception IOException If any exception occurs on the socket. */ public int getStatusCode() throws IOException; /** * @return the reason line associated with the status code. * @exception IOException If any exception occurs on the socket. */ public String getReasonLine() throws IOException; /** * @return the HTTP version returned by the server. * @exception IOException If any exception occurs on the socket. */ public String getVersion() throws IOException; /** * retrieves the field for a given header. * * @param hdr the header name. * @return the value for the header, or null if non-existent. * @exception IOException If any exception occurs on the socket. */ public String getHeader(String hdr) throws IOException; /** * retrieves the field for a given header. The value is parsed as an * int. * * @param hdr the header name. * @return the value for the header if the header exists * @exception NumberFormatException if the header's value is not a number * or if the header does not exist. * @exception IOException if any exception occurs on the socket. */ public int getHeaderAsInt(String hdr) throws IOException, NumberFormatException; /** * retrieves the field for a given header. The value is parsed as a * date; if this fails it is parsed as a long representing the number * of seconds since 12:00 AM, Jan 1st, 1970. If this also fails an * IllegalArgumentException is thrown. * * @param hdr the header name. * @return the value for the header, or null if non-existent. * @exception IOException If any exception occurs on the socket. * @exception IllegalArgumentException If the header cannot be parsed * as a date or time. */ public Date getHeaderAsDate(String hdr) throws IOException, IllegalArgumentException; /** * Retrieves the field for a given trailer. Note that this should not * be invoked until all the response data has been read. If invoked * before, it will force the data to be read via getData(). * * @param trailer the trailer name. * @return the value for the trailer, or null if non-existent. * @exception IOException If any exception occurs on the socket. */ public String getTrailer(String trailer) throws IOException; /** * Retrieves the field for a given tailer. The value is parsed as an * int. * * @param trailer the tailer name. * @return the value for the trailer if the trailer exists * @exception NumberFormatException if the trailer's value is not a number * or if the trailer does not exist. * @exception IOException if any exception occurs on the socket. */ public int getTrailerAsInt(String trailer) throws IOException, NumberFormatException; /** * Retrieves the field for a given trailer. The value is parsed as a * date; if this fails it is parsed as a long representing the number * of seconds since 12:00 AM, Jan 1st, 1970. If this also fails an * IllegalArgumentException is thrown. *
Note: When sending dates use Util.httpDate(). * * @param trailer the trailer name. * @return the value for the trailer, or null if non-existent. * @exception IllegalArgumentException if the trailer's value is neither a * legal date nor a number. * @exception IOException if any exception occurs on the socket. * @exception IllegalArgumentException If the header cannot be parsed * as a date or time. */ public Date getTrailerAsDate(String trailer) throws IOException, IllegalArgumentException; /** * Reads all the response data into a byte array. Note that this method * won't return until all the data has been received (so for * instance don't invoke this method if the server is doing a server * push). If getInputStream() had been previously called then this method * only returns any unread data remaining on the stream and then closes * it. * * @see #getInputStream() * @return an array containing the data (body) returned. If no data * was returned then it's set to a zero-length array. * @exception IOException If any io exception occured while reading * the data */ public byte[] getData() throws IOException; /** * Gets an input stream from which the returned data can be read. Note * that if getData() had been previously called it will actually return * a ByteArrayInputStream created from that data. * * @see #getData() * @return the InputStream. * @exception IOException If any exception occurs on the socket. */ public InputStream getInputStream() throws IOException; }