Package com.bandwidth.http.client

Interface HttpClient

All Known Implementing Classes:
OkClient
public interface HttpClient
HTTP Client to send HTTP Requests and read the responses.

  • Method Summary

    Modifier and Type Method Description
    HttpRequest delete​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create an HTTP DELETE request with parameters.
    HttpBodyRequest deleteBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
    Create an HTTP DELETE request with body.
    HttpResponse executeAsBinary​(HttpRequest request)
    Execute a given HttpRequest to get binary response back.
    java.util.concurrent.CompletableFuture<HttpResponse> executeAsBinaryAsync​(HttpRequest request)
    Execute a given HttpRequest to get binary response back.
    HttpResponse executeAsString​(HttpRequest request)
    Execute a given HttpRequest to get string response back.
    java.util.concurrent.CompletableFuture<HttpResponse> executeAsStringAsync​(HttpRequest request)
    Execute a given HttpRequest to get string response back.
    HttpRequest get​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create a simple HTTP GET request.
    HttpRequest head​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create a simple HTTP HEAD request.
    HttpRequest patch​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create an HTTP PATCH request with parameters.
    HttpBodyRequest patchBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
    Create an HTTP PATCH request with body.
    HttpRequest post​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create an HTTP POST request with parameters.
    HttpBodyRequest postBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
    Create an HTTP POST request with body.
    HttpRequest put​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
    Create an HTTP PUT request with parameters.
    HttpBodyRequest putBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
    Create an HTTP PUT request with body.

  • Method Details

    • executeAsStringAsync

      java.util.concurrent.CompletableFuture<HttpResponse> executeAsStringAsync​(HttpRequest request)
      Execute a given HttpRequest to get string response back.
      Parameters:
      request - The given HttpRequest to execute.
      Returns:
      CompletableFuture of HttpResponse after execution

    • executeAsBinaryAsync

      java.util.concurrent.CompletableFuture<HttpResponse> executeAsBinaryAsync​(HttpRequest request)
      Execute a given HttpRequest to get binary response back.
      Parameters:
      request - The given HttpRequest to execute.
      Returns:
      CompletableFuture of HttpResponse after execution

    • executeAsBinary

      HttpResponse executeAsBinary​(HttpRequest request) throws java.io.IOException
      Execute a given HttpRequest to get binary response back.
      Parameters:
      request - The given HttpRequest to execute.
      Returns:
      HttpResponse after execution
      Throws:
      java.io.IOException - Signals that an I/O exception of some sort has occurred.

    • executeAsString

      HttpResponse executeAsString​(HttpRequest request) throws java.io.IOException
      Execute a given HttpRequest to get string response back.
      Parameters:
      request - The given HttpRequest to execute.
      Returns:
      HttpResponse after execution
      Throws:
      java.io.IOException - Signals that an I/O exception of some sort has occurred.

    • get

      HttpRequest get​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create a simple HTTP GET request.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • head

      HttpRequest head​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create a simple HTTP HEAD request.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • post

      HttpRequest post​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create an HTTP POST request with parameters.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • postBody

      HttpBodyRequest postBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
      Create an HTTP POST request with body.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      body - The object to be sent as body after serialization.
      Returns:
      Returns the object of HttpBodyRequest

    • put

      HttpRequest put​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create an HTTP PUT request with parameters.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • putBody

      HttpBodyRequest putBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
      Create an HTTP PUT request with body.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      body - The object to be sent as body after serialization.
      Returns:
      Returns the object of HttpBodyRequest

    • patch

      HttpRequest patch​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create an HTTP PATCH request with parameters.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • patchBody

      HttpBodyRequest patchBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
      Create an HTTP PATCH request with body.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      body - The object to be sent as body after serialization.
      Returns:
      Returns the object of HttpBodyRequest

    • delete

      HttpRequest delete​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> parameters)
      Create an HTTP DELETE request with parameters.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      parameters - The form data values in a key-value map.
      Returns:
      Returns the object of HttpRequest

    • deleteBody

      HttpBodyRequest deleteBody​(java.lang.StringBuilder queryUrlBuilder, Headers headers, java.util.Map<java.lang.String,​java.lang.Object> queryParams, java.lang.Object body)
      Create an HTTP DELETE request with body.
      Parameters:
      queryUrlBuilder - The http url to create the HTTP Request.
      headers - The key-value map of all http headers to be sent.
      queryParams - The query parameters in a key-value map.
      body - The object to be sent as body after serialization.
      Returns:
      Returns the object of HttpBodyRequest