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.net.MalformedURLException;
041: import java.net.URL;
042: import java.util.ArrayList;
043: import java.util.List;
044:
045: import org.apache.commons.httpclient.HttpStatus;
046: import org.apache.commons.httpclient.NameValuePair;
047:
048: /**
049: * A simple WebResponse created from a string. Content is assumed to be
050: * of type text/html.
051: *
052: * @version $Revision: 2132 $
053: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
054: * @author Marc Guillemot
055: * @author Brad Clarke
056: * @author Ahmed Ashour
057: */
058: public class StringWebResponse extends WebResponseImpl {
059:
060: private static final long serialVersionUID = 8001886227379566491L;
061:
062: /**
063: * Helper method for constructors. Converts the passed string into
064: * WebResponseData with other defaults specified.
065: *
066: * @param contentString String to be converted to WebResponseData
067: * @return A simple WebResponseData with defaults specified
068: */
069: private static WebResponseData getWebResponseData(
070: final String contentString, final String charset) {
071: final byte[] content = TextUtil.stringToByteArray(
072: contentString, charset);
073: final List compiledHeaders = new ArrayList();
074: compiledHeaders.add(new NameValuePair("Content-Type",
075: "text/html"));
076: return new WebResponseData(content, HttpStatus.SC_OK, "OK",
077: compiledHeaders);
078: }
079:
080: /**
081: * Helper method for constructors. Gets the default URL that is used
082: * if none is specified. Mostly exists to deal with the checked exception
083: * on the URL constructor.
084: *
085: * @return The default URL
086: */
087: private static URL getURL() {
088: try {
089: return new URL("http://HtmlUnitStringWebResponse");
090: } catch (final MalformedURLException e) {
091: // Theoretically impossible
092: throw new IllegalStateException(e.toString());
093: }
094: }
095:
096: /**
097: * Create an instance.
098: * @param content The content to return.
099: */
100: public StringWebResponse(final String content) {
101: super (getWebResponseData(content, TextUtil.DEFAULT_CHARSET),
102: getURL(), SubmitMethod.GET, 0);
103: }
104:
105: /**
106: * Create an instance.
107: * @param content The content to return.
108: * @param charset The charset used to convert the content.
109: */
110: public StringWebResponse(final String content, final String charset) {
111: super (getWebResponseData(content, charset), charset, getURL(),
112: SubmitMethod.GET, 0);
113: }
114:
115: /**
116: * Create an instance associated with an originating URL
117: * @param content The content to return.
118: * @param originatingURL The url that this should be associated with
119: */
120: public StringWebResponse(final String content,
121: final URL originatingURL) {
122: super (getWebResponseData(content, TextUtil.DEFAULT_CHARSET),
123: originatingURL, SubmitMethod.GET, 0);
124: }
125:
126: /**
127: * Create an instance associated with an originating URL
128: * @param content The content to return.
129: * @param charset The charset used to convert the content.
130: * @param originatingURL The url that this should be associated with
131: */
132: public StringWebResponse(final String content,
133: final String charset, final URL originatingURL) {
134: super (getWebResponseData(content, charset), charset,
135: originatingURL, SubmitMethod.GET, 0);
136: }
137: }
|