Class RestRequestClientSugar

  • Direct Known Subclasses:
    RestGetClientSugar


    public class RestRequestClientSugar
    extends Object
    Helper class to get the syntactic sugar (from a maintenance point of view) under control. You should actually statically import the HttpRestClientSugar.
    • Constructor Detail

      • RestRequestClientSugar

        public RestRequestClientSugar​()
    • Method Detail

      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.data.Scheme aScheme,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aLocator,
                                                      org.refcodes.net.FormFields aQueryFields)
                                               throws org.refcodes.net.HttpResponseException,
                                                      MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aLocator,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException,
                                                      MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aLocator,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException,
                                                      MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aUrl,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException,
                                                      MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The targeted URL locating the addressed resource.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aUrl,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException,
                                                      MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The targeted URL locating the addressed resource.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      int aPort,
                                                      String aPath,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.FormFields aQueryFields,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      String aProtocol,
                                                      String aHost,
                                                      String aPath,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                      Object aRequest)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.net.Url aUrl)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The Url from which to take the URL specific data.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • buildRequest

        public static RestRequestBuilder buildRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                      org.refcodes.net.Url aUrl,
                                                      org.refcodes.net.RequestHeaderFields aHeaderFields)
                                               throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The Url from which to take the URL specific data.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestRequestBuilder which is used to prepare and synchronously issue the request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  int aPort,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  Object aRequest,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.DELETE request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  int aPort,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                  Object aRequest,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.DELETE request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  int aPort,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  int aPort,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  int aPort,
                                                  String aPath,
                                                  org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                  Object aRequest,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.DELETE request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  Object aRequest,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.DELETE request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestCallerBuilder doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                                  org.refcodes.data.Scheme aScheme,
                                                  String aHost,
                                                  String aPath,
                                                  org.refcodes.net.FormFields aQueryFields,
                                                  org.refcodes.net.RequestHeaderFields aHeaderFields,
                                                  Object aRequest,
                                                  RestResponseObserver aResponseObserver)
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.DELETE request.
        aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.
        Returns:
        The RestCallerBuilder which is used by your request.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.data.Scheme aScheme,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aLocator,
                                             org.refcodes.net.FormFields aQueryFields)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aLocator,
                                             org.refcodes.net.FormFields aQueryFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aLocator,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aLocator,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aLocator - The targeted locator, usually the part of the URL till (excluding) the query fields and the fragment.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aUrl,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The targeted URL locating the addressed resource.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aUrl,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The targeted URL locating the addressed resource.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aUrl,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The targeted URL locating the addressed resource.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             int aPort,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPort - The port to be used when connecting to the host.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.FormFields aQueryFields,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aQueryFields - The Query-Fields to be used for the HTTP Query-String.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             String aProtocol,
                                             String aHost,
                                             String aPath,
                                             org.refcodes.net.RequestHeaderFields aHeaderFields,
                                             Object aRequest)
                                      throws org.refcodes.net.HttpResponseException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aProtocol - The protocol
        aHost - The host to which the destination URL is to point to.
        aPath - The path on the host to which the base destination URL is to point to.
        aHeaderFields - The HTTP-Header's fields to be used for the request.
        aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
      • doRequest

        public static RestResponse doRequest​(org.refcodes.net.HttpMethod aHttpMethod,
                                             org.refcodes.net.Url aUrl)
                                      throws org.refcodes.net.HttpResponseException,
                                             MalformedURLException
        Parameters:
        aHttpMethod - The HTTP-Method for the request.
        aUrl - The Url from which to take the URL specific data.
        Returns:
        The RestResponse as of your request.
        Throws:
        org.refcodes.net.HttpResponseException - thrown in case of some unexpected response.
        MalformedURLException - in case the provided URL is considered being malformed.