Module org.refcodes.web

Package org.refcodes.web

Interface HttpClientResponse

All Superinterfaces:

HeaderFieldsAccessor<ResponseHeaderFields>, HttpBodyAccessor, HttpInputStreamAccessor, HttpResponse, HttpStatusCodeAccessor, UrlAccessor

All Known Implementing Classes:

HttpClientResponseImpl

public interface HttpClientResponse
extends HttpResponse, HttpBodyAccessor, HttpInputStreamAccessor, UrlAccessor

Defines a HttpClientResponse being the response as consumed by the client.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.HeaderFieldsAccessor

HeaderFieldsAccessor.HeaderFieldsBuilder<T extends HeaderFields<?,?>,B extends HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>>, HeaderFieldsAccessor.HeaderFieldsMutator<T extends HeaderFields<?,?>>, HeaderFieldsAccessor.HeaderFieldsProperty<T extends HeaderFields<?,?>>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpBodyAccessor

HttpBodyAccessor.HttpBodyBuilder<B extends HttpBodyAccessor.HttpBodyBuilder<B>>, HttpBodyAccessor.HttpBodyMutator, HttpBodyAccessor.HttpBodyProperty, HttpBodyAccessor.HttpBodyProvider<EXC extends Exception>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpInputStreamAccessor

HttpInputStreamAccessor.HttpInputStreamBuilder<B extends HttpInputStreamAccessor.HttpInputStreamBuilder<B>>, HttpInputStreamAccessor.HttpInputStreamMutator, HttpInputStreamAccessor.HttpInputStreamProperty, HttpInputStreamAccessor.HttpInputStreamProvider<EXC extends Exception>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpStatusCodeAccessor

HttpStatusCodeAccessor.HttpStatusCodeBuilder<B extends HttpStatusCodeAccessor.HttpStatusCodeBuilder<B>>, HttpStatusCodeAccessor.HttpStatusCodeMutator, HttpStatusCodeAccessor.HttpStatusCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.web.UrlAccessor

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Method Summary

Modifier and Type	Method	Description
default HttpBodyMap	getResponse()	Retrieves the HttpBodyMap representing the response body.
<RES> RES	getResponse(Class<RES> aResponseType)	Retrieves the object representing the response body.

Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

getHeaderFields

Methods inherited from interface org.refcodes.web.HttpBodyAccessor

getHttpBody

Methods inherited from interface org.refcodes.web.HttpInputStreamAccessor

getHttpInputStream

Methods inherited from interface org.refcodes.web.HttpStatusCodeAccessor

getHttpStatusCode

Methods inherited from interface org.refcodes.web.UrlAccessor

getUrl

Method Details

getResponse

<RES> RES getResponse(Class<RES> aResponseType)
               throws BadResponseException

Retrieves the object representing the response body. The HttpClientResponseImpl.getResponse(Class) implementation supports the HttpBodyMap to unmarshal an HTTP Response-Body into an HttpBodyMap when providing the HttpBodyMap as response type.

Type Parameters:

RES - the generic type

Parameters:

aResponseType - The type of which the response is expected to be.

Returns:

An instance of the type representing the response.

Throws:

BadResponseException - thrown when unmarshaling / deserializing an object fails.

getResponse

default HttpBodyMap getResponse()
                         throws BadResponseException

Retrieves the HttpBodyMap representing the response body.

Returns:

An instance of the HttpBodyMap representing the response.

Throws:

BadResponseException - thrown when unmarshaling / deserializing an object fails.