org.refcodes.net

Interface HttpClientRequest

All Superinterfaces:

HeaderFieldsAccessor<RequestHeaderFields>, HttpBodyAccessor.HttpBodyProvider<BadRequestException>, HttpMethodAccessor, HttpRequest, org.refcodes.mixin.LocatorAccessor<String>, QueryFieldsAccessor

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.mixin.LocatorAccessor

org.refcodes.mixin.LocatorAccessor.LocatorBuilder<T,B extends org.refcodes.mixin.LocatorAccessor.LocatorBuilder<T,B>>, org.refcodes.mixin.LocatorAccessor.LocatorMutator<T>, org.refcodes.mixin.LocatorAccessor.LocatorProperty<T>

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

QueryFieldsAccessor.QueryFieldsBuilder<B extends QueryFieldsAccessor.QueryFieldsBuilder<?>>, QueryFieldsAccessor.QueryFieldsMutator, QueryFieldsAccessor.QueryFieldsProperty

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.mixin.LocatorAccessor

getLocator

Methods inherited from interface org.refcodes.net.QueryFieldsAccessor

getQueryFields

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) ) Returns the String instance representing the HTTP body from the implementing instance. Automatically sets the ContentType to any headers if accessible and applicable.

Specified by:

toHttpBody in interface HttpBodyAccessor.HttpBodyProvider<BadRequestException>

Returns:

The according String instance represented by the implementing instance.

Throws:

BadRequestException

getRequest

<REQ> REQ getRequest()

Retrieves the request from the request property.

Returns:

The request stored by the request property.

setRequest

<REQ> void setRequest(REQ aRequest)

Sets the request for the request property.

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.

Parameters:

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

Returns:

The builder for applying multiple build operations.