WebRequest (HtmlUnit 4.16.0 API)

JavaScript is disabled on your browser.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

org.htmlunit

Class WebRequest

java.lang.Object
- org.htmlunit.WebRequest

All Implemented Interfaces:

Serializable
```
public class WebRequest
extends Object
implements Serializable 
```
Parameter object for making web requests.

Author:

Brad Clarke, Hans Donner, Ahmed Ashour, Marc Guillemot, Rodney Gitzel, Ronald Brill, Adam Afeltowicz, Joerg Werner, Michael Lueck, Lai Quang Duong, Kristof Neirynck

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WebRequest.HttpHint
Enum to configure request creation.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebRequest.HttpHint` Enum to configure request creation.

Constructor Summary

Constructors
Constructor and Description
`WebRequest (URL url)` Instantiates a `WebRequest` for the specified URL.
`WebRequest (URL url, Charset charset, URL refererUrl)` Instantiates a `WebRequest` for the specified URL.
`WebRequest (URL url, HttpMethod submitMethod)` Instantiates a `WebRequest` for the specified URL using the specified HTTP submit method.
`WebRequest (URL url, String acceptHeader, String acceptEncodingHeader)` Instantiates a `WebRequest` for the specified URL.

Method Summary

All Methods
Modifier and Type	Method and Description
`void`	`addHint (WebRequest.HttpHint hint)` Enables the hint.
`String`	`getAdditionalHeader (String name)` Returns the header value associated with this name.
`Map<String,String>`	`getAdditionalHeaders ()` Returns the additional HTTP headers to use.
`Charset`	`getCharset ()` Returns the character set to use to perform the request.
`org.apache.http.auth.Credentials`	`getCredentials ()` Returns the credentials to use.
`Charset`	`getDefaultResponseContentCharset ()`
`FormEncodingType`	`getEncodingType ()` Returns the form encoding type to use.
`HttpMethod`	`getHttpMethod ()` Returns the HTTP submit method to use.
`List<NameValuePair>`	`getParameters ()` Retrieves the request parameters used.
`String`	`getProxyHost ()` Returns the proxy host to use.
`int`	`getProxyPort ()` Returns the proxy port to use.
`String`	`getProxyScheme ()` Returns the proxy scheme to use.
`String`	`getRequestBody ()` Returns the body content to be submitted if this is a `POST` request.
`List<NameValuePair>`	`getRequestParameters ()` INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
`int`	`getTimeout ()`
`URL`	`getUrl ()` Returns the target URL.
`org.apache.http.auth.Credentials`	`getUrlCredentials ()` Returns the credentials to use.
`boolean`	`hasHint (WebRequest.HttpHint hint)`
`boolean`	`isAdditionalHeader (String name)` Returns whether the specified header name is already included in the additional HTTP headers.
`boolean`	`isSocksProxy ()` Returns whether SOCKS proxy or not.
`static WebRequest`	`newAboutBlankRequest ()`
`void`	`removeAdditionalHeader (String name)` Removed the specified name/value pair from the additional HTTP headers.
`void`	`setAdditionalHeader (String name, String value)` Sets the specified name/value pair in the additional HTTP headers.
`void`	`setAdditionalHeaders (Map<String,String> additionalHeaders)` Sets the additional HTTP headers to use.
`void`	`setCharset (Charset charset)` Sets the character set to use to perform the request.
`void`	`setCredentials (org.apache.http.auth.Credentials credentials)` Sets the credentials to use.
`void`	`setDefaultResponseContentCharset (Charset defaultResponseContentCharset)` Sets the default character set to use for the response when it does not specify one.
`void`	`setEncodingType (FormEncodingType encodingType)` Sets the form encoding type to use.
`void`	`setHttpMethod (HttpMethod submitMethod)` Sets the HTTP submit method to use.
`void`	`setProxyHost (String proxyHost)` Sets the proxy host to use.
`void`	`setProxyPort (int proxyPort)` Sets the proxy port to use.
`void`	`setProxyScheme (String proxyScheme)` Sets the proxy scheme to use.
`void`	`setRefererHeader (URL url)` Sets the referer HTTP header - only if the provided url is valid.
`void`	`setRequestBody (String requestBody)` Sets the body content to be submitted if this is a `POST`, `PUT` or `PATCH` request.
`void`	`setRequestParameters (List<NameValuePair> requestParameters)` INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
`void`	`setSocksProxy (boolean isSocksProxy)` Sets whether SOCKS proxy or not.
`void`	`setTimeout (int timeout)` Sets the timeout to use.
`void`	`setUrl (URL url)` Sets the target URL.
`String`	`toString ()` Returns 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
  - WebRequest
```
public WebRequest(URL url,
 String acceptHeader,
 String acceptEncodingHeader)
```
    Instantiates a WebRequest for the specified URL.
    
    Parameters:
    
    url - the target URL
    
    acceptHeader - the accept header to use
    
    acceptEncodingHeader - the accept encoding header to use
  - WebRequest
```
public WebRequest(URL url,
 Charset charset,
 URL refererUrl)
```
    Instantiates a WebRequest for the specified URL.
    
    Parameters:
    
    url - the target URL
    
    charset - the charset to use
    
    refererUrl - the url be used by the referer header
  - WebRequest
```
public WebRequest(URL url)
```
    Instantiates a WebRequest for the specified URL.
    
    Parameters:
    
    url - the target URL
  - WebRequest
```
public WebRequest(URL url,
 HttpMethod submitMethod)
```
    Instantiates a WebRequest for the specified URL using the specified HTTP submit method.
    
    Parameters:
    
    url - the target URL
    
    submitMethod - the HTTP submit method to use
- Method Detail
  - newAboutBlankRequest
```
public static WebRequest newAboutBlankRequest()
```
    Returns:
    
    a new request for about:blank
  - getUrl
```
public URL getUrl()
```
    Returns the target URL.
    
    Returns:
    
    the target URL
  - setUrl
```
public void setUrl(URL url)
```
    Sets the target URL. The URL may be simplified if needed (for instance eliminating irrelevant path portions like "/./").
    
    Parameters:
    
    url - the target URL
  - getProxyHost
```
public String getProxyHost()
```
    Returns the proxy host to use.
    
    Returns:
    
    the proxy host to use
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets the proxy host to use.
    
    Parameters:
    
    proxyHost - the proxy host to use
  - getProxyPort
```
public int getProxyPort()
```
    Returns the proxy port to use.
    
    Returns:
    
    the proxy port to use
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Sets the proxy port to use.
    
    Parameters:
    
    proxyPort - the proxy port to use
  - getProxyScheme
```
public String getProxyScheme()
```
    Returns the proxy scheme to use.
    
    Returns:
    
    the proxy scheme to use
  - setProxyScheme
```
public void setProxyScheme(String proxyScheme)
```
    Sets the proxy scheme to use.
    
    Parameters:
    
    proxyScheme - the proxy scheme to use
  - isSocksProxy
```
public boolean isSocksProxy()
```
    Returns whether SOCKS proxy or not.
    
    Returns:
    
    whether SOCKS proxy or not
  - setSocksProxy
```
public void setSocksProxy(boolean isSocksProxy)
```
    Sets whether SOCKS proxy or not.
    
    Parameters:
    
    isSocksProxy - whether SOCKS proxy or not
  - getTimeout
```
public int getTimeout()
```
    Returns:
    
    the timeout to use
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the timeout to use.
    
    Parameters:
    
    timeout - the timeout to use
  - getEncodingType
```
public FormEncodingType getEncodingType()
```
    Returns the form encoding type to use.
    
    Returns:
    
    the form encoding type to use
  - setEncodingType
```
public void setEncodingType(FormEncodingType encodingType)
```
    Sets the form encoding type to use.
    
    Parameters:
    
    encodingType - the form encoding type to use
  - getParameters
```
public List<NameValuePair> getParameters()
```
    Retrieves the request parameters used. Similar to the servlet api function getParameterMap() this works depending on the request type and collects the url parameters and the body stuff.
    The value is also normalized - null is converted to an empty string.
    
    In contrast to the servlet api this creates a separate KeyValuePair for every parameter. This means that pairs with the same name can be part of the list. The servlet api will return a string[] as value for the key in this case.
    Additionally this method includes also the uploaded files for multipart post requests.
    
    Returns:
    
    the request parameters to use
  - getRequestParameters
```
public List<NameValuePair> getRequestParameters()
```
    INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
    Retrieves the request parameters to use. If set, these request parameters will overwrite any request parameters which may be present in the URL. Should not be used in combination with the request body.
    
    Returns:
    
    the request parameters to use
  - setRequestParameters
```
public void setRequestParameters(List<NameValuePair> requestParameters)
 throws RuntimeException 
```
    INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
    Sets the request parameters to use. If set, these request parameters will overwrite any request parameters which may be present in the URL. Should not be used in combination with the request body.
    
    Parameters:
    
    requestParameters - the request parameters to use
    
    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 request parameters.
    
    Returns:
    
    the body content to be submitted if this is a POST request
  - setRequestBody
```
public void setRequestBody(String requestBody)
 throws RuntimeException 
```
    Sets the body content to be submitted if this is a POST, PUT or PATCH request. Other request types result in RuntimeException. Should not be used in combination with request parameters.
    
    Parameters:
    
    requestBody - the body content to be submitted if this is a POST, PUT or PATCH request
    
    Throws:
    
    RuntimeException - if the request parameters have already been set or this is not a POST, PUT or PATCH request.
  - getHttpMethod
```
public HttpMethod getHttpMethod()
```
    Returns the HTTP submit method to use.
    
    Returns:
    
    the HTTP submit method to use
  - setHttpMethod
```
public void setHttpMethod(HttpMethod submitMethod)
```
    Sets the HTTP submit method to use.
    
    Parameters:
    
    submitMethod - the HTTP submit method to use
  - getAdditionalHeaders
```
public Map<String,String> getAdditionalHeaders()
```
    Returns the additional HTTP headers to use.
    
    Returns:
    
    the additional HTTP headers to use
  - setAdditionalHeaders
```
public void setAdditionalHeaders(Map<String,String> additionalHeaders)
```
    Sets the additional HTTP headers to use.
    
    Parameters:
    
    additionalHeaders - the additional HTTP headers to use
  - isAdditionalHeader
```
public boolean isAdditionalHeader(String name)
```
    Returns whether the specified header name is already included in the additional HTTP headers.
    
    Parameters:
    
    name - the name of the additional HTTP header
    
    Returns:
    
    true if the specified header name is included in the additional HTTP headers
  - getAdditionalHeader
```
public String getAdditionalHeader(String name)
```
    Returns the header value associated with this name.
    
    Parameters:
    
    name - the name of the additional HTTP header
    
    Returns:
    
    the value or null
  - setRefererHeader
```
public void setRefererHeader(URL url)
```
    Sets the referer HTTP header - only if the provided url is valid.
    
    Parameters:
    
    url - the url for the referer HTTP header
  - setAdditionalHeader
```
public void setAdditionalHeader(String name,
 String value)
```
    Sets the specified name/value pair in the additional HTTP headers.
    
    Parameters:
    
    name - the name of the additional HTTP header
    
    value - the value of the additional HTTP header
  - removeAdditionalHeader
```
public void removeAdditionalHeader(String name)
```
    Removed the specified name/value pair from the additional HTTP headers.
    
    Parameters:
    
    name - the name of the additional HTTP header
  - getUrlCredentials
```
public org.apache.http.auth.Credentials getUrlCredentials()
```
    Returns the credentials to use.
    
    Returns:
    
    the credentials if set as part of the url
  - getCredentials
```
public org.apache.http.auth.Credentials getCredentials()
```
    Returns the credentials to use.
    
    Returns:
    
    the credentials if set from the external builder
  - setCredentials
```
public void setCredentials(org.apache.http.auth.Credentials credentials)
```
    Sets the credentials to use.
    
    Parameters:
    
    credentials - the credentials to use
  - getCharset
```
public Charset getCharset()
```
    Returns the character set to use to perform the request.
    
    Returns:
    
    the character set to use to perform the request
  - setCharset
```
public void setCharset(Charset charset)
```
    Sets the character set to use to perform the request. The default value is StandardCharsets.ISO_8859_1.
    
    Parameters:
    
    charset - the character set to use to perform the request
  - getDefaultResponseContentCharset
```
public Charset getDefaultResponseContentCharset()
```
    Returns:
    
    the default character set to use for the response when it does not specify one.
  - setDefaultResponseContentCharset
```
public void setDefaultResponseContentCharset(Charset defaultResponseContentCharset)
```
    Sets the default character set to use for the response when it does not specify one.
    Unless set, the default is StandardCharsets.UTF_8.
    
    Parameters:
    
    defaultResponseContentCharset - the default character set of the response
  - hasHint
```
public boolean hasHint(WebRequest.HttpHint hint)
```
    Parameters:
    
    hint - the hint to check for
    
    Returns:
    
    true if the hint is enabled
  - addHint
```
public void addHint(WebRequest.HttpHint hint)
```
    Enables the hint.
    
    Parameters:
    
    hint - the hint to add
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class WebRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebRequest

WebRequest

WebRequest

WebRequest

Method Detail

newAboutBlankRequest

getUrl

setUrl

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyScheme

setProxyScheme

isSocksProxy

setSocksProxy

getTimeout

setTimeout

getEncodingType

setEncodingType

getParameters

getRequestParameters

setRequestParameters

getRequestBody

setRequestBody

getHttpMethod

setHttpMethod

getAdditionalHeaders

setAdditionalHeaders

isAdditionalHeader

getAdditionalHeader

setRefererHeader

setAdditionalHeader

removeAdditionalHeader

getUrlCredentials

getCredentials

setCredentials

getCharset

setCharset

getDefaultResponseContentCharset

setDefaultResponseContentCharset

hasHint

addHint

toString