Package org.refcodes.rest
Interface RestRequestBuilder
-
- All Superinterfaces:
org.refcodes.mixin.Dumpable
,org.refcodes.net.HeaderFieldsAccessor<org.refcodes.net.RequestHeaderFields>
,org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestRequestBuilder>
,org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsMutator<org.refcodes.net.RequestHeaderFields>
,org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsProperty<org.refcodes.net.RequestHeaderFields>
,org.refcodes.net.HttpBodyAccessor.HttpBodyProvider<org.refcodes.net.RequestHeaderFields>
,org.refcodes.net.HttpClientRequest
,org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder
,org.refcodes.net.HttpMethodAccessor
,org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>
,org.refcodes.net.HttpMethodAccessor.HttpMethodMutator
,org.refcodes.net.HttpMethodAccessor.HttpMethodProperty
,org.refcodes.net.HttpRequest
,org.refcodes.net.HttpRequestBuilder<RestRequestBuilder>
,org.refcodes.net.RedirectDepthAccessor
,org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<org.refcodes.net.RequestHeaderFields>
,org.refcodes.net.RedirectDepthAccessor.RedirectDepthMutator
,org.refcodes.net.RedirectDepthAccessor.RedirectDepthProperty
,RestRequest
,org.refcodes.net.UrlAccessor
,org.refcodes.net.UrlAccessor.UrlBuilder
,org.refcodes.net.UrlAccessor.UrlMutator
- All Known Implementing Classes:
RestRequestBuilderImpl
public interface RestRequestBuilder extends RestRequest, org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder, org.refcodes.net.HttpRequestBuilder<RestRequestBuilder>, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty, org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>, org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestRequestBuilder>
AnRestRequestBuilder
extends anRestCaller
with builder functionality and addslambda
support for handling the responses addressed to thisRestCaller
. Thelambda
defined asRestResponseObserver
acts as the single listener to thisRestCaller
responsible for handling the responses for which thisRestCaller
is responsible. The locator to which aRestRequestBuilder
targets for is defined by theUrlAccessor.getUrl()
property.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.net.HttpClientRequest
org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder
-
Nested classes/interfaces inherited from interface org.refcodes.net.HttpMethodAccessor
org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.net.HttpMethodAccessor.HttpMethodMutator, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty
-
Nested classes/interfaces inherited from interface org.refcodes.net.RedirectDepthAccessor
org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<B extends org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<B>>, org.refcodes.net.RedirectDepthAccessor.RedirectDepthMutator, org.refcodes.net.RedirectDepthAccessor.RedirectDepthProperty
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description RestResponse
toRestResponse()
Sends the request and returns synchronously the accordingRestResponse
.default RestRequestBuilder
withHeaderFields(org.refcodes.net.RequestHeaderFields aRequestHeaderFields)
default RestRequestBuilder
withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod)
default RestRequestBuilder
withRedirectDepth(int aRedirectDepth)
default <REQ> RestRequestBuilder
withRequest(REQ aRequest)
default RestRequestBuilder
withUrl(org.refcodes.net.Url aUrl)
-
Methods inherited from interface org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsMutator
setHeaderFields
-
Methods inherited from interface org.refcodes.net.HttpClientRequest
getRequest, setRequest, toHttpBody
-
Methods inherited from interface org.refcodes.net.HttpMethodAccessor.HttpMethodMutator
setHttpMethod
-
Methods inherited from interface org.refcodes.net.HttpRequestBuilder
withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToQueryFields, withAddToQueryFields, withAddToQueryFields
-
-
-
-
Method Detail
-
toRestResponse
RestResponse toRestResponse() throws org.refcodes.net.HttpResponseException
Sends the request and returns synchronously the accordingRestResponse
.- Returns:
- the rest response
- Throws:
org.refcodes.net.HttpResponseException
- the http response exception
-
withUrl
default RestRequestBuilder withUrl(org.refcodes.net.Url aUrl)
- Specified by:
withUrl
in interfaceorg.refcodes.net.UrlAccessor.UrlBuilder
-
withHttpMethod
default RestRequestBuilder withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod)
- Specified by:
withHttpMethod
in interfaceorg.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>
-
withRequest
default <REQ> RestRequestBuilder withRequest(REQ aRequest)
- Specified by:
withRequest
in interfaceorg.refcodes.net.HttpClientRequest.HttpClientRequestBuilder
-
withHeaderFields
default RestRequestBuilder withHeaderFields(org.refcodes.net.RequestHeaderFields aRequestHeaderFields)
- Specified by:
withHeaderFields
in interfaceorg.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestRequestBuilder>
-
withRedirectDepth
default RestRequestBuilder withRedirectDepth(int aRedirectDepth)
- Specified by:
withRedirectDepth
in interfaceorg.refcodes.net.HttpClientRequest.HttpClientRequestBuilder
- Specified by:
withRedirectDepth
in interfaceorg.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<org.refcodes.net.RequestHeaderFields>
-
-