RequestSpecBuilder (REST Assured 4.2.0 API)

java.lang.Object
- io.restassured.builder.RequestSpecBuilder

public class RequestSpecBuilder
extends Object

You can use the builder to construct a request specification. The specification can be used as e.g.

 ResponseSpecification responseSpec = new ResponseSpecBuilder().expectStatusCode(200).build();
 RequestSpecification requestSpec = new RequestSpecBuilder().addParam("parameter1", "value1").build();

 given(responseSpec, requestSpec).post("/something");

 RequestSpecification requestSpec = new RequestSpecBuilder().addParameter("parameter1", "value1").build();

 given().
         spec(requestSpec).
 expect().
         body("x.y.z", equalTo("something")).
 when().
        get("/something");

Constructor Summary

Constructors
Constructor and Description

RequestSpecBuilder()

Constructors
Constructor and Description
`RequestSpecBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestSpecBuilder`	`addCookie(Cookie cookie)` Add a detailed cookie
`RequestSpecBuilder`	`addCookie(String name)` Add a cookie without value to be sent with the request.
`RequestSpecBuilder`	`addCookie(String key, Object value, Object... cookieNameValuePairs)` Add a cookie to be sent with the request.
`RequestSpecBuilder`	`addCookies(Cookies cookies)` Specify multiple detailed cookies that'll be sent with the request.
`RequestSpecBuilder`	`addCookies(Map<String,?> cookies)` Add cookies to be sent with the request as Map e.g:
`RequestSpecBuilder`	`addFilter(Filter filter)` Add a filter that will be used in the request.
`RequestSpecBuilder`	`addFilters(List<Filter> filters)` Add filters that will be used in the request.
`RequestSpecBuilder`	`addFormParam(String parameterName, Collection<?> parameterValues)` Add a form parameter to be sent with the request.
`RequestSpecBuilder`	`addFormParam(String parameterName, Object... parameterValues)` Add a form parameter to be sent with the request.
`RequestSpecBuilder`	`addFormParams(Map<String,?> parametersMap)` Add query parameters to be sent with the request as a Map.
`RequestSpecBuilder`	`addHeader(String headerName, String headerValue)` Add a header to be sent with the request e.g:
`RequestSpecBuilder`	`addHeaders(Map<String,String> headers)` Add headers to be sent with the request as Map.
`RequestSpecBuilder`	`addMultiPart(File file)` Specify a file to upload to the server using multi-part form data uploading.
`RequestSpecBuilder`	`addMultiPart(MultiPartSpecification multiPartSpecification)` Specify a multi-part specification.
`RequestSpecBuilder`	`addMultiPart(String controlName, File file)` Specify a file to upload to the server using multi-part form data uploading with a specific control name.
`RequestSpecBuilder`	`addMultiPart(String controlName, File file, String mimeType)` Specify a file to upload to the server using multi-part form data uploading with a specific control name and content-type.
`RequestSpecBuilder`	`addMultiPart(String controlName, String contentBody)` Specify a string to send to the server using multi-part form data.
`RequestSpecBuilder`	`addMultiPart(String controlName, String fileName, byte[] bytes)` Specify a byte-array to upload to the server using multi-part form data.
`RequestSpecBuilder`	`addMultiPart(String controlName, String fileName, byte[] bytes, String mimeType)` Specify a byte-array to upload to the server using multi-part form data.
`RequestSpecBuilder`	`addMultiPart(String controlName, String fileName, InputStream stream)` Specify an inputstream to upload to the server using multi-part form data.
`RequestSpecBuilder`	`addMultiPart(String controlName, String fileName, InputStream stream, String mimeType)` Specify an inputstream to upload to the server using multi-part form data.
`RequestSpecBuilder`	`addMultiPart(String controlName, String contentBody, String mimeType)` Specify a string to send to the server using multi-part form data with a specific mime-type.
`RequestSpecBuilder`	`addParam(String parameterName, Collection<?> parameterValues)` Add a multi-value parameter to be sent with the request.
`RequestSpecBuilder`	`addParam(String parameterName, Object... parameterValues)` Add a parameter to be sent with the request.
`RequestSpecBuilder`	`addParams(Map<String,?> parametersMap)` Add parameters to be sent with the request as Map.
`RequestSpecBuilder`	`addPathParam(String parameterName, Object parameterValue)` Specify a path parameter.
`RequestSpecBuilder`	`addPathParams(Map<String,?> parameterNameValuePairs)` Specify multiple path parameter name-value pairs.
`RequestSpecBuilder`	`addPathParams(String firstParameterName, Object firstParameterValue, Object... parameterNameValuePairs)` Specify multiple path parameter name-value pairs.
`RequestSpecBuilder`	`addQueryParam(String parameterName, Collection<?> parameterValues)` Add a query parameter to be sent with the request.
`RequestSpecBuilder`	`addQueryParam(String parameterName, Object... parameterValues)` Add a query parameter to be sent with the request.
`RequestSpecBuilder`	`addQueryParams(Map<String,?> parametersMap)` Add query parameters to be sent with the request as a Map.
`RequestSpecBuilder`	`addRequestSpecification(RequestSpecification specification)` Merge this builder with settings from another specification.
`RequestSpecBuilder`	`and()` Syntactic sugar.
`RequestSpecification`	`build()` Build RequestSpecBuilder.
`RequestSpecBuilder`	`log(LogDetail logDetail)` Enabled logging with the specified log detail.
`RequestSpecBuilder`	`removeFormParam(String parameterName)` Method to remove parameter added with `addFormParam(String, Object...)` from map.
`RequestSpecBuilder`	`removeParam(String parameterName)` Method to remove parameter added with `addParam(String, Object...)` from map.
`RequestSpecBuilder`	`removePathParam(String parameterName)` Method to remove parameter added with `addPathParam(String, Object)` from map.
`RequestSpecBuilder`	`removeQueryParam(String parameterName)` Method to remove parameter added with from map.
`RequestSpecBuilder`	`setAccept(ContentType contentType)` Specify the accept header of the request.
`RequestSpecBuilder`	`setAccept(String mediaTypes)` Specify the accept header of the request.
`RequestSpecBuilder`	`setAuth(AuthenticationScheme auth)` If you need to specify some credentials when performing a request.
`RequestSpecBuilder`	`setBasePath(String path)` Set the base path that's prepended to each path by REST assured when making requests.
`RequestSpecBuilder`	`setBaseUri(String uri)` Add the baseUri property from the RequestSpecBuilder instead of using static field RestAssured.baseURI.
`RequestSpecBuilder`	`setBaseUri(URI uri)` Add the baseUri property from the RequestSpecBuilder instead of using static field RestAssured.baseURI.
`RequestSpecBuilder`	`setBody(byte[] body)` Specify a byte array request body to be sent with the request.
`RequestSpecBuilder`	`setBody(Object object)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request.
`RequestSpecBuilder`	`setBody(Object object, ObjectMapper mapper)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper.
`RequestSpecBuilder`	`setBody(Object object, ObjectMapperType mapperType)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper type.
`RequestSpecBuilder`	`setBody(String body)` Specify a String request body (such as e.g.
`RequestSpecBuilder`	`setConfig(RestAssuredConfig config)` Define a configuration for redirection settings and http client parameters.
`RequestSpecBuilder`	`setContentType(ContentType contentType)` Specify the content type of the request.
`RequestSpecBuilder`	`setContentType(String contentType)` Specify the content type of the request as string.
`RequestSpecBuilder`	`setKeyStore(KeyStore keyStore)` Use the supplied keystore for HTTPS requests.
`RequestSpecBuilder`	`setKeyStore(String pathToJks, String password)` Specify a keystore.
`RequestSpecBuilder`	`setPort(int port)` Specify the port.
`RequestSpecBuilder`	`setProxy(int port)` Instruct REST Assured to connect to a proxy on the specified port on localhost.
`RequestSpecBuilder`	`setProxy(ProxySpecification proxySpecification)` Instruct REST Assured to connect to a proxy using a `ProxySpecification`.
`RequestSpecBuilder`	`setProxy(String host)` Instruct REST Assured to connect to a proxy on the specified host on port `8888`.
`RequestSpecBuilder`	`setProxy(String host, int port)` Instruct REST Assured to connect to a proxy on the specified host and port.
`RequestSpecBuilder`	`setProxy(String host, int port, String scheme)` Instruct REST Assured to connect to a proxy on the specified port on localhost with a specific scheme.
`RequestSpecBuilder`	`setProxy(URI uri)` Instruct REST Assured to connect to a proxy using a URI.
`RequestSpecBuilder`	`setRelaxedHTTPSValidation()` Use relaxed HTTP validation with SSLContext protocol .
`RequestSpecBuilder`	`setRelaxedHTTPSValidation(String protocol)` Use relaxed HTTP validation with a given SSLContext protocol.
`RequestSpecBuilder`	`setSessionId(String sessionIdValue)` Set the session id for this request.
`RequestSpecBuilder`	`setSessionId(String sessionIdName, String sessionIdValue)` Set the session id name and value for this request.
`RequestSpecBuilder`	`setTrustStore(File pathToJks, String password)` The following documentation is taken from https://github.com/jgritman/httpbuilder/wiki/SSL:
`RequestSpecBuilder`	`setTrustStore(KeyStore trustStore)` Use the supplied truststore for HTTPS requests.
`RequestSpecBuilder`	`setTrustStore(String pathToJks, String password)` The following documentation is taken from https://github.com/jgritman/httpbuilder/wiki/SSL:
`RequestSpecBuilder`	`setUrlEncodingEnabled(boolean isEnabled)` Specifies if Rest Assured should url encode the URL automatically.

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

- Constructor Detail
  - RequestSpecBuilder
```
public RequestSpecBuilder()
```
- Method Detail
  - setBody
```
public RequestSpecBuilder setBody(String body)
```
    Specify a String request body (such as e.g. JSON or XML) to be sent with the request. This works for the POST, PUT and PATCH methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    
    Parameters:
    
    body - The body to send.
    
    Returns:
    
    The request specification builder
  - setBody
```
public RequestSpecBuilder setBody(byte[] body)
```
    Specify a byte array request body to be sent with the request. This only works for the POST http method. Trying to do this for the other http methods will cause an exception to be thrown.
    
    Parameters:
    
    body - The body to send.
    
    Returns:
    
    The request specification builder
  - setBody
```
public RequestSpecBuilder setBody(Object object)
```
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request. If the object is a primitive or Number the object will be converted to a String and put in the request body. This works for the POST, PUT and PATCH methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    
    Parameters:
    
    object - The object to serialize and send with the request
    
    Returns:
    
    The request specification
  - setBody
```
public RequestSpecBuilder setBody(Object object,
                                  ObjectMapper mapper)
```
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    
    Parameters:
    
    object - The object to serialize and send with the request
    
    mapper - The object mapper
    
    Returns:
    
    The request specification
  - setBody
```
public RequestSpecBuilder setBody(Object object,
                                  ObjectMapperType mapperType)
```
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper type. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 Message message = new Message();
 message.setMessage("My beautiful message");

 given().
         body(message, ObjectMapper.GSON).
 expect().
         content(equalTo("Response to a beautiful message")).
 when().
         post("/beautiful-message");
 
```
    Parameters:
    
    object - The object to serialize and send with the request
    
    mapperType - The object mapper type to be used
    
    Returns:
    
    The request specification
  - addCookies
```
public RequestSpecBuilder addCookies(Map<String,?> cookies)
```
    Add cookies to be sent with the request as Map e.g:
    
    Parameters:
    
    cookies - The Map containing the cookie names and their values to set in the request.
    
    Returns:
    
    The request specification builder
  - addCookie
```
public RequestSpecBuilder addCookie(Cookie cookie)
```
    Add a detailed cookie
    
    Parameters:
    
    cookie - The cookie to add.
    
    Returns:
    
    The request specification builder
  - addCookie
```
public RequestSpecBuilder addCookie(String key,
                                    Object value,
                                    Object... cookieNameValuePairs)
```
    Add a cookie to be sent with the request.
    
    Parameters:
    
    key - The cookie key
    
    value - The cookie value
    
    cookieNameValuePairs - Additional cookies values. This will actually create two cookies with the same name but with different values.
    
    Returns:
    
    The request specification builder
  - addCookie
```
public RequestSpecBuilder addCookie(String name)
```
    Add a cookie without value to be sent with the request.
    
    Parameters:
    
    name - The cookie name
    
    Returns:
    
    The request specification builder
  - addCookies
```
public RequestSpecBuilder addCookies(Cookies cookies)
```
    Specify multiple detailed cookies that'll be sent with the request.
    
    Parameters:
    
    cookies - The cookies to set in the request.
    
    Returns:
    
    The request specification builder
    
    See Also:
    
    RequestSpecification.cookies(Cookies)
  - addFilter
```
public RequestSpecBuilder addFilter(Filter filter)
```
    Add a filter that will be used in the request.
    
    Parameters:
    
    filter - The filter to add
    
    Returns:
    
    RequestSpecBuilder builder
  - addFilters
```
public RequestSpecBuilder addFilters(List<Filter> filters)
```
    Add filters that will be used in the request.
    
    Parameters:
    
    filters - The filters to add
    
    Returns:
    
    RequestSpecBuilder builder
  - addParams
```
public RequestSpecBuilder addParams(Map<String,?> parametersMap)
```
    Add parameters to be sent with the request as Map.
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification builder
  - addParam
```
public RequestSpecBuilder addParam(String parameterName,
                                   Object... parameterValues)
```
    Add a parameter to be sent with the request.
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - Zero to many parameter values for this parameter name.
    
    Returns:
    
    The request specification builder
  - addParam
```
public RequestSpecBuilder addParam(String parameterName,
                                   Collection<?> parameterValues)
```
    Add a multi-value parameter to be sent with the request.
    
    Parameters:
    
    parameterName - The parameter key
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification builder
  - removeParam
```
public RequestSpecBuilder removeParam(String parameterName)
```
    Method to remove parameter added with addParam(String, Object...) from map. Removes all values of this parameter
    
    Parameters:
    
    parameterName - The parameter key
    
    Returns:
    
    The request specification builder
  - addQueryParam
```
public RequestSpecBuilder addQueryParam(String parameterName,
                                        Collection<?> parameterValues)
```
    Add a query parameter to be sent with the request. This method is the same as addParam(String, java.util.Collection) for all HTTP methods except POST where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parameterName - The parameter key
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification builder
    
    See Also:
    
    addQueryParam(String, Object...)
  - addQueryParams
```
public RequestSpecBuilder addQueryParams(Map<String,?> parametersMap)
```
    Add query parameters to be sent with the request as a Map. This method is the same as addParams(java.util.Map) for all HTTP methods except POST where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification builder
  - addQueryParam
```
public RequestSpecBuilder addQueryParam(String parameterName,
                                        Object... parameterValues)
```
    Add a query parameter to be sent with the request. This method is the same as addParam(String, Object...) )} for all HTTP methods except POST where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parameterName - The parameter key
    
    parameterValues - Zero to many parameter values for this parameter name.
    
    Returns:
    
    The request specification builder
  - removeQueryParam
```
public RequestSpecBuilder removeQueryParam(String parameterName)
```
    Method to remove parameter added with from map. Removes all values of this parameter
    
    Parameters:
    
    parameterName - The parameter key
    
    Returns:
    
    The request specification builder
  - addFormParam
```
public RequestSpecBuilder addFormParam(String parameterName,
                                       Collection<?> parameterValues)
```
    Add a form parameter to be sent with the request. This method is the same as addParam(String, java.util.Collection) for all HTTP methods except PUT where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parameterName - The parameter key
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification builder
    
    See Also:
    
    addFormParam(String, Object...)
  - addFormParams
```
public RequestSpecBuilder addFormParams(Map<String,?> parametersMap)
```
    Add query parameters to be sent with the request as a Map. This method is the same as addParams(java.util.Map) for all HTTP methods except POST where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification builder
  - addFormParam
```
public RequestSpecBuilder addFormParam(String parameterName,
                                       Object... parameterValues)
```
    Add a form parameter to be sent with the request. This method is the same as addParam(String, Object...) )} for all HTTP methods except PUT where this method can be used to differentiate between form and query params.
    
    Parameters:
    
    parameterName - The parameter key
    
    parameterValues - Zero to many parameter values for this parameter name.
    
    Returns:
    
    The request specification builder
    
    See Also:
    
    addFormParam(String, Object...)
  - removeFormParam
```
public RequestSpecBuilder removeFormParam(String parameterName)
```
    Method to remove parameter added with addFormParam(String, Object...) from map. Removes all values of this parameter
    
    Parameters:
    
    parameterName - The parameter key
    
    Returns:
    
    The request specification builder
  - addPathParam
```
public RequestSpecBuilder addPathParam(String parameterName,
                                       Object parameterValue)
```
    Specify a path parameter. Path parameters are used to improve readability of the request path. E.g. instead of writing:
```
 expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
 
```
    you can write:
```
 given().
         pathParam("itemNumber", myItem.getItemNumber()).
         pathParam("amount", 2).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");
 
```
    which improves readability and allows the path to be reusable in many tests. Another alternative is to use:
```
 expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
 
```
    Parameters:
    
    parameterName - The parameter key
    
    parameterValue - The parameter value
    
    Returns:
    
    The request specification
  - addPathParams
```
public RequestSpecBuilder addPathParams(String firstParameterName,
                                        Object firstParameterValue,
                                        Object... parameterNameValuePairs)
```
    Specify multiple path parameter name-value pairs. Path parameters are used to improve readability of the request path. E.g. instead of writing:
```
 expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
 
```
    you can write:
```
 given().
         pathParam("itemNumber", myItem.getItemNumber(), "amount", 2).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");
 
```
    which improves readability and allows the path to be reusable in many tests. Another alternative is to use:
```
 expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
 
```
    Parameters:
    
    firstParameterName - The name of the first parameter
    
    firstParameterValue - The value of the first parameter
    
    parameterNameValuePairs - Additional parameters in name-value pairs.
    
    Returns:
    
    The request specification
  - addPathParams
```
public RequestSpecBuilder addPathParams(Map<String,?> parameterNameValuePairs)
```
    Specify multiple path parameter name-value pairs. Path parameters are used to improve readability of the request path. E.g. instead of writing:
```
 expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
 
```
    you can write:
```
 Map<String,Object> pathParams = new HashMap<String,Object>();
 pathParams.add("itemNumber",myItem.getItemNumber());
 pathParams.add("amount",2);

 given().
         pathParameters(pathParams).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");
 
```
    which improves readability and allows the path to be reusable in many tests. Another alternative is to use:
```
 expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
 
```
    Parameters:
    
    parameterNameValuePairs - A map containing the path parameters.
    
    Returns:
    
    The request specification
  - removePathParam
```
public RequestSpecBuilder removePathParam(String parameterName)
```
    Method to remove parameter added with addPathParam(String, Object) from map. Removes all values of this parameter.
    
    Parameters:
    
    parameterName - The parameter key
    
    Returns:
    
    The request specification builder
  - setKeyStore
```
public RequestSpecBuilder setKeyStore(String pathToJks,
                                      String password)
```
    Specify a keystore.
```
 RestAssured.keyStore("/truststore_javanet.jks", "test1234");
 
```
    or
```
 given().keyStore("/truststore_javanet.jks", "test1234"). ..
 
```
    Parameters:
    
    pathToJks - The path to the JKS
    
    password - The store pass
  - setTrustStore
```
public RequestSpecBuilder setTrustStore(String pathToJks,
                                        String password)
```
    The following documentation is taken from https://github.com/jgritman/httpbuilder/wiki/SSL:
    
    SSL Configuration
    
    SSL should, for the most part, "just work." There are a few situations where it is not completely intuitive. You can follow the example below, or see HttpClient's SSLSocketFactory documentation for more information.
    
    SSLPeerUnverifiedException
    
    If you can't connect to an SSL website, it is likely because the certificate chain is not trusted. This is an Apache HttpClient issue, but explained here for convenience. To correct the untrusted certificate, you need to import a certificate into an SSL truststore.
    First, export a certificate from the website using your browser. For example, if you go to https://dev.java.net in Firefox, you will probably get a warning in your browser. Choose "Add Exception," "Get Certificate," "View," "Details tab." Choose a certificate in the chain and export it as a PEM file. You can view the details of the exported certificate like so:
```
 $ keytool -printcert -file EquifaxSecureGlobaleBusinessCA-1.crt
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ....
 
```
    Now, import that into a Java keystore file:
```
 $ keytool -importcert -alias "equifax-ca" -file EquifaxSecureGlobaleBusinessCA-1.crt -keystore truststore_javanet.jks -storepass test1234
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ...
 Trust this certificate? [no]:  yes
 Certificate was added to keystore
 
```
    Now you want to use this truststore in your client:
```
 RestAssured.trustStore("/truststore_javanet.jks", "test1234");
 
```
    or
```
 given().trustStore("/truststore_javanet.jks", "test1234"). ..
 
```
    Parameters:
    
    pathToJks - The path to the JKS
    
    password - The store pass
  - setTrustStore
```
public RequestSpecBuilder setTrustStore(File pathToJks,
                                        String password)
```
    The following documentation is taken from https://github.com/jgritman/httpbuilder/wiki/SSL:
    
    SSL Configuration
    
    SSL should, for the most part, "just work." There are a few situations where it is not completely intuitive. You can follow the example below, or see HttpClient's SSLSocketFactory documentation for more information.
    
    SSLPeerUnverifiedException
    
    If you can't connect to an SSL website, it is likely because the certificate chain is not trusted. This is an Apache HttpClient issue, but explained here for convenience. To correct the untrusted certificate, you need to import a certificate into an SSL truststore.
    First, export a certificate from the website using your browser. For example, if you go to https://dev.java.net in Firefox, you will probably get a warning in your browser. Choose "Add Exception," "Get Certificate," "View," "Details tab." Choose a certificate in the chain and export it as a PEM file. You can view the details of the exported certificate like so:
```
 $ keytool -printcert -file EquifaxSecureGlobaleBusinessCA-1.crt
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ....
 
```
    Now, import that into a Java keystore file:
```
 $ keytool -importcert -alias "equifax-ca" -file EquifaxSecureGlobaleBusinessCA-1.crt -keystore truststore_javanet.jks -storepass test1234
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ...
 Trust this certificate? [no]:  yes
 Certificate was added to keystore
 
```
    Now you want to use this truststore in your client:
```
 RestAssured.trustStore("/truststore_javanet.jks", "test1234");
 
```
    or
```
 given().trustStore("/truststore_javanet.jks", "test1234"). ..
 
```
    Parameters:
    
    pathToJks - The path to the JKS
    
    password - The store pass
  - addHeaders
```
public RequestSpecBuilder addHeaders(Map<String,String> headers)
```
    Add headers to be sent with the request as Map.
    
    Parameters:
    
    headers - The Map containing the header names and their values to send with the request.
    
    Returns:
    
    The request specification builder
  - addHeader
```
public RequestSpecBuilder addHeader(String headerName,
                                    String headerValue)
```
    Add a header to be sent with the request e.g:
    
    Parameters:
    
    headerName - The header name
    
    headerValue - The header value
    
    Returns:
    
    The request specification builder
  - setContentType
```
public RequestSpecBuilder setContentType(ContentType contentType)
```
    Specify the content type of the request.
    
    Parameters:
    
    contentType - The content type of the request
    
    Returns:
    
    The request specification builder
    
    See Also:
    
    ContentType
  - setContentType
```
public RequestSpecBuilder setContentType(String contentType)
```
    Specify the content type of the request as string.
    
    Parameters:
    
    contentType - The content type of the request
    
    Returns:
    
    The request specification builder
  - setAccept
```
public RequestSpecBuilder setAccept(ContentType contentType)
```
    Specify the accept header of the request. This just a shortcut for:
```
 addHeader("Accept", contentType);
 
```
    Parameters:
    
    contentType - The content type whose accept header ContentType.getAcceptHeader() will be used as Accept header in the request.
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType, addHeader(String, String)
  - setAccept
```
public RequestSpecBuilder setAccept(String mediaTypes)
```
    Specify the accept header of the request. This just a shortcut for:
```
 header("Accept", contentType);
 
```
    Parameters:
    
    mediaTypes - The media type(s) that will be used as Accept header in the request.
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType, addHeader(String, String)
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(MultiPartSpecification multiPartSpecification)
```
    Specify a multi-part specification. Use this method if you need to specify content-type etc.
    
    Parameters:
    
    multiPartSpecification - Multipart specification
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(File file)
```
    Specify a file to upload to the server using multi-part form data uploading. It will assume that the control name is file and the content-type is application/octet-stream. If this is not what you want please use an overloaded method.
    
    Parameters:
    
    file - The file to upload
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       File file)
```
    Specify a file to upload to the server using multi-part form data uploading with a specific control name. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Parameters:
    
    file - The file to upload
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       File file,
                                       String mimeType)
```
    Specify a file to upload to the server using multi-part form data uploading with a specific control name and content-type.
    
    Parameters:
    
    file - The file to upload
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    mimeType - The content-type
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String fileName,
                                       byte[] bytes)
```
    Specify a byte-array to upload to the server using multi-part form data. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    bytes - The bytes you want to send
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String fileName,
                                       byte[] bytes,
                                       String mimeType)
```
    Specify a byte-array to upload to the server using multi-part form data.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    bytes - The bytes you want to send
    
    mimeType - The content-type
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String fileName,
                                       InputStream stream)
```
    Specify an inputstream to upload to the server using multi-part form data. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    stream - The stream you want to send
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String fileName,
                                       InputStream stream,
                                       String mimeType)
```
    Specify an inputstream to upload to the server using multi-part form data.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    stream - The stream you want to send
    
    mimeType - The content-type
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String contentBody)
```
    Specify a string to send to the server using multi-part form data. It will use the content-type text/plain. If this is not what you want please use an overloaded method.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    contentBody - The string to send
    
    Returns:
    
    The request specification
  - addMultiPart
```
public RequestSpecBuilder addMultiPart(String controlName,
                                       String contentBody,
                                       String mimeType)
```
    Specify a string to send to the server using multi-part form data with a specific mime-type.
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    contentBody - The string to send
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - setAuth
```
public RequestSpecBuilder setAuth(AuthenticationScheme auth)
```
    If you need to specify some credentials when performing a request.
    
    Returns:
    
    The request specification builder
  - setPort
```
public RequestSpecBuilder setPort(int port)
```
    Specify the port.
    
    Parameters:
    
    port - The port of URI
    
    Returns:
    
    The request specification builder
  - setUrlEncodingEnabled
```
public RequestSpecBuilder setUrlEncodingEnabled(boolean isEnabled)
```
    Specifies if Rest Assured should url encode the URL automatically. Usually this is a recommended but in some cases e.g. the query parameters are already be encoded before you provide them to Rest Assured then it's useful to disable URL encoding.
    
    Parameters:
    
    isEnabled - Specify whether or not URL encoding should be enabled or disabled.
    
    Returns:
    
    The request specification builder
  - setSessionId
```
public RequestSpecBuilder setSessionId(String sessionIdValue)
```
    Set the session id for this request. It will use the configured session id name from the configuration (by default this is ). You can configure the session id name by using:
```
     RestAssured.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
 
```
    or you can use the setSessionId(String, String) method to set it for this request only.
    Parameters:
    
    sessionIdValue - The session id value.
    
    Returns:
    
    The request specification
  - setSessionId
```
public RequestSpecBuilder setSessionId(String sessionIdName,
                                       String sessionIdValue)
```
    Set the session id name and value for this request. It'll override the default session id name from the configuration (by default this is ). You can configure the default session id name by using:
```
     RestAssured.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
 
```
    and then you can use the setSessionId(String) method to set the session id value without specifying the name for each request.
    Parameters:
    
    sessionIdName - The session id name
    
    sessionIdValue - The session id value.
    
    Returns:
    
    The request specification
  - addRequestSpecification
```
public RequestSpecBuilder addRequestSpecification(RequestSpecification specification)
```
    Merge this builder with settings from another specification. Note that the supplied specification can overwrite data in the current specification. The following settings are overwritten:
    - Port
    - Authentication schemeContent type
    - Request body
    The following settings are merged:
    - Parameters
    - Cookies
    - Headers
    - Filters
    Parameters:
    
    specification - The specification to add
    
    Returns:
    
    The request specification builder
  - setConfig
```
public RequestSpecBuilder setConfig(RestAssuredConfig config)
```
    Define a configuration for redirection settings and http client parameters.
    
    Parameters:
    
    config - The configuration to use for this request. If null no config will be used.
    
    Returns:
    
    The request specification builder
  - build
```
public RequestSpecification build()
```
    Build RequestSpecBuilder.
    
    Returns:
    
    The assembled request specification
  - setBaseUri
```
public RequestSpecBuilder setBaseUri(String uri)
```
    Add the baseUri property from the RequestSpecBuilder instead of using static field RestAssured.baseURI.
```
 RequestSpecBuilder builder = new RequestSpecBuilder();
 builder.setBaseUri("http://example.com");
 RequestSpecification specs = builder.build();
 given().specification(specs)
 
```
    Parameters:
    
    uri - The URI
    
    Returns:
    
    RequestSpecBuilder
  - setBaseUri
```
public RequestSpecBuilder setBaseUri(URI uri)
```
    Add the baseUri property from the RequestSpecBuilder instead of using static field RestAssured.baseURI.
```
 RequestSpecification specs = new RequestSpecBuilder()
                                  .setBaseUri(URI.create("http://example.com"))
                                  .build();
 given().specification(specs)
 
```
    uses setBaseUri(String)
    Parameters:
    
    uri - The URI
    
    Returns:
    
    RequestSpecBuilder
  - setBasePath
```
public RequestSpecBuilder setBasePath(String path)
```
    Set the base path that's prepended to each path by REST assured when making requests. E.g. let's say that the base uri is http://localhost and basePath is /resource then
```
 ..when().get("/something");
 
```
    will make a request to http://localhost/resource.
    Parameters:
    
    path - The base path to set.
    
    Returns:
    
    RequestSpecBuilder
  - log
```
public RequestSpecBuilder log(LogDetail logDetail)
```
    Enabled logging with the specified log detail. Set a LogConfig to configure the print stream and pretty printing options.
    
    Parameters:
    
    logDetail - The log detail.
    
    Returns:
    
    RequestSpecBuilder
  - setTrustStore
```
public RequestSpecBuilder setTrustStore(KeyStore trustStore)
```
    Use the supplied truststore for HTTPS requests. Shortcut for:
```
 given().config(RestAssured.config().sslConfig(sslConfig().trustStore(truststore));
 
```
    Parameters:
    
    trustStore - The truststore.
    
    Returns:
    
    RequestSpecBuilder
    
    See Also:
    
    setKeyStore(String, String)
  - setKeyStore
```
public RequestSpecBuilder setKeyStore(KeyStore keyStore)
```
    Use the supplied keystore for HTTPS requests. Shortcut for:
```
 given().config(RestAssured.config().sslConfig(sslConfig().keyStore(keystore));
 
```
    Parameters:
    
    keyStore - The truststore.
    
    Returns:
    
    RequestSpecBuilder
    
    See Also:
    
    setKeyStore(String, String)
  - setRelaxedHTTPSValidation
```
public RequestSpecBuilder setRelaxedHTTPSValidation()
```
    Use relaxed HTTP validation with SSLContext protocol . This means that you'll trust all hosts regardless if the SSL certificate is invalid. By using this method you don't need to specify a keystore (see setKeyStore(String, String) or trust store (see setTrustStore(java.security.KeyStore).
    This is just a shortcut for:
```
 given().config(RestAssured.config().sslConfig(sslConfig().relaxedHTTPSValidation())). ..;
 
```
    Returns:
    
    RequestSpecBuilder
  - setRelaxedHTTPSValidation
```
public RequestSpecBuilder setRelaxedHTTPSValidation(String protocol)
```
    Use relaxed HTTP validation with a given SSLContext protocol. This means that you'll trust all hosts regardless if the SSL certificate is invalid. By using this method you don't need to specify a keystore (see setKeyStore(String, String) or trust store (see setTrustStore(java.security.KeyStore).
    This is just a shortcut for:
```
 given().config(RestAssured.config().sslConfig(sslConfig().relaxedHTTPSValidation())). ..;
 
```
    Parameters:
    
    protocol - The standard name of the requested protocol. See the SSLContext section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard protocol names.
    
    Returns:
    
    RequestSpecBuilder
  - setProxy
```
public RequestSpecBuilder setProxy(String host,
                                   int port)
```
    Instruct REST Assured to connect to a proxy on the specified host and port.
    
    Parameters:
    
    host - The hostname of the proxy to connect to (for example 127.0.0.1)
    
    port - The port of the proxy to connect to (for example 8888)
    
    Returns:
    
    RequestSpecBuilder
  - setProxy
```
public RequestSpecBuilder setProxy(String host)
```
    Instruct REST Assured to connect to a proxy on the specified host on port 8888.
    
    Parameters:
    
    host - The hostname of the proxy to connect to (for example 127.0.0.1). Can also be a URI represented as a String.
    
    Returns:
    
    RequestSpecBuilder
    
    See Also:
    
    setProxy(String)
  - setProxy
```
public RequestSpecBuilder setProxy(int port)
```
    Instruct REST Assured to connect to a proxy on the specified port on localhost.
    
    Parameters:
    
    port - The port of the proxy to connect to (for example 8888)
    
    Returns:
    
    RequestSpecBuilder
    
    See Also:
    
    setProxy(int)
  - setProxy
```
public RequestSpecBuilder setProxy(String host,
                                   int port,
                                   String scheme)
```
    Instruct REST Assured to connect to a proxy on the specified port on localhost with a specific scheme.
    
    Parameters:
    
    host - The hostname of the proxy to connect to (for example 127.0.0.1)
    
    port - The port of the proxy to connect to (for example 8888)
    
    scheme - The http scheme (http or https)
    
    Returns:
    
    RequestSpecBuilder
  - setProxy
```
public RequestSpecBuilder setProxy(URI uri)
```
    Instruct REST Assured to connect to a proxy using a URI.
    
    Parameters:
    
    uri - The URI of the proxy
    
    Returns:
    
    RequestSpecBuilder
  - setProxy
```
public RequestSpecBuilder setProxy(ProxySpecification proxySpecification)
```
    Instruct REST Assured to connect to a proxy using a ProxySpecification.
    
    Parameters:
    
    proxySpecification - The proxy specification to use.
    
    Returns:
    
    RequestSpecBuilder
    
    See Also:
    
    RequestSpecification.proxy(ProxySpecification)
  - and
```
public RequestSpecBuilder and()
```
    Syntactic sugar.
    
    Returns:
    
    the same RequestSpecBuilder instance

Class RequestSpecBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestSpecBuilder

Method Detail

setBody

setBody

setBody

setBody

setBody

addCookies

addCookie

addCookie

addCookie

addCookies

addFilter

addFilters

addParams

addParam

addParam

removeParam

addQueryParam

addQueryParams

addQueryParam

removeQueryParam

addFormParam

addFormParams

addFormParam

removeFormParam

addPathParam

addPathParams

addPathParams

removePathParam

setKeyStore

setTrustStore

SSL Configuration

SSLPeerUnverifiedException

setTrustStore

SSL Configuration

SSLPeerUnverifiedException

addHeaders

addHeader

setContentType

setContentType

setAccept

setAccept

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

addMultiPart

setAuth

setPort

setUrlEncodingEnabled

setSessionId

setSessionId

addRequestSpecification

setConfig

build

setBaseUri

setBaseUri

setBasePath

log

setTrustStore

setKeyStore

setRelaxedHTTPSValidation

setRelaxedHTTPSValidation

setProxy

setProxy

setProxy

setProxy

setProxy

setProxy