Interface HttpClientRequest


  • public interface HttpClientRequest
    Http request that is built and sent to the server.

    Largely wraps the standard JDK HttpRequest with additional support for converting beans to body content and converting beans from response content.

    • Method Detail

      • requestTimeout

        HttpClientRequest requestTimeout​(Duration requestTimeout)
        Set the request timeout to use for this request. When not set the default request timeout will be used.
        Parameters:
        requestTimeout - The request timeout to use for this request.
        Returns:
        The request being built
      • header

        HttpClientRequest header​(String name,
                                 String value)
        Add the header to the request.
        Parameters:
        name - The header name
        value - The header value
        Returns:
        The request being built
      • gzip

        HttpClientRequest gzip​(boolean gzip)
        Set if body content should be gzip encoded.
        Parameters:
        gzip - Set true to gzip encode the body content.
        Returns:
        The request being built
      • path

        HttpClientRequest path​(String path)
        Add a path segment to the URL.
        Parameters:
        path - The path segment to add to the URL path.
        Returns:
        The request being built
      • matrixParam

        HttpClientRequest matrixParam​(String name,
                                      String value)
        Add a matrix parameter to the current path segment.
        Parameters:
        name - The matrix parameter name
        value - The matrix parameter value
        Returns:
        The request being built
      • param

        HttpClientRequest param​(String name,
                                String value)
        Add a query parameter
        Parameters:
        name - The name of the query parameter
        value - The value of the query parameter
        Returns:
        The request being built
      • formParam

        HttpClientRequest formParam​(String name,
                                    String value)
        Add a form parameter.
        Parameters:
        name - The form parameter name
        value - The form parameter value
        Returns:
        The request being built
      • body

        HttpClientRequest body​(Object bean)
        Set the body as a bean using the default content type. The default content type will often be application/json; charset=utf8.
      • body

        HttpClientRequest body​(String body)
        Set the body content as a string.
        Parameters:
        body - The body content
        Returns:
        The request being built
      • body

        HttpClientRequest body​(byte[] body)
        Set the body content as a bytes.
        Parameters:
        body - The body content
        Returns:
        The request being built
      • body

        HttpClientRequest body​(Supplier<? extends InputStream> supplier)
        Set the body content with supplied InputStream.
        Parameters:
        supplier - The supplier of InputStream content to send as body content
        Returns:
        The request being built