Module org.refcodes.rest
Package org.refcodes.rest

Interface RestRequestBuilder

  • All Superinterfaces:
    org.refcodes.mixin.Dumpable, org.refcodes.web.HeaderFieldsAccessor<org.refcodes.web.RequestHeaderFields>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.web.RequestHeaderFields,​RestRequestBuilder>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsMutator<org.refcodes.web.RequestHeaderFields>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsProperty<org.refcodes.web.RequestHeaderFields>, org.refcodes.web.HttpBodyAccessor.HttpBodyProvider<org.refcodes.web.BadRequestException>, org.refcodes.web.HttpClientRequest, org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder, org.refcodes.web.HttpMethodAccessor, org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>, org.refcodes.web.HttpMethodAccessor.HttpMethodMutator, org.refcodes.web.HttpMethodAccessor.HttpMethodProperty, org.refcodes.web.HttpRequest, org.refcodes.web.HttpRequestBuilder<RestRequestBuilder>, org.refcodes.web.RedirectDepthAccessor, org.refcodes.web.RedirectDepthAccessor.RedirectDepthBuilder<org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder>, org.refcodes.web.RedirectDepthAccessor.RedirectDepthMutator, org.refcodes.web.RedirectDepthAccessor.RedirectDepthProperty, RestRequest, org.refcodes.web.UrlAccessor, org.refcodes.web.UrlAccessor.UrlBuilder, org.refcodes.web.UrlAccessor.UrlMutator
    All Known Implementing Classes:
    RestRequestBuilderImpl
    public interface RestRequestBuilder
extends RestRequest, org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder, org.refcodes.web.HttpRequestBuilder<RestRequestBuilder>, org.refcodes.web.HttpMethodAccessor.HttpMethodProperty, org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.web.RequestHeaderFields,​RestRequestBuilder>
    An RestRequestBuilder extends an RestRequest with builder functionality. The locator to which a RestRequestBuilder targets for is defined by the UrlAccessor.getUrl() property.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.web.HeaderFieldsAccessor

        org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T extends org.refcodes.web.HeaderFields<?,​?>,​B extends org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T,​B>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsMutator<T extends org.refcodes.web.HeaderFields<?,​?>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsProperty<T extends org.refcodes.web.HeaderFields<?,​?>>

      • Nested classes/interfaces inherited from interface org.refcodes.web.HttpClientRequest

        org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder

      • Nested classes/interfaces inherited from interface org.refcodes.web.HttpMethodAccessor

        org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.web.HttpMethodAccessor.HttpMethodMutator, org.refcodes.web.HttpMethodAccessor.HttpMethodProperty

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

        org.refcodes.web.RedirectDepthAccessor.RedirectDepthBuilder<B extends org.refcodes.web.RedirectDepthAccessor.RedirectDepthBuilder<B>>, org.refcodes.web.RedirectDepthAccessor.RedirectDepthMutator, org.refcodes.web.RedirectDepthAccessor.RedirectDepthProperty

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

        org.refcodes.web.UrlAccessor.UrlBuilder, org.refcodes.web.UrlAccessor.UrlMutator, org.refcodes.web.UrlAccessor.UrlProperty

    • Field Summary

      • Fields inherited from interface org.refcodes.web.HttpClientRequest

        DEFAULT_REDIRECT_DEPTH

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default RestRequestBuilder build​(RestClient aRestClient)
      This is a convenience method for easily instantiating the according builder.
      RestResponse toRestResponse()
      Sends the request and returns synchronously the according RestResponse.
      default RestRequestBuilder withHeaderFields​(org.refcodes.web.RequestHeaderFields aRequestHeaderFields)
      default RestRequestBuilder withHttpMethod​(org.refcodes.web.HttpMethod aHttpMethod)
      default RestRequestBuilder withRedirectDepth​(int aRedirectDepth)
      default <REQ> RestRequestBuilder withRequest​(REQ aRequest)
      default RestRequestBuilder withUrl​(org.refcodes.web.Url aUrl)

      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump, toDump, toPrintable

      • Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

        getHeaderFields

      • Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsMutator

        setHeaderFields

      • Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsProperty

        letHeaderFields

      • Methods inherited from interface org.refcodes.web.HttpClientRequest

        getRequest, setRequest, toHttpBody

      • Methods inherited from interface org.refcodes.web.HttpMethodAccessor

        getHttpMethod

      • Methods inherited from interface org.refcodes.web.HttpMethodAccessor.HttpMethodMutator

        setHttpMethod

      • Methods inherited from interface org.refcodes.web.HttpMethodAccessor.HttpMethodProperty

        letHttpMethod

      • Methods inherited from interface org.refcodes.web.HttpRequestBuilder

        withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToQueryFields, withAddToQueryFields, withAddToQueryFields

      • 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

      • Methods inherited from interface org.refcodes.web.UrlAccessor.UrlMutator

        setUrl

    • Method Detail

      • toRestResponse

        RestResponse toRestResponse()
                     throws org.refcodes.web.HttpResponseException
        Sends the request and returns synchronously the according RestResponse.
        Returns:
        the rest response
        Throws:
        org.refcodes.web.HttpResponseException - the http response exception

      • withUrl

        default RestRequestBuilder withUrl​(org.refcodes.web.Url aUrl)
        Specified by:
        withUrl in interface org.refcodes.web.UrlAccessor.UrlBuilder

      • withHttpMethod

        default RestRequestBuilder withHttpMethod​(org.refcodes.web.HttpMethod aHttpMethod)
        Specified by:
        withHttpMethod in interface org.refcodes.web.HttpMethodAccessor.HttpMethodBuilder<RestRequestBuilder>

      • withRequest

        default <REQ> RestRequestBuilder withRequest​(REQ aRequest)
        Specified by:
        withRequest in interface org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder

      • withHeaderFields

        default RestRequestBuilder withHeaderFields​(org.refcodes.web.RequestHeaderFields aRequestHeaderFields)
        Specified by:
        withHeaderFields in interface org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.web.RequestHeaderFields,​RestRequestBuilder>

      • withRedirectDepth

        default RestRequestBuilder withRedirectDepth​(int aRedirectDepth)
        Specified by:
        withRedirectDepth in interface org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder
        Specified by:
        withRedirectDepth in interface org.refcodes.web.RedirectDepthAccessor.RedirectDepthBuilder<org.refcodes.web.HttpClientRequest.HttpClientRequestBuilder>

      • build

        default RestRequestBuilder build​(RestClient aRestClient)
        This is a convenience method for easily instantiating the according builder.
        Parameters:
        aRestClient - the rest client
        Returns:
        an instance (using a default implementation) of this builder