com.github.mjeanroy.junit.servers.client.impl

Class AbstractHttpResponse

java.lang.Object

com.github.mjeanroy.junit.servers.client.impl.AbstractHttpResponse

All Implemented Interfaces:

HttpResponse

Direct Known Subclasses:

DefaultHttpResponse

public abstract class AbstractHttpResponse
extends Object
implements HttpResponse

Abstract skeleton of HttpResponse interface.

This abstract class is not part of the public API and should not be used publicly.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpResponse(long duration) Create the partial HTTP response implementation.

Method Summary

Modifier and Type	Method and Description
String	body() Http response body.
protected boolean	canEqual(AbstractHttpResponse o) Ensure that given object o can be equal to this.
boolean	containsHeader(String name) Check that given header is available.
boolean	equals(Object o)
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	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	hashCode()
protected abstract String	readResponseBody() Read HTTP Response _body as a String.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.mjeanroy.junit.servers.client.HttpResponse

getHeader, getHeaders, status

Constructor Detail

AbstractHttpResponse

protected AbstractHttpResponse(long duration)

Create the partial HTTP response implementation.

Parameters:

duration - Original request duration.

Method Detail

getRequestDuration

public long getRequestDuration()

Description copied from interface: HttpResponse

Get duration of request execution in nano seconds.

Specified by:

getRequestDuration in interface HttpResponse

Returns:

Request execution duration.

getRequestDurationInMillis

public long getRequestDurationInMillis()

Description copied from interface: HttpResponse

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

Specified by:

getRequestDurationInMillis in interface HttpResponse

Returns:

Request execution duration.

See Also:

HttpResponse.getRequestDuration()

body

public String body()

Description copied from interface: HttpResponse

Http response body.

Specified by:

body in interface HttpResponse

Returns:

Body.

See Also:

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

readResponseBody

protected abstract String readResponseBody()
                                    throws IOException

Read HTTP Response _body as a String.

Returns:

The response _body.

Throws:

IOException - If an error occurred while reading _body.

containsHeader

public boolean containsHeader(String name)

Description copied from interface: HttpResponse

Check that given header is available.

Specified by:

containsHeader in interface HttpResponse

Parameters:

name - Header name.

Returns:

true if header is in response, false otherwise.

See Also:

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

getCookie

public Cookie getCookie(String name)

Description copied from interface: HttpResponse

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

Specified by:

getCookie in interface HttpResponse

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

public List<Cookie> getCookies()

Description copied from interface: HttpResponse

Get all cookies sent by server.

Specified by:

getCookies in interface HttpResponse

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

public HttpHeader getETag()

Description copied from interface: HttpResponse

Get ETag header from http response.

Specified by:

getETag in interface HttpResponse

Returns:

ETag header.

See Also:

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

getContentType

public HttpHeader getContentType()

Description copied from interface: HttpResponse

Get Content-Type header from http response.

Specified by:

getContentType in interface HttpResponse

Returns:

Content-Type header.

See Also:

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

getContentEncoding

public HttpHeader getContentEncoding()

Description copied from interface: HttpResponse

Get Content-Encoding header from http response.

Specified by:

getContentEncoding in interface HttpResponse

Returns:

Content-Encoding header.

See Also:

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

getLocation

public HttpHeader getLocation()

Description copied from interface: HttpResponse

Get Location header from http response.

Specified by:

getLocation in interface HttpResponse

Returns:

Location header.

See Also:

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

getCacheControl

public HttpHeader getCacheControl()

Description copied from interface: HttpResponse

Get Cache-Control header from http response.

Specified by:

getCacheControl in interface HttpResponse

Returns:

Cache-Control header.

See Also:

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

getLastModified

public HttpHeader getLastModified()

Description copied from interface: HttpResponse

Get Last-Modified header from http response.

Specified by:

getLastModified in interface HttpResponse

Returns:

Last-Modified header.

See Also:

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

getStrictTransportSecurity

public HttpHeader getStrictTransportSecurity()

Description copied from interface: HttpResponse

Get Strict-Transport-Security header from http response.

Specified by:

getStrictTransportSecurity in interface HttpResponse

Returns:

Strict-Transport-Security header.

See Also:

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

getContentSecurityPolicy

public HttpHeader getContentSecurityPolicy()

Description copied from interface: HttpResponse

Get Content-Security-Policy header from http response.

Specified by:

getContentSecurityPolicy in interface HttpResponse

Returns:

Content-Security-Policy header.

See Also:

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

getXContentSecurityPolicy

public HttpHeader getXContentSecurityPolicy()

Description copied from interface: HttpResponse

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

Specified by:

getXContentSecurityPolicy in interface HttpResponse

Returns:

X-Content-Security-Policy header.

See Also:

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

getXWebkitCSP

public HttpHeader getXWebkitCSP()

Description copied from interface: HttpResponse

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

Specified by:

getXWebkitCSP in interface HttpResponse

Returns:

}X-Content-Security-Policy header.

See Also:

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

getXContentTypeOptions

public HttpHeader getXContentTypeOptions()

Description copied from interface: HttpResponse

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

Specified by:

getXContentTypeOptions in interface HttpResponse

Returns:

X-Content-Type-Options header.

See Also:

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

getXXSSProtection

public HttpHeader getXXSSProtection()

Description copied from interface: HttpResponse

Get X-XSS-Protection header from http response.

Specified by:

getXXSSProtection in interface HttpResponse

Returns:

X-XSS-Protection header.

See Also:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

canEqual

protected boolean canEqual(AbstractHttpResponse o)

Ensure that given object o can be equal to this.

Parameters:

o - The HTTP Response.

Returns:

The flag.