Module org.refcodes.web

Package org.refcodes.web

Interface HttpClientRequest

All Superinterfaces:

HeaderFieldsAccessor<RequestHeaderFields>, HttpBodyAccessor.HttpBodyProvider<BadRequestException>, HttpMethodAccessor, HttpRequest, RedirectDepthAccessor, RedirectDepthAccessor.RedirectDepthMutator, RedirectDepthAccessor.RedirectDepthProperty, UrlAccessor

All Known Subinterfaces:

HttpClientRequest.HttpClientRequestBuilder

All Known Implementing Classes:

HttpClientRequestImpl

public interface HttpClientRequest
extends HttpRequest, HttpBodyAccessor.HttpBodyProvider<BadRequestException>, RedirectDepthAccessor.RedirectDepthProperty

Defines a HttpClientRequest being the request as produced by the client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HttpClientRequest.HttpClientRequestBuilder	Builder for the HttpClientRequest interface.

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

HttpMethodAccessor.HttpMethodBuilder<B extends HttpMethodAccessor.HttpMethodBuilder<B>>, HttpMethodAccessor.HttpMethodMutator, HttpMethodAccessor.HttpMethodProperty

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

RedirectDepthAccessor.RedirectDepthBuilder<B extends RedirectDepthAccessor.RedirectDepthBuilder<B>>, RedirectDepthAccessor.RedirectDepthMutator, RedirectDepthAccessor.RedirectDepthProperty

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

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_REDIRECT_DEPTH

Method Summary

Modifier and Type	Method	Description
<REQ> REQ	getRequest()	Retrieves the request from the request property.
<REQ> void	setRequest(REQ aRequest)	Sets the request for the request property.
String	toHttpBody()	Automatically sets the ContentType to the RequestHeaderFields retrieved from HeaderFieldsAccessor.getHeaderFields().

Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

getHeaderFields

Methods inherited from interface org.refcodes.web.HttpMethodAccessor

getHttpMethod

Methods inherited from interface org.refcodes.web.RedirectDepthAccessor

getRedirectDepth

Methods inherited from interface org.refcodes.web.RedirectDepthAccessor.RedirectDepthMutator

setRedirectDepth

Methods inherited from interface org.refcodes.web.RedirectDepthAccessor.RedirectDepthProperty

letRedirectDepth

Methods inherited from interface org.refcodes.web.UrlAccessor

getUrl

Field Details

DEFAULT_REDIRECT_DEPTH

static final int DEFAULT_REDIRECT_DEPTH

See Also:

Constant Field Values

Method Details

toHttpBody

String toHttpBody()
           throws BadRequestException

Automatically sets the ContentType to the RequestHeaderFields retrieved from HeaderFieldsAccessor.getHeaderFields(). (see HeaderFields.putContentType(org.refcodes.web.HttpMediaType) ) Converts an object representing the HTTP body to a String instance. Automatically determines the ContentType from any headers when applicable.

Specified by:

toHttpBody in interface HttpBodyAccessor.HttpBodyProvider<BadRequestException>

Returns:

The converted String instance represented by the according object.

Throws:

BadRequestException

getRequest

<REQ> REQ getRequest()

Retrieves the request from the request property.

Type Parameters:

REQ - the generic type

Returns:

The request stored by the request property.

setRequest

<REQ> void setRequest(REQ aRequest)

Sets the request for the request property. The HttpClientRequestImpl.setRequest(Object) supports the HttpBodyMap to marshal an HttpBodyMap into an HTTP Request-Body.

Type Parameters:

REQ - the generic type

Parameters:

aRequest - The request to be stored by the request property.