Package com.github.mjeanroy.junit.servers.client

Interface HttpRequest

All Known Implementing Classes:

AbstractHttpRequest

public interface HttpRequest

HTTP request.

See Also:

• https://tools.ietf.org/html/rfc2616#section-5

Method Summary

Modifier and Type	Method	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.
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.
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.

Method Details

getEndpoint

HttpUrl getEndpoint()

Request URL.

Returns:

The request endpoint.

getMethod

HttpMethod getMethod()

Return http request method.

Returns:

Method.

addHeader

HttpRequest addHeader(String name,
 String value)

Add header.

Parameters:

name - Header name.

value - Header value.

Returns:

Http request that can be used for chaining.

Throws:

NullPointerException - If name or value is null.

IllegalArgumentException - if name is blank.

See Also:

• addHeader(HttpHeader)

addHeader

HttpRequest addHeader(HttpHeader header)

Add header.

Parameters:

header - The header.

Returns:

Http request that can be used for chaining.

Throws:

NullPointerException - If header is null.

addQueryParam

HttpRequest addQueryParam(String name,
 String value)

Add query parameters: a query parameter is a parameter that will follow the ? character in the request URL.

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

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.

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

HttpRequest setBody(HttpRequestBody body)

Set request body. This method should be used for "POST", "PUT" or "PATCH" request only, otherwise it will throw UnsupportedOperationException exception.

Parameters:

body - Body request.

Returns:

Http request that can be used for chaining.

Throws:

UnsupportedOperationException - If request method does not allow body (i.e GET, HEAD or DELETE).

asXmlHttpRequest

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.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.REQUESTED_WITH
• HttpHeaders.XML_HTTP_REQUEST

asFormUrlEncoded

HttpRequest asFormUrlEncoded()

Add header to specify that content type is "application/x-www-form-urlencoded".

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

asJson

HttpRequest asJson()

Add header to specify that content type is "application/json".

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

HttpRequest asXml()

Add header to specify that content type is "application/xml".

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

acceptJson

HttpRequest acceptJson()

Add header to specify that accept type is "application/json".

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

HttpRequest acceptXml()

Add header to specify that accept type is "application/xml".

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

acceptLanguage

HttpRequest acceptLanguage(String lang)

Add Accept-Language header.

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

addOrigin

HttpRequest addOrigin(String origin)

Add Origin header.

Parameters:

origin - Origin value.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.ORIGIN
• https://tools.ietf.org/html/rfc6454

addReferer

HttpRequest addReferer(String referer)

Add Referer header.

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

addAcceptEncoding

HttpRequest addAcceptEncoding(String encoding)

Add Accept-Encoding header.

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

HttpRequest acceptGzip()

Add Accept-Encoding header with "gzip, deflate" 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
• addAcceptEncoding(String)

withUserAgent

HttpRequest withUserAgent(String userAgent)

Add User-Agent header to http request.

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

addCookie

HttpRequest addCookie(Cookie cookie)

Add cookie to http request.

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

HttpRequest addCookie(String name,
 String value)

Add cookie to http request.

Parameters:

name - Cookie name.

value - Cookie value.

Returns:

Http request that can be used for chaining.

Throws:

NullPointerException - If name or value are null.

IllegalArgumentException - If name is empty or blank.

See Also:

• HttpHeaders.COOKIE
• addCookie(Cookie)
• https://developer.mozilla.org/fr/docs/Web/HTTP/Headers/Cookie
• https://tools.ietf.org/html/rfc6265#section-5.4

addIfNoneMatch

HttpRequest addIfNoneMatch(String etag)

Add If-None-Match header with expected value. This header should work with ETag header sent by server response.

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

HttpRequest addIfMatch(String etag)

Add If-Match header with expected value. This header should work with ETag header sent by server response.

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

HttpRequest addIfModifiedSince(Date date)

Add If-Modified-Since value with expected date (date will be translated as GMT raw).

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

HttpRequest addIfUnmodifiedSince(Date date)

Add If-Unmodified-Since value with expected date (date will be translated as GMT raw).

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

addXHttpMethodOverride

HttpRequest addXHttpMethodOverride(String method)

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.

Parameters:

method - Http method to override.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.X_HTTP_METHOD_OVERRIDE

addCsrfToken

HttpRequest addCsrfToken(String token)

Add CSRF Token to http header (X-Csrf-Token header).

Parameters:

token - Token value.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.X_CSRF_TOKEN

overridePut

HttpRequest overridePut()

Add @{code X-Http-Method-Override} value with PUT value.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.X_HTTP_METHOD_OVERRIDE
• addXHttpMethodOverride(String)

overrideDelete

HttpRequest overrideDelete()

Add X-Http-Method-Override value with DELETE value.

Returns:

Http request that can be used for chaining.

See Also:

• HttpHeaders.X_HTTP_METHOD_OVERRIDE
• addXHttpMethodOverride(String)

execute

HttpResponse execute()

Execute request and return http response: execution is synchronous and will block until response is available.

Returns:

Http response.

executeJson

HttpResponse executeJson()

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 asJson() and acceptJson() will be automatically be called before execution).

Returns:

Http response.

See Also:

• acceptJson()
• asJson()

executeXml

HttpResponse executeXml()

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 asXml() and acceptXml() will be automatically called before execution).

Returns:

Http response.

See Also:

• acceptXml()
• asXml()