AbstractHttpRequest (junit-servers-core 2.0.0 API)

java.lang.Object
- com.github.mjeanroy.junit.servers.client.impl.AbstractHttpRequest

All Implemented Interfaces:

HttpRequest
```
public abstract class AbstractHttpRequest
extends Object
implements HttpRequest
```
Abstract skeleton of HttpRequest interface.
This abstract class is not part of the public API and should not be used publicly.

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpRequestBody`	`body` The request body.
`protected List<Cookie>`	`cookies` Cookie elements.
`protected Map<String,HttpHeader>`	`headers` HTTP Headers.
`protected Map<String,HttpParameter>`	`queryParams` Request parameters.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractHttpRequest(HttpUrl endpoint, HttpMethod method)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractHttpRequest(HttpUrl endpoint, HttpMethod method)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`acceptGzip()` Add `Accept-Encoding` header with `"gzip, deflate"` value.
`HttpRequest`	`acceptJson()` Add header to specify that accept type is `"application/json"`.
`HttpRequest`	`acceptLanguage(String lang)` Add `Accept-Language` header.
`HttpRequest`	`acceptXml()` Add header to specify that accept type is `"application/xml"`.
`HttpRequest`	`addAcceptEncoding(String encoding)` Add `Accept-Encoding` header.
`HttpRequest`	`addCookie(Cookie cookie)` Add cookie to http request.
`HttpRequest`	`addCookie(String name, String value)` Add cookie to http request.
`HttpRequest`	`addCsrfToken(String token)` Add CSRF Token to http header (`X-Csrf-Token` header).
`HttpRequest`	`addHeader(HttpHeader header)` Add header.
`HttpRequest`	`addHeader(String name, String value)` Add header.
`HttpRequest`	`addIfMatch(String etag)` Add `If-Match` header with expected value.
`HttpRequest`	`addIfModifiedSince(Date date)` Add `If-Modified-Since` value with expected date (date will be translated as GMT raw).
`HttpRequest`	`addIfNoneMatch(String etag)` Add `If-None-Match` header with expected value.
`HttpRequest`	`addIfUnmodifiedSince(Date date)` Add `If-Unmodified-Since` value with expected date (date will be translated as GMT raw).
`HttpRequest`	`addOrigin(String origin)` Add `Origin` header.
`HttpRequest`	`addQueryParam(String name, String value)` Add query parameters: a query parameter is a parameter that will follow the `?` character in the request URL.
`HttpRequest`	`addQueryParams(HttpParameter parameter, HttpParameter... parameters)` Add collection of query parameters: a query parameter is a parameter that will follow the `?` character in the request URL.
`HttpRequest`	`addReferer(String referer)` Add `Referer` header.
`HttpRequest`	`addXHttpMethodOverride(String method)` Add `X-Http-Method-Override` value with HTTP verb to override.
`HttpRequest`	`asFormUrlEncoded()` Add header to specify that content type is `"application/x-www-form-urlencoded"`.
`HttpRequest`	`asJson()` Add header to specify that content type is `"application/json"`.
`HttpRequest`	`asXml()` Add header to specify that content type is `"application/xml"`.
`HttpRequest`	`asXmlHttpRequest()` Most library (such as jQuery) add automatically header named "X-Requested-With" with value "XMLHttpRequest", this method add this header and can be used to simulate ajax call.
`protected abstract HttpResponse`	`doExecute()` Execute request.
`HttpResponse`	`execute()` Execute request and return http response: execution is synchronous and will block until response is available.
`HttpResponse`	`executeJson()` Execute request and return http response: execution is synchronous and will block until response is available.
`HttpResponse`	`executeXml()` Execute request and return http response: execution is synchronous and will block until response is available.
`HttpUrl`	`getEndpoint()` Request URL.
`HttpMethod`	`getMethod()` Return http request method.
`protected boolean`	`hasBody()` Check if the request have a body content (form parameters or request body value).
`HttpRequest`	`overrideDelete()` Add `X-Http-Method-Override` value with `DELETE` value.
`HttpRequest`	`overridePut()` Add @{code X-Http-Method-Override} value with `PUT` value.
`HttpRequest`	`setBody(HttpRequestBody body)` Set request body.
`HttpRequest`	`withUserAgent(String userAgent)` Add `User-Agent` header to http request.

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

- Field Detail
  - queryParams
```
protected final Map<String,HttpParameter> queryParams
```
    Request parameters. Query parameters are the parameters following ? character in the URL.
  - body
```
protected HttpRequestBody body
```
    The request body.
  - cookies
```
protected final List<Cookie> cookies
```
    Cookie elements.
  - headers
```
protected final Map<String,HttpHeader> headers
```
    HTTP Headers.
- Constructor Detail
  - AbstractHttpRequest
```
protected AbstractHttpRequest(HttpUrl endpoint,
                              HttpMethod method)
```
- Method Detail
  - getEndpoint
```
public HttpUrl getEndpoint()
```
    Description copied from interface: HttpRequest
    
    Request URL.
    
    Specified by:
    
    getEndpoint in interface HttpRequest
    
    Returns:
    
    The request endpoint.
  - getMethod
```
public HttpMethod getMethod()
```
    Description copied from interface: HttpRequest
    
    Return http request method.
    
    Specified by:
    
    getMethod in interface HttpRequest
    
    Returns:
    
    Method.
  - addHeader
```
public HttpRequest addHeader(String name,
                             String value)
```
    Description copied from interface: HttpRequest
    
    Add header.
    
    Specified by:
    
    addHeader in interface HttpRequest
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpRequest.addHeader(HttpHeader)
  - addHeader
```
public HttpRequest addHeader(HttpHeader header)
```
    Description copied from interface: HttpRequest
    
    Add header.
    
    Specified by:
    
    addHeader in interface HttpRequest
    
    Parameters:
    
    header - The header.
    
    Returns:
    
    Http request that can be used for chaining.
  - asXmlHttpRequest
```
public HttpRequest asXmlHttpRequest()
```
    Description copied from interface: HttpRequest
    
    Most library (such as jQuery) add automatically header named "X-Requested-With" with value "XMLHttpRequest", this method add this header and can be used to simulate ajax call.
    
    Specified by:
    
    asXmlHttpRequest in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.REQUESTED_WITH, HttpHeaders.XML_HTTP_REQUEST
  - acceptLanguage
```
public HttpRequest acceptLanguage(String lang)
```
    Description copied from interface: HttpRequest
    
    Add Accept-Language header.
    
    Specified by:
    
    acceptLanguage in interface HttpRequest
    
    Parameters:
    
    lang - Accepted languages.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ACCEPT_LANGUAGE, https://tools.ietf.org/html/rfc7231#section-5.3.5
  - addAcceptEncoding
```
public HttpRequest addAcceptEncoding(String encoding)
```
    Description copied from interface: HttpRequest
    
    Add Accept-Encoding header.
    
    Specified by:
    
    addAcceptEncoding in interface HttpRequest
    
    Parameters:
    
    encoding - Encoding value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ACCEPT_ENCODING, https://tools.ietf.org/html/rfc7231#section-5.3.4
  - acceptGzip
```
public HttpRequest acceptGzip()
```
    Description copied from interface: HttpRequest
    
    Add Accept-Encoding header with "gzip, deflate" value.
    
    Specified by:
    
    acceptGzip in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ACCEPT_ENCODING, https://tools.ietf.org/html/rfc7231#section-5.3.4, HttpRequest.addAcceptEncoding(String)
  - addOrigin
```
public HttpRequest addOrigin(String origin)
```
    Description copied from interface: HttpRequest
    
    Add Origin header.
    
    Specified by:
    
    addOrigin in interface HttpRequest
    
    Parameters:
    
    origin - Origin value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ORIGIN, https://tools.ietf.org/html/rfc6454
  - addReferer
```
public HttpRequest addReferer(String referer)
```
    Description copied from interface: HttpRequest
    
    Add Referer header.
    
    Specified by:
    
    addReferer in interface HttpRequest
    
    Parameters:
    
    referer - Referer value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.REFERER, https://tools.ietf.org/html/rfc7231#section-5.5.2
  - addIfNoneMatch
```
public HttpRequest addIfNoneMatch(String etag)
```
    Description copied from interface: HttpRequest
    
    Add If-None-Match header with expected value. This header should work with ETag header sent by server response.
    
    Specified by:
    
    addIfNoneMatch in interface HttpRequest
    
    Parameters:
    
    etag - ETag value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.IF_NONE_MATCH, https://tools.ietf.org/html/rfc7232#section-3.2
  - addIfMatch
```
public HttpRequest addIfMatch(String etag)
```
    Description copied from interface: HttpRequest
    
    Add If-Match header with expected value. This header should work with ETag header sent by server response.
    
    Specified by:
    
    addIfMatch in interface HttpRequest
    
    Parameters:
    
    etag - ETag value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.IF_MATCH, https://tools.ietf.org/html/rfc7232#section-3.1
  - addIfModifiedSince
```
public HttpRequest addIfModifiedSince(Date date)
```
    Description copied from interface: HttpRequest
    
    Add If-Modified-Since value with expected date (date will be translated as GMT raw).
    
    Specified by:
    
    addIfModifiedSince in interface HttpRequest
    
    Parameters:
    
    date - Date.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.IF_MODIFIED_SINCE, https://tools.ietf.org/html/rfc7232#section-3.3
  - addIfUnmodifiedSince
```
public HttpRequest addIfUnmodifiedSince(Date date)
```
    Description copied from interface: HttpRequest
    
    Add If-Unmodified-Since value with expected date (date will be translated as GMT raw).
    
    Specified by:
    
    addIfUnmodifiedSince in interface HttpRequest
    
    Parameters:
    
    date - Date.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.IF_UNMODIFIED_SINCE, https://tools.ietf.org/html/rfc7232#section-3.4
  - withUserAgent
```
public HttpRequest withUserAgent(String userAgent)
```
    Description copied from interface: HttpRequest
    
    Add User-Agent header to http request.
    
    Specified by:
    
    withUserAgent in interface HttpRequest
    
    Parameters:
    
    userAgent - User-Agent value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.USER_AGENT, https://tools.ietf.org/html/rfc2616#section-14.43
  - asJson
```
public HttpRequest asJson()
```
    Description copied from interface: HttpRequest
    
    Add header to specify that content type is "application/json".
    
    Specified by:
    
    asJson in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON, https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
  - asXml
```
public HttpRequest asXml()
```
    Description copied from interface: HttpRequest
    
    Add header to specify that content type is "application/xml".
    
    Specified by:
    
    asXml in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML, https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
  - asFormUrlEncoded
```
public HttpRequest asFormUrlEncoded()
```
    Description copied from interface: HttpRequest
    
    Add header to specify that content type is "application/x-www-form-urlencoded".
    
    Specified by:
    
    asFormUrlEncoded in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    MediaType.APPLICATION_FORM_URL_ENCODED, https://tools.ietf.org/html/draft-hoehrmann-urlencoded-01
  - addQueryParam
```
public HttpRequest addQueryParam(String name,
                                 String value)
```
    Description copied from interface: HttpRequest
    
    Add query parameters: a query parameter is a parameter that will follow the ? character in the request URL.
    
    Specified by:
    
    addQueryParam in interface HttpRequest
    
    Parameters:
    
    name - Parameter name.
    
    value - Parameter value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    https://tools.ietf.org/html/rfc3986#section-3.4
  - addQueryParams
```
public HttpRequest addQueryParams(HttpParameter parameter,
                                  HttpParameter... parameters)
```
    Description copied from interface: HttpRequest
    
    Add collection of query parameters: a query parameter is a parameter that will follow the ? character in the request URL.
    
    Specified by:
    
    addQueryParams in interface HttpRequest
    
    Parameters:
    
    parameter - Parameter.
    
    parameters - Optional next parameters.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    https://tools.ietf.org/html/rfc3986#section-3.4
  - setBody
```
public HttpRequest setBody(HttpRequestBody body)
```
    Description copied from interface: HttpRequest
    
    Set request body. This method should be used for "POST", "PUT" or "PATCH" request only, otherwise it will throw UnsupportedOperationException exception.
    
    Specified by:
    
    setBody in interface HttpRequest
    
    Parameters:
    
    body - Body request.
    
    Returns:
    
    Http request that can be used for chaining.
  - acceptJson
```
public HttpRequest acceptJson()
```
    Description copied from interface: HttpRequest
    
    Add header to specify that accept type is "application/json".
    
    Specified by:
    
    acceptJson in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON, https://tools.ietf.org/html/rfc7231#section-5.3.2
  - acceptXml
```
public HttpRequest acceptXml()
```
    Description copied from interface: HttpRequest
    
    Add header to specify that accept type is "application/xml".
    
    Specified by:
    
    acceptXml in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.ACCEPT, MediaType.APPLICATION_XML, https://tools.ietf.org/html/rfc7231#section-5.3.2
  - addXHttpMethodOverride
```
public HttpRequest addXHttpMethodOverride(String method)
```
    Description copied from interface: HttpRequest
    
    Add X-Http-Method-Override value with HTTP verb to override. This method is generally used with POST request to override PUT or DELETE requests.
    
    Specified by:
    
    addXHttpMethodOverride in interface HttpRequest
    
    Parameters:
    
    method - Http method to override.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.X_HTTP_METHOD_OVERRIDE
  - addCsrfToken
```
public HttpRequest addCsrfToken(String token)
```
    Description copied from interface: HttpRequest
    
    Add CSRF Token to http header (X-Csrf-Token header).
    
    Specified by:
    
    addCsrfToken in interface HttpRequest
    
    Parameters:
    
    token - Token value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.X_CSRF_TOKEN
  - overridePut
```
public HttpRequest overridePut()
```
    Description copied from interface: HttpRequest
    
    Add @{code X-Http-Method-Override} value with PUT value.
    
    Specified by:
    
    overridePut in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.X_HTTP_METHOD_OVERRIDE, HttpRequest.addXHttpMethodOverride(String)
  - overrideDelete
```
public HttpRequest overrideDelete()
```
    Description copied from interface: HttpRequest
    
    Add X-Http-Method-Override value with DELETE value.
    
    Specified by:
    
    overrideDelete in interface HttpRequest
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.X_HTTP_METHOD_OVERRIDE, HttpRequest.addXHttpMethodOverride(String)
  - addCookie
```
public HttpRequest addCookie(Cookie cookie)
```
    Description copied from interface: HttpRequest
    
    Add cookie to http request.
    
    Specified by:
    
    addCookie in interface HttpRequest
    
    Parameters:
    
    cookie - Cookie.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.COOKIE, https://developer.mozilla.org/fr/docs/Web/HTTP/Headers/Cookie, https://tools.ietf.org/html/rfc6265#section-5.4
  - addCookie
```
public HttpRequest addCookie(String name,
                             String value)
```
    Description copied from interface: HttpRequest
    
    Add cookie to http request.
    
    Specified by:
    
    addCookie in interface HttpRequest
    
    Parameters:
    
    name - Cookie name.
    
    value - Cookie value.
    
    Returns:
    
    Http request that can be used for chaining.
    
    See Also:
    
    HttpHeaders.COOKIE, HttpRequest.addCookie(Cookie), https://developer.mozilla.org/fr/docs/Web/HTTP/Headers/Cookie, https://tools.ietf.org/html/rfc6265#section-5.4
  - execute
```
public HttpResponse execute()
```
    Description copied from interface: HttpRequest
    
    Execute request and return http response: execution is synchronous and will block until response is available.
    
    Specified by:
    
    execute in interface HttpRequest
    
    Returns:
    
    Http response.
  - executeJson
```
public HttpResponse executeJson()
```
    Description copied from interface: HttpRequest
    
    Execute request and return http response: execution is synchronous and will block until response is available.
    This method automatically add json header (i.e methods HttpRequest.asJson() and HttpRequest.acceptJson() will be automatically be called before execution).
    
    Specified by:
    
    executeJson in interface HttpRequest
    
    Returns:
    
    Http response.
    
    See Also:
    
    HttpRequest.acceptJson(), HttpRequest.asJson()
  - executeXml
```
public HttpResponse executeXml()
```
    Description copied from interface: HttpRequest
    
    Execute request and return http response: execution is synchronous and will block until response is available.
    This method automatically add xml header (i.e methods HttpRequest.asXml() and HttpRequest.acceptXml() will be automatically called before execution).
    
    Specified by:
    
    executeXml in interface HttpRequest
    
    Returns:
    
    Http response.
    
    See Also:
    
    HttpRequest.acceptXml(), HttpRequest.asXml()
  - hasBody
```
protected boolean hasBody()
```
    Check if the request have a body content (form parameters or request body value).
    
    Returns:
    
    true if request has a body, false otherwise.
  - doExecute
```
protected abstract HttpResponse doExecute()
                                   throws Exception
```
    Execute request. Exception will be automatically translated into an instance of HttpClientException.
    
    Returns:
    
    Http response.
    
    Throws:
    
    Exception - If an error occurred.

Class AbstractHttpRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

queryParams

body

cookies

headers

Constructor Detail

AbstractHttpRequest

Method Detail

getEndpoint

getMethod

addHeader

addHeader

asXmlHttpRequest

acceptLanguage

addAcceptEncoding

acceptGzip

addOrigin

addReferer

addIfNoneMatch

addIfMatch

addIfModifiedSince

addIfUnmodifiedSince

withUserAgent

asJson

asXml

asFormUrlEncoded

addQueryParam

addQueryParams

setBody

acceptJson

acceptXml

addXHttpMethodOverride

addCsrfToken

overridePut

overrideDelete

addCookie

addCookie

execute

executeJson

executeXml

hasBody

doExecute