com.gargoylesoftware.htmlunit
Class WebRequestSettings

java.lang.Object
  com.gargoylesoftware.htmlunit.WebRequestSettings

public class WebRequestSettings
extends Object

Parameter object for making web requests.

Version:

$Revision: 2132 $

Author:

Brad Clarke, Hans Donner, Ahmed Ashour

Constructor Summary

WebRequestSettings(URL target)

WebRequestSettings(URL target, SubmitMethod submitMethod)

WebRequestSettings(WebRequestSettings originalRequest, URL target)
Instantiate a WebRequestSettings for the given url using the proxy configuration from the original request

Method Summary

void	addAdditionalHeader(String name, String value) Adds the specified name/value pair to the additional headers.
Map	getAdditionalHeaders()
String	getCharset() Gets the charset to use to perform the request
String	getCookiePolicy() Gets the cookie policy to use to perform the request.
CredentialsProvider	getCredentialsProvider()
FormEncodingType	getEncodingType()
String	getProxyHost()
int	getProxyPort()
String	getRequestBody() Returns the body content to be submitted if this is a POST request.
List	getRequestParameters()
SubmitMethod	getSubmitMethod()
URL	getURL()
void	setAdditionalHeaders(Map additionalHeaders)
void	setCharset(String charset) Sets the charset.
void	setCookiePolicy(String cookiePolicy) Deprecated.
void	setCredentialsProvider(CredentialsProvider credentialsProvider)
void	setEncodingType(FormEncodingType encodingType)
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setRequestBody(String requestBody)
void	setRequestParameters(List requestParameters)
void	setSubmitMethod(SubmitMethod submitMethod)
void	setURL(URL url)
String	toString() Return a string representation of this object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebRequestSettings

public WebRequestSettings(URL target)

Parameters:

target - The URL for this request

WebRequestSettings

public WebRequestSettings(WebRequestSettings originalRequest,
                          URL target)

Instantiate a WebRequestSettings for the given url using the proxy configuration from the original request

Parameters:

originalRequest - the original request

target - The URL for this request

WebRequestSettings

public WebRequestSettings(URL target,
                          SubmitMethod submitMethod)

Parameters:

target - The URL for this request

submitMethod - The submitMethod to set.

Method Detail

getURL

public URL getURL()

Returns:

the URL

setURL

public void setURL(URL url)

Parameters:

url - The new URL

getProxyHost

public String getProxyHost()

Returns:

The proxy host.

setProxyHost

public void setProxyHost(String proxyHost)

Parameters:

proxyHost - The new proxy host.

getProxyPort

public int getProxyPort()

Returns:

The proxy port.

setProxyPort

public void setProxyPort(int proxyPort)

Parameters:

proxyPort - The new proxy port.

getEncodingType

public FormEncodingType getEncodingType()

Returns:

Returns the encodingType.

setEncodingType

public void setEncodingType(FormEncodingType encodingType)

Parameters:

encodingType - The encodingType to set.

getRequestParameters

public List getRequestParameters()

Returns:

Returns the requestParameters.

setRequestParameters

public void setRequestParameters(List requestParameters)
                          throws RuntimeException

Parameters:

requestParameters - The requestParameters to set.

Throws:

RuntimeException - If the request body has already been set.

getRequestBody

public String getRequestBody()

Returns the body content to be submitted if this is a POST request. Ignored for all other request types. Should not be used in combination with parameters.

Returns:

The body content to be submitted if this is a POST request.

setRequestBody

public void setRequestBody(String requestBody)
                    throws RuntimeException

Parameters:

requestBody - The body content to be submitted if this is a POST request.

Throws:

RuntimeException - If the request parameters have already been set or this is not a POST request.

getSubmitMethod

public SubmitMethod getSubmitMethod()

Returns:

Returns the submitMethod.

setSubmitMethod

public void setSubmitMethod(SubmitMethod submitMethod)

Parameters:

submitMethod - The submitMethod to set.

getAdditionalHeaders

public Map getAdditionalHeaders()

Returns:

Returns the additionalHeaders.

setAdditionalHeaders

public void setAdditionalHeaders(Map additionalHeaders)

Parameters:

additionalHeaders - The additionalHeaders to set.

addAdditionalHeader

public void addAdditionalHeader(String name,
                                String value)

Adds the specified name/value pair to the additional headers.

Parameters:

name - The name of the additional header.

value - The value of the additional header.

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Returns:

Returns the credentialsProvider.

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider credentialsProvider)

Parameters:

credentialsProvider - The credentialProvider to set.

toString

public String toString()

Return a string representation of this object

Overrides:

toString in class Object

Returns:

See above

getCharset

public String getCharset()

Gets the charset to use to perform the request

Returns:

the charset.

setCharset

public void setCharset(String charset)

Sets the charset. Default value is TextUtil.DEFAULT_CHARSET

Parameters:

charset - the new charset

getCookiePolicy

public String getCookiePolicy()

Gets the cookie policy to use to perform the request.

Returns:

the cookie policy.

setCookiePolicy

public void setCookiePolicy(String cookiePolicy)

Deprecated.

Sets the cookie policy.

Parameters:

cookiePolicy - the new cookie policy.

See Also:

WebClient.setCookiesEnabled(boolean)