Module org.refcodes.web

Package org.refcodes.web

Class HttpClientResponse

java.lang.Object

org.refcodes.web.AbstractHttpResponse

org.refcodes.web.HttpClientResponse

All Implemented Interfaces:

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

public class HttpClientResponse
extends AbstractHttpResponse
implements 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

Field Summary

Fields

Modifier and Type	Field	Description
protected MediaTypeFactoryLookup	_mediaTypeFactoryLookup

Fields inherited from class org.refcodes.web.AbstractHttpResponse

_httpStatusCode

Constructor Summary

Constructors

Constructor	Description
HttpClientResponse(Url aUrl, HttpStatusCode aHttpStatusCode, ResponseHeaderFields aHeaderFields, InputStream aHttpInputStream, MediaTypeFactoryLookup aMediaTypeFactoryLookup)	Constructs a HttpClientResponse with all required attributes.

Method Summary

Modifier and Type	Method	Description
String	getHttpBody()	Retrieves the HTTP body from the HTTP body property.
InputStream	getHttpInputStream()	Retrieves the InputStream from the HTTP InputStream property.
HttpBodyMap	getResponse()	Retrieves the HttpBodyMap representing the response body.
<RES> RES	getResponse(Class<RES> aResponseType)	This method's implementation supports the HttpBodyMap to unmarshal an HTTP Response-Body into an HttpBodyMap when providing the HttpBodyMap as response type.
Url	getUrl()	Retrieves the Url from the Url property.
String	toString()

Methods inherited from class org.refcodes.web.AbstractHttpResponse

getHeaderFields, getHttpStatusCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

getHeaderFields

Methods inherited from interface org.refcodes.web.HttpStatusCodeAccessor

getHttpStatusCode

Field Details

_mediaTypeFactoryLookup

protected MediaTypeFactoryLookup _mediaTypeFactoryLookup

Constructor Details

HttpClientResponse

public HttpClientResponse(Url aUrl,
 HttpStatusCode aHttpStatusCode,
 ResponseHeaderFields aHeaderFields,
 InputStream aHttpInputStream,
 MediaTypeFactoryLookup aMediaTypeFactoryLookup)

Constructs a HttpClientResponse with all required attributes.

Parameters:

aUrl - The URL from which the response originates.

aHttpStatusCode - The HttpStatusCode of the response.

aHeaderFields - The ResponseHeaderFields sent by the response.

aHttpInputStream - The InputStream representing the request's HTTP body.

aMediaTypeFactoryLookup - The lookup factory for retrieving the required MediaType factories.

Method Details

getResponse

public 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.

getResponse

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

This method's 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 response type

Returns:

the response

Throws:

BadResponseException - the bad response exception

getHttpInputStream

public InputStream getHttpInputStream()

Retrieves the InputStream from the HTTP InputStream property.

Specified by:

getHttpInputStream in interface HttpInputStreamAccessor

Returns:

The InputStream stored by the InputStream property.

getHttpBody

public String getHttpBody()

Retrieves the HTTP body from the HTTP body property.

Specified by:

getHttpBody in interface HttpBodyAccessor

Returns:

The HTTP body stored by the HTTP body property.

getUrl

public Url getUrl()

Retrieves the Url from the Url property.

Specified by:

getUrl in interface UrlAccessor

Returns:

The Url stored by the Url property.

toString

public String toString()

Overrides:

toString in class Object