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.util;
039:
040: import java.io.IOException;
041:
042: import org.apache.commons.httpclient.HttpState;
043:
044: import com.gargoylesoftware.htmlunit.WebClient;
045: import com.gargoylesoftware.htmlunit.WebConnection;
046: import com.gargoylesoftware.htmlunit.WebRequestSettings;
047: import com.gargoylesoftware.htmlunit.WebResponse;
048:
049: /**
050: * Provides a convenient implementation of the {@link WebConnection} interface that can be subclassed by developers
051: * wishing to adapt a particular WebConnection.
052: * This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped
053: * web connection object.
054: * @version $Revision: 2132 $
055: * @author Marc Guillemot
056: */
057: public class WebConnectionWrapper implements WebConnection {
058: private final WebConnection wrappedWebConnection_;
059:
060: /**
061: * Constructs a WebConnection object wrapping provided WebConnection.
062: * @param webConnection the webConnection that does the real work
063: * @throws IllegalArgumentException if the connection is <code>null</code>
064: */
065: public WebConnectionWrapper(final WebConnection webConnection)
066: throws IllegalArgumentException {
067: if (webConnection == null) {
068: throw new IllegalArgumentException(
069: "Wrapped connection can't be null");
070: }
071: wrappedWebConnection_ = webConnection;
072: }
073:
074: /**
075: * Constructs a WebConnection object wrapping the connection of the WebClient and places itself as
076: * connection of the WebClient.
077: * @param webClient the WebClient which WebConnection should be wrapped
078: * @throws IllegalArgumentException if the WebClient is <code>null</code>
079: */
080: public WebConnectionWrapper(final WebClient webClient)
081: throws IllegalArgumentException {
082: if (webClient == null) {
083: throw new IllegalArgumentException(
084: "WebClient can't be null");
085: }
086: wrappedWebConnection_ = webClient.getWebConnection();
087: webClient.setWebConnection(this );
088: }
089:
090: /**
091: * {@inheritDoc}
092: * The default behavior of this method is to return getResponse() on the wrapped connection object.
093: */
094: public WebResponse getResponse(
095: final WebRequestSettings webRequestSettings)
096: throws IOException {
097: return wrappedWebConnection_.getResponse(webRequestSettings);
098: }
099:
100: /**
101: * {@inheritDoc}
102: * The default behavior of this method is to return getState() on the wrapped connection object.
103: */
104: public HttpState getState() {
105: return wrappedWebConnection_.getState();
106: }
107:
108: /**
109: * {@inheritDoc}
110: * The default behavior of this method is to return getWebClient() on the wrapped connection object.
111: */
112: public WebClient getWebClient() {
113: return wrappedWebConnection_.getWebClient();
114: }
115:
116: }
|