01: /*
02: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * 1. Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: * 2. Redistributions in binary form must reproduce the above copyright notice,
10: * this list of conditions and the following disclaimer in the documentation
11: * and/or other materials provided with the distribution.
12: * 3. The end-user documentation included with the redistribution, if any, must
13: * include the following acknowledgment:
14: *
15: * "This product includes software developed by Gargoyle Software Inc.
16: * (http://www.GargoyleSoftware.com/)."
17: *
18: * Alternately, this acknowledgment may appear in the software itself, if
19: * and wherever such third-party acknowledgments normally appear.
20: * 4. The name "Gargoyle Software" must not be used to endorse or promote
21: * products derived from this software without prior written permission.
22: * For written permission, please contact info@GargoyleSoftware.com.
23: * 5. Products derived from this software may not be called "HtmlUnit", nor may
24: * "HtmlUnit" appear in their name, without prior written permission of
25: * Gargoyle Software Inc.
26: *
27: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37: */
38: package com.gargoylesoftware.htmlunit;
39:
40: import java.io.IOException;
41:
42: import org.apache.commons.httpclient.HttpState;
43:
44: /**
45: * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br/>
46: *
47: * An object that handles the actual communication portion of page
48: * retrieval/submission.
49: *
50: * @version $Revision: 2132 $
51: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
52: * @author Daniel Gredler
53: * @author Marc Guillemot
54: */
55: public interface WebConnection {
56: /**
57: * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br/>
58: *
59: * Submits a request and retrieves a response.
60: * @param webRequestSettings Settings to make the request with.
61: * @return The response to the request defined by the specified request settings.
62: * @exception IOException If an IO error occurs.
63: */
64: WebResponse getResponse(final WebRequestSettings webRequestSettings)
65: throws IOException;
66:
67: /**
68: * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br/>
69: *
70: * Return the web client.
71: * @return The web client.
72: */
73: WebClient getWebClient();
74:
75: /**
76: * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br/>
77: *
78: * Return the {@link HttpState} that is being used.
79: * @return the state.
80: */
81: HttpState getState();
82:
83: }
|