com.github.mjeanroy.junit.servers.client

Interface HttpResponse

All Known Implementing Classes:

AbstractHttpResponse, DefaultHttpResponse

public interface HttpResponse

Http response, defined by:

• A status code: http return code (i.e 200, 400, 500 etc.).
• A response body: this is the body of the http response as textual representation.
• A set of headers.
• Duration: time to produce http response.

See Also:

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

Method Summary

Modifier and Type	Method and Description
String	body() Http response body.
boolean	containsHeader(String name) Check that given header is available.
HttpHeader	getCacheControl() Get Cache-Control header from http response.
HttpHeader	getContentEncoding() Get Content-Encoding header from http response.
HttpHeader	getContentSecurityPolicy() Get Content-Security-Policy header from http response.
HttpHeader	getContentType() Get Content-Type header from http response.
Cookie	getCookie(String name) Get cookie by its name (if cookie is missing, null is returned).
List<Cookie>	getCookies() Get all cookies sent by server.
HttpHeader	getETag() Get ETag header from http response.
HttpHeader	getHeader(String name) Get header from HTTP response (if header is missing, null will be returned).
Collection<HttpHeader>	getHeaders() Get the list of headers.
HttpHeader	getLastModified() Get Last-Modified header from http response.
HttpHeader	getLocation() Get Location header from http response.
long	getRequestDuration() Get duration of request execution in nano seconds.
long	getRequestDurationInMillis() Get duration of request execution in milli seconds (shortcut for getRequestDuration() / 100).
HttpHeader	getStrictTransportSecurity() Get Strict-Transport-Security header from http response.
HttpHeader	getXContentSecurityPolicy() Get X-Content-Security-Policy header from http response: this header was initially an experimental header implemented in Firefox.
HttpHeader	getXContentTypeOptions() Get X-Content-Type-Options header from http response.
HttpHeader	getXWebkitCSP() Get X-Webkit-CSP header from http response: this header was initially an experimental header implemented in Webkit browser (Chrome and Safari).
HttpHeader	getXXSSProtection() Get X-XSS-Protection header from http response.
int	status() Http status code.

Method Detail

getRequestDuration

long getRequestDuration()

Get duration of request execution in nano seconds.

Returns:

Request execution duration.

getRequestDurationInMillis

long getRequestDurationInMillis()

Get duration of request execution in milli seconds (shortcut for getRequestDuration() / 100).

Returns:

Request execution duration.

See Also:

getRequestDuration()

status

int status()

Http status code.

Returns:

Status code.

See Also:

https://tools.ietf.org/html/rfc2616#section-6.1, https://tools.ietf.org/html/rfc2616#section-10

body

String body()

Http response body.

Returns:

Body.

See Also:

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

getHeaders

Collection<HttpHeader> getHeaders()

Get the list of headers.

Returns:

Header list.

See Also:

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

containsHeader

boolean containsHeader(String name)

Check that given header is available.

Parameters:

name - Header name.

Returns:

true if header is in response, false otherwise.

See Also:

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

getHeader

HttpHeader getHeader(String name)

Get header from HTTP response (if header is missing, null will be returned).

Parameters:

name - Header name.

Returns:

Header, null if header is not in http response.

Throws:

NullPointerException - If name is null.

See Also:

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

getCookie

Cookie getCookie(String name)

Get cookie by its name (if cookie is missing, null is returned).

Parameters:

name - Cookie name.

Returns:

Cookie.

See Also:

HttpHeaders.SET_COOKIE, https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie, https://tools.ietf.org/html/rfc6265#section-4.1

getCookies

List<Cookie> getCookies()

Get all cookies sent by server.

Returns:

Cookies.

See Also:

HttpHeaders.SET_COOKIE, https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie, https://tools.ietf.org/html/rfc6265#section-4.1

getETag

HttpHeader getETag()

Get ETag header from http response.

Returns:

ETag header.

See Also:

getHeader(String), HttpHeaders.ETAG, https://tools.ietf.org/html/rfc7232#section-2.3

getContentType

HttpHeader getContentType()

Get Content-Type header from http response.

Returns:

Content-Type header.

See Also:

getHeader(String), HttpHeaders.CONTENT_TYPE, https://www.w3.org/Protocols/rfc1341/4_Content-Type.html

getContentEncoding

HttpHeader getContentEncoding()

Get Content-Encoding header from http response.

Returns:

Content-Encoding header.

See Also:

HttpHeaders.CONTENT_ENCODING, https://tools.ietf.org/html/rfc7231#section-3.1.2.2

getLocation

HttpHeader getLocation()

Get Location header from http response.

Returns:

Location header.

See Also:

getHeader(String), HttpHeaders.LOCATION, https://tools.ietf.org/html/rfc7231#section-7.1.2

getCacheControl

HttpHeader getCacheControl()

Get Cache-Control header from http response.

Returns:

Cache-Control header.

See Also:

getHeader(String), HttpHeaders.CACHE_CONTROL, https://tools.ietf.org/html/rfc7234#section-5.2

getLastModified

HttpHeader getLastModified()

Get Last-Modified header from http response.

Returns:

Last-Modified header.

See Also:

getHeader(String), HttpHeaders.LAST_MODIFIED, https://tools.ietf.org/html/rfc7232#section-2.2

getStrictTransportSecurity

HttpHeader getStrictTransportSecurity()

Get Strict-Transport-Security header from http response.

Returns:

Strict-Transport-Security header.

See Also:

getHeader(String), HttpHeaders.STRICT_TRANSPORT_SECURITY, https://tools.ietf.org/html/rfc6797

getContentSecurityPolicy

HttpHeader getContentSecurityPolicy()

Get Content-Security-Policy header from http response.

Returns:

Content-Security-Policy header.

See Also:

getHeader(String), HttpHeaders.CONTENT_SECURITY_POLICY, https://www.w3.org/TR/2011/WD-CSP-20111129/, https://content-security-policy.com/

getXContentSecurityPolicy

HttpHeader getXContentSecurityPolicy()

Get X-Content-Security-Policy header from http response: this header was initially an experimental header implemented in Firefox.

Returns:

X-Content-Security-Policy header.

See Also:

getHeader(String), HttpHeaders.X_CONTENT_SECURITY_POLICY, https://www.w3.org/TR/2011/WD-CSP-20111129/, https://content-security-policy.com/

getXWebkitCSP

HttpHeader getXWebkitCSP()

Get X-Webkit-CSP header from http response: this header was initially an experimental header implemented in Webkit browser (Chrome and Safari).

Returns:

}X-Content-Security-Policy header.

See Also:

getHeader(String), HttpHeaders.X_WEBKIT_CSP, https://www.w3.org/TR/2011/WD-CSP-20111129/, https://content-security-policy.com/

getXContentTypeOptions

HttpHeader getXContentTypeOptions()

Get X-Content-Type-Options header from http response.

Returns:

X-Content-Type-Options header.

See Also:

getHeader(String), HttpHeaders.X_CONTENT_TYPE_OPTIONS, https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options

getXXSSProtection

HttpHeader getXXSSProtection()

Get X-XSS-Protection header from http response.

Returns:

X-XSS-Protection header.

See Also:

getHeader(String), HttpHeaders.X_XSS_PROTECTION, https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection