org.refcodes.net

Interface HttpClientRequest

All Superinterfaces:

HeaderFieldsAccessor<RequestHeaderFields>, HttpBodyAccessor.HttpBodyProvider<BadRequestException>, HttpMethodAccessor, HttpRequest, UrlAccessor<Url>

All Known Implementing Classes:

HttpClientRequestImpl

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

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

Nested Class Summary

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

UrlAccessor.UrlBuilder<URL extends Url,B extends UrlAccessor.UrlBuilder<URL,B>>, UrlAccessor.UrlMutator<URL extends Url>, UrlAccessor.UrlProperty<URL extends Url>

Nested classes/interfaces inherited from interface org.refcodes.net.HttpMethodAccessor

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

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

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

Method Summary

Modifier and Type	Method and 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().
default <REQ> HttpClientRequest	withRequest(REQ aRequest) Sets the request for the request property.

Methods inherited from interface org.refcodes.net.UrlAccessor

getUrl

Methods inherited from interface org.refcodes.net.HttpMethodAccessor

getHttpMethod

Methods inherited from interface org.refcodes.net.HeaderFieldsAccessor

getHeaderFields

Method Detail

toHttpBody

String toHttpBody()
           throws BadRequestException

Automatically sets the ContentType to the RequestHeaderFields retrieved from HeaderFieldsAccessor.getHeaderFields(). (see HeaderFields.putContentType(org.refcodes.net.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.

withRequest

default <REQ> HttpClientRequest withRequest(REQ aRequest)

Sets the request for the request property.

Type Parameters:

REQ - the generic type

Parameters:

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

Returns:

The builder for applying multiple build operations.