001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit;
039:
040: import java.io.IOException;
041: import java.io.InputStream;
042: import java.net.URL;
043: import java.util.List;
044:
045: /**
046: * A response from a web server
047: *
048: * @version $Revision: 2132 $
049: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
050: * @author Noboru Sinohara
051: * @author Marc Guillemot
052: */
053: public interface WebResponse {
054: /**
055: * Return the status code that was returned by the server
056: *
057: * @return See above.
058: */
059: int getStatusCode();
060:
061: /**
062: * Return the status message that was returned from the server
063: *
064: * @return See above
065: */
066: String getStatusMessage();
067:
068: /**
069: * Return the content type returned from the server. Ie "text/html"
070: *
071: * @return See above
072: */
073: String getContentType();
074:
075: /**
076: * Return the content from the server as a string
077: *
078: * @return See above
079: */
080: String getContentAsString();
081:
082: /**
083: * Return the content from the server as an input stream
084: *
085: * @return See above
086: * @exception IOException If an IO problem occurs
087: */
088: InputStream getContentAsStream() throws IOException;
089:
090: /**
091: * Return the URL that was used to load this page.
092: *
093: * @return The originating URL
094: */
095: URL getUrl();
096:
097: /**
098: * Return the method used for the request resulting into this response.
099: * @return the method
100: */
101: SubmitMethod getRequestMethod();
102:
103: /**
104: * Return the response headers as a List of {@link org.apache.commons.httpclient.NameValuePair}s.
105: *
106: * @return a List of {@link org.apache.commons.httpclient.NameValuePair}s.
107: */
108: List getResponseHeaders();
109:
110: /**
111: * Return the value of the specified header from this response.
112: *
113: * @param headerName The name of the header
114: * @return The value of the specified header
115: */
116: String getResponseHeaderValue(final String headerName);
117:
118: /**
119: * Return the time it took to load this web response in milliseconds.
120: * @return The load time.
121: */
122: long getLoadTimeInMilliSeconds();
123:
124: /**
125: * Return the content charset value.
126: * @return The charset value.
127: */
128: String getContentCharSet();
129:
130: /**
131: * Return the response body as byte array.
132: * @return response body.
133: */
134: byte[] getResponseBody();
135: }
|