com.gargoylesoftware.htmlunit.MockWebConnection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-client-compiler-deps Show documentation
Show all versions of vaadin-client-compiler-deps Show documentation
Vaadin is a web application framework for Rich Internet Applications (RIA).
Vaadin enables easy development and maintenance of fast and
secure rich web
applications with a stunning look and feel and a wide browser support.
It features a server-side architecture with the majority of the logic
running
on the server. Ajax technology is used at the browser-side to ensure a
rich
and interactive user experience.
/*
* Copyright (c) 2002-2011 Gargoyle Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gargoylesoftware.htmlunit;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.gargoylesoftware.htmlunit.util.NameValuePair;
/**
* A fake {@link WebConnection} designed to mock out the actual HTTP connections.
*
* @version $Revision: 6204 $
* @author Mike Bowler
* @author Noboru Sinohara
* @author Marc Guillemot
* @author Brad Clarke
* @author Ahmed Ashour
*/
public class MockWebConnection implements WebConnection {
private static final Log LOG = LogFactory.getLog(MockWebConnection.class);
private final Map responseMap_ = new HashMap(10);
private WebResponseData defaultResponse_;
private WebRequest lastRequest_;
private int requestCount_ = 0;
private final List requestedUrls_ = Collections.synchronizedList(new ArrayList());
/**
* {@inheritDoc}
*/
public WebResponse getResponse(final WebRequest request) throws IOException {
final URL url = request.getUrl();
if (LOG.isDebugEnabled()) {
LOG.debug("Getting response for " + url.toExternalForm());
}
lastRequest_ = request;
requestCount_++;
requestedUrls_.add(url);
WebResponseData response = responseMap_.get(url.toExternalForm());
if (response == null) {
response = defaultResponse_;
if (response == null) {
throw new IllegalStateException("No response specified that can handle URL ["
+ url.toExternalForm()
+ "]");
}
}
return new WebResponse(response, request, 0);
}
/**
* Gets the list of requested URLs relative to the provided URL.
* @param relativeTo what should be removed from the requested URLs.
* @return the list of relative URLs
*/
public List getRequestedUrls(final URL relativeTo) {
final String baseUrl = relativeTo.toString();
final List response = new ArrayList();
for (final URL url : requestedUrls_) {
String s = url.toString();
if (s.startsWith(baseUrl)) {
s = s.substring(baseUrl.length());
}
response.add(s);
}
return response;
}
/**
* Returns the method that was used in the last call to submitRequest().
*
* @return the method that was used in the last call to submitRequest()
*/
public HttpMethod getLastMethod() {
return lastRequest_.getHttpMethod();
}
/**
* Returns the parameters that were used in the last call to submitRequest().
*
* @return the parameters that were used in the last call to submitRequest()
*/
public List getLastParameters() {
return lastRequest_.getRequestParameters();
}
/**
* Sets the response that will be returned when the specified URL is requested.
* @param url the URL that will return the given response
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
* @param responseHeaders the response headers to return
*/
public void setResponse(final URL url, final String content, final int statusCode,
final String statusMessage, final String contentType,
final List< ? extends NameValuePair> responseHeaders) {
setResponse(
url,
TextUtil.stringToByteArray(content),
statusCode,
statusMessage,
contentType,
responseHeaders);
}
/**
* Sets the response that will be returned when the specified URL is requested.
* @param url the URL that will return the given response
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
* @param charset the name of a supported charset
* @param responseHeaders the response headers to return
*/
public void setResponse(final URL url, final String content, final int statusCode,
final String statusMessage, final String contentType, final String charset,
final List< ? extends NameValuePair> responseHeaders) {
setResponse(
url,
TextUtil.stringToByteArray(content, charset),
statusCode,
statusMessage,
contentType,
responseHeaders);
}
/**
* Sets the response that will be returned when the specified URL is requested.
* @param url the URL that will return the given response
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
* @param responseHeaders the response headers to return
*/
public void setResponse(final URL url, final byte[] content, final int statusCode,
final String statusMessage, final String contentType,
final List< ? extends NameValuePair> responseHeaders) {
final List compiledHeaders = new ArrayList(responseHeaders);
if (contentType != null) {
compiledHeaders.add(new NameValuePair("Content-Type", contentType));
}
final WebResponseData responseEntry = buildWebResponseData(content, statusCode, statusMessage, compiledHeaders);
responseMap_.put(url.toExternalForm(), responseEntry);
}
private WebResponseData buildWebResponseData(final byte[] content, final int statusCode, final String statusMessage,
final List compiledHeaders) {
try {
return new WebResponseData(content, statusCode, statusMessage, compiledHeaders);
}
catch (final IOException e) {
throw new RuntimeException(e);
}
}
/**
* Convenient method that is the same as calling
* {@link #setResponse(URL,String,int,String,String,List)} with a status
* of "200 OK", a content type of "text/html" and no additional headers.
*
* @param url the URL that will return the given response
* @param content the content to return
*/
public void setResponse(final URL url, final String content) {
final List< ? extends NameValuePair> emptyList = Collections.emptyList();
setResponse(url, content, 200, "OK", "text/html", emptyList);
}
/**
* Convenient method that is the same as calling
* {@link #setResponse(URL,String,int,String,String,List)} with a status
* of "200 OK" and no additional headers.
*
* @param url the URL that will return the given response
* @param content the content to return
* @param contentType the content type to return
*/
public void setResponse(final URL url, final String content, final String contentType) {
final List< ? extends NameValuePair> emptyList = Collections.emptyList();
setResponse(url, content, 200, "OK", contentType, emptyList);
}
/**
* Convenient method that is the same as calling
* {@link #setResponse(URL,String,int,String,String,String,List)} with a status
* of "200 OK" and no additional headers.
*
* @param url the URL that will return the given response
* @param content the content to return
* @param contentType the content type to return
* @param charset the name of a supported charset
*/
public void setResponse(final URL url, final String content, final String contentType, final String charset) {
final List< ? extends NameValuePair> emptyList = Collections.emptyList();
setResponse(url, content, 200, "OK", contentType, charset, emptyList);
}
/**
* Specify a generic HTML page that will be returned when the given URL is specified.
* The page will contain only minimal HTML to satisfy the HTML parser but will contain
* the specified title so that tests can check for titleText.
*
* @param url the URL that will return the given response
* @param title the title of the page
*/
public void setResponseAsGenericHtml(final URL url, final String title) {
final String content = "" + title + " ";
setResponse(url, content);
}
/**
* Sets the response that will be returned when a URL is requested that does
* not have a specific content set for it.
*
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
*/
public void setDefaultResponse(final String content, final int statusCode,
final String statusMessage, final String contentType) {
setDefaultResponse(TextUtil.stringToByteArray(content), statusCode, statusMessage, contentType);
}
/**
* Sets the response that will be returned when a URL is requested that does
* not have a specific content set for it.
*
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
*/
public void setDefaultResponse(final byte[] content, final int statusCode,
final String statusMessage, final String contentType) {
final List compiledHeaders = new ArrayList();
if (contentType != null) {
compiledHeaders.add(new NameValuePair("Content-Type", contentType));
}
final WebResponseData responseEntry = buildWebResponseData(content, statusCode, statusMessage, compiledHeaders);
defaultResponse_ = responseEntry;
}
/**
* Sets the response that will be returned when a URL is requested that does
* not have a specific content set for it.
*
* @param content the content to return
*/
public void setDefaultResponse(final String content) {
setDefaultResponse(content, 200, "OK", "text/html");
}
/**
* Sets the response that will be returned when a URL is requested that does
* not have a specific content set for it.
*
* @param content the content to return
* @param contentType the content type to return
*/
public void setDefaultResponse(final String content, final String contentType) {
final List< ? extends NameValuePair> emptyList = Collections.emptyList();
setDefaultResponse(content, 200, "OK", contentType, emptyList);
}
/**
* Sets the response that will be returned when a URL is requested that does
* not have a specific content set for it.
*
* @param content the content to return
* @param contentType the content type to return
* @param charset the name of a supported charset
*/
public void setDefaultResponse(final String content, final String contentType, final String charset) {
final List< ? extends NameValuePair> emptyList = Collections.emptyList();
setDefaultResponse(content, 200, "OK", contentType, charset, emptyList);
}
/**
* Sets the response that will be returned when the specified URL is requested.
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
* @param responseHeaders the response headers to return
*/
public void setDefaultResponse(final String content, final int statusCode,
final String statusMessage, final String contentType,
final List< ? extends NameValuePair> responseHeaders) {
final List compiledHeaders = new ArrayList(responseHeaders);
if (contentType != null) {
compiledHeaders.add(new NameValuePair("Content-Type", contentType));
}
defaultResponse_ = buildWebResponseData(TextUtil.stringToByteArray(content),
statusCode, statusMessage, compiledHeaders);
}
/**
* Sets the response that will be returned when the specified URL is requested.
* @param content the content to return
* @param statusCode the status code to return
* @param statusMessage the status message to return
* @param contentType the content type to return
* @param charset the name of a supported charset
* @param responseHeaders the response headers to return
*/
public void setDefaultResponse(final String content, final int statusCode,
final String statusMessage, final String contentType, final String charset,
final List< ? extends NameValuePair> responseHeaders) {
final List compiledHeaders = new ArrayList(responseHeaders);
compiledHeaders.add(new NameValuePair("Content-Type", contentType));
defaultResponse_ = buildWebResponseData(TextUtil.stringToByteArray(content, charset),
statusCode, statusMessage, compiledHeaders);
}
/**
* Returns the additional headers that were used in the in the last call
* to {@link #getResponse(WebRequest)}.
* @return the additional headers that were used in the in the last call
* to {@link #getResponse(WebRequest)}
*/
public Map getLastAdditionalHeaders() {
return lastRequest_.getAdditionalHeaders();
}
/**
* Returns the {@link WebRequest} that was used in the in the last call
* to {@link #getResponse(WebRequest)}.
* @return the {@link WebRequest} that was used in the in the last call
* to {@link #getResponse(WebRequest)}
* @deprecated as of 2.8, please use {@link #getLastWebRequest()} instead
*/
@Deprecated
public WebRequest getLastWebRequestSettings() {
return lastRequest_;
}
/**
* Returns the {@link WebRequest} that was used in the in the last call
* to {@link #getResponse(WebRequest)}.
* @return the {@link WebRequest} that was used in the in the last call
* to {@link #getResponse(WebRequest)}
*/
public WebRequest getLastWebRequest() {
return lastRequest_;
}
/**
* Returns the number of requests made to this mock web connection.
* @return the number of requests made to this mock web connection
*/
public int getRequestCount() {
return requestCount_;
}
/**
* Indicates if a response has already been configured for this URL.
* @param url the url
* @return false if no response has been configured
*/
public boolean hasResponse(final URL url) {
return responseMap_.containsKey(url.toExternalForm());
}
}