HttpClientConfig (REST Assured 3.1.1 API)

java.lang.Object
- io.restassured.config.HttpClientConfig

All Implemented Interfaces:: Config

public class HttpClientConfig
extends Object
implements Config

Configure the Apache HTTP Client parameters.

Note that you can't configure the redirect settings from this config. Please use RedirectConfig for this purpose.

The following parameters are applied per default:

Parameter name	Parameter value	Description
`ClientPNames.COOKIE_POLICY`	`CookiePolicy.IGNORE_COOKIES`	Don't automatically set response cookies in subsequent requests.
`CookieSpecPNames.DATE_PATTERNS`	[EEE, dd-MMM-yyyy HH:mm:ss z, EEE, dd MMM yyyy HH:mm:ss z]	Defines valid date patterns to be used for parsing non-standard `expires` attribute.

You can also specify a http client factory that is used to create the http client instances that REST Assured uses (httpClientFactory(HttpClientConfig.HttpClientFactory)). By default the DefaultHttpClient is used. It's also possible to specify whether or not this instance should be reused in multiple requests. By default the http client instance is not reused.

See Also:: ClientPNames, CookiePolicy, CoreProtocolPNames

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HttpClientConfig.HttpClientFactory` A factory for creating and configuring a custom http client instance that will be used by REST Assured.

Constructor Summary

Constructors
Constructor and Description
`HttpClientConfig()` Creates a new HttpClientConfig instance with the `"http.protocol.cookie-policy"` parameter set to `"ignoreCookies"`.
`HttpClientConfig(Map<String,?> httpClientParams)` Creates a new HttpClientConfig instance with the parameters defined by the `httpClientParams`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpClientConfig`	`addParams(Map<String,?> httpClientParams)` Add the given parameters to an already configured number of parameters.
`HttpClientConfig`	`and()`
`HttpClientConfig`	`dontReuseHttpClientInstance()` Instruct REST Assured not to reuse the configured http client instance for multiple requests.
`static HttpClientConfig`	`httpClientConfig()`
`HttpClientConfig`	`httpClientFactory(HttpClientConfig.HttpClientFactory httpClientFactory)` Set the http client factory that Rest Assured should use when making request.
`org.apache.http.client.HttpClient`	`httpClientInstance()`
`org.apache.http.entity.mime.HttpMultipartMode`	`httpMultipartMode()`
`HttpClientConfig`	`httpMultipartMode(org.apache.http.entity.mime.HttpMultipartMode httpMultipartMode)` Specify the HTTP Multipart mode when sending multi-part data.
`boolean`	`isConfiguredToReuseTheSameHttpClientInstance()` If this method returns `true` then REST Assured will reuse the same `HttpClient` instance created by the `httpClientInstance()` method for all requests.
`boolean`	`isUserConfigured()`
`Map<String,?>`	`params()`
`HttpClientConfig`	`reuseHttpClientInstance()` Instruct REST Assured to reuse the configured http client instance for multiple requests.
`<T> HttpClientConfig`	`setParam(String parameterName, T parameterValue)` Set a http client parameter.
`HttpClientConfig`	`setParams(Map<String,?> httpClientParams)` Replaces the currently configured parameters with the ones supplied by `httpClientParams`.
`HttpClientConfig`	`withParams(Map<String,?> httpClientParams)` Replaces the currently configured parameters with the ones supplied by `httpClientParams`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpClientConfig
```
public HttpClientConfig()
```
    Creates a new HttpClientConfig instance with the "http.protocol.cookie-policy" parameter set to "ignoreCookies".
  - HttpClientConfig
```
public HttpClientConfig(Map<String,?> httpClientParams)
```
    Creates a new HttpClientConfig instance with the parameters defined by the httpClientParams.
- Method Detail
  - params
```
public Map<String,?> params()
```
    Returns:
    
    The configured parameters
  - and
```
public HttpClientConfig and()
```
    Returns:
    
    The same HttpClientConfig instance. Only here for syntactic sugar.
  - reuseHttpClientInstance
```
public HttpClientConfig reuseHttpClientInstance()
```
    Instruct REST Assured to reuse the configured http client instance for multiple requests. By default REST Assured will create a new HttpClient instance for each request. Note that for this to work the configuration must be defined statically, for example:
```
 RestAssured.config = newConfig().httpClient(httpClientConfig().reuseHttpClientInstance());
 
```
    Returns:
    
    An updated HttpClientConfig
    
    See Also:
    
    httpClientFactory(HttpClientConfig.HttpClientFactory)
  - dontReuseHttpClientInstance
```
public HttpClientConfig dontReuseHttpClientInstance()
```
    Instruct REST Assured not to reuse the configured http client instance for multiple requests. This is the default behavior.
    
    Returns:
    
    An updated HttpClientConfig
    
    See Also:
    
    reuseHttpClientInstance()
  - isConfiguredToReuseTheSameHttpClientInstance
```
public boolean isConfiguredToReuseTheSameHttpClientInstance()
```
    If this method returns true then REST Assured will reuse the same HttpClient instance created by the httpClientInstance() method for all requests. If false is returned then REST Assured creates a new instance for each request.
    By default false is returned.
    Note that for this to work the configuration must be defined statically, for example:
```
 RestAssured.config = newConfig().httpClient(httpClientConfig().reuseHttpClientInstance());
 
```
    Returns:
    
    true if the same HTTP Client instance should be reused between several requests, false otherwise.
  - setParam
```
public <T> HttpClientConfig setParam(String parameterName,
                                     T parameterValue)
```
    Set a http client parameter.
    
    Type Parameters:
    
    T - The parameter type
    
    Parameters:
    
    parameterName - The name of the parameter
    
    parameterValue - The value of the parameter (may be null)
    
    Returns:
    
    An updated HttpClientConfig
  - withParams
```
public HttpClientConfig withParams(Map<String,?> httpClientParams)
```
    Replaces the currently configured parameters with the ones supplied by httpClientParams. This method is the same as setParams(java.util.Map).
    
    Parameters:
    
    httpClientParams - The parameters to set.
    
    Returns:
    
    An updated HttpClientConfig
  - setParams
```
public HttpClientConfig setParams(Map<String,?> httpClientParams)
```
    Replaces the currently configured parameters with the ones supplied by httpClientParams. This method is the same as withParams(java.util.Map).
    
    Parameters:
    
    httpClientParams - The parameters to set.
    
    Returns:
    
    An updated HttpClientConfig
  - addParams
```
public HttpClientConfig addParams(Map<String,?> httpClientParams)
```
    Add the given parameters to an already configured number of parameters.
    
    Parameters:
    
    httpClientParams - The parameters.
    
    Returns:
    
    An updated HttpClientConfig
  - httpClientFactory
```
public HttpClientConfig httpClientFactory(HttpClientConfig.HttpClientFactory httpClientFactory)
```
    Set the http client factory that Rest Assured should use when making request. For each request REST Assured will invoke the factory to get the a the HttpClient instance.
    
    Parameters:
    
    httpClientFactory - The http client factory to use.
    
    Returns:
    
    An updated HttpClientConfig
  - httpClientInstance
```
public org.apache.http.client.HttpClient httpClientInstance()
```
    Returns:
    
    The configured http client that will create an HttpClient instances that's used by REST Assured when making a request.
  - httpMultipartMode
```
public HttpClientConfig httpMultipartMode(org.apache.http.entity.mime.HttpMultipartMode httpMultipartMode)
```
    Specify the HTTP Multipart mode when sending multi-part data.
    
    Parameters:
    
    httpMultipartMode - The multi-part mode to set.
    
    Returns:
    
    An updated HttpClientConfig
  - httpClientConfig
```
public static HttpClientConfig httpClientConfig()
```
    Returns:
    
    A static way to create a new HttpClientConfig instance without calling "new" explicitly. Mainly for syntactic sugar.
  - httpMultipartMode
```
public org.apache.http.entity.mime.HttpMultipartMode httpMultipartMode()
```
    Returns:
    
    The http multi-part mode.
  - isUserConfigured
```
public boolean isUserConfigured()
```
    Specified by:
    
    isUserConfigured in interface Config
    
    Returns:
    
    true if this config instance has been explicitly configured by the user, false if it has the default values.

Class HttpClientConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClientConfig

HttpClientConfig

Method Detail

params

and

reuseHttpClientInstance

dontReuseHttpClientInstance

isConfiguredToReuseTheSameHttpClientInstance

setParam

withParams

setParams

addParams

httpClientFactory

httpClientInstance

httpMultipartMode

httpClientConfig

httpMultipartMode

isUserConfigured