Package com.bandwidth.http.client

Class OkClient

java.lang.Object
com.bandwidth.http.client.OkClient
All Implemented Interfaces:
HttpClient
public class OkClient
extends java.lang.Object
implements HttpClient

  • Constructor Summary

    Constructors 
    Constructor Description
    OkClient​(long timeout)
    Default constructor

  • Method Summary

    Modifier and Type Method Description
    HttpRequest delete​(java.lang.String _queryUrl, Headers _headers, 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.String _queryUrl, Headers _headers, java.lang.String _body)
    Create an HTTP DELETE request with body
    HttpResponse executeAsBinary​(HttpRequest httpRequest)
    Execute a given HttpRequest to get binary response back
    java.util.concurrent.CompletableFuture<HttpResponse> executeAsBinaryAsync​(HttpRequest httpRequest)
    Execute a given HttpRequest to get binary response back
    HttpResponse executeAsString​(HttpRequest httpRequest)
    Execute a given HttpRequest to get string response back
    java.util.concurrent.CompletableFuture<HttpResponse> executeAsStringAsync​(HttpRequest httpRequest)
    Execute a given HttpRequest to get string response back
    HttpRequest get​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
    Create a simple HTTP GET request
    HttpRequest head​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
    Create a simple HTTP HEAD request
    HttpRequest patch​(java.lang.String _queryUrl, Headers _headers, 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.String _queryUrl, Headers _headers, java.lang.String _body)
    Create an HTTP PATCH request with body
    HttpRequest post​(java.lang.String _queryUrl, Headers _headers, 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.String _queryUrl, Headers _headers, java.lang.String _body)
    Create an HTTP POST request with body
    HttpRequest put​(java.lang.String _queryUrl, Headers _headers, 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.String _queryUrl, Headers _headers, java.lang.String _body)
    Create an HTTP PUT request with body
    static void shutdown()
    Shutdown the underlying OkHttpClient instance.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OkClient

      public OkClient​(long timeout)
      Default constructor

  • Method Details

    • shutdown

      public static void shutdown()
      Shutdown the underlying OkHttpClient instance.

    • executeAsStringAsync

      public java.util.concurrent.CompletableFuture<HttpResponse> executeAsStringAsync​(HttpRequest httpRequest)
      Execute a given HttpRequest to get string response back
      Specified by:
      executeAsStringAsync in interface HttpClient
      Parameters:
      request - The given HttpRequest to execute
      Returns:
      CompletableFuture after execution

    • executeAsBinaryAsync

      public java.util.concurrent.CompletableFuture<HttpResponse> executeAsBinaryAsync​(HttpRequest httpRequest)
      Execute a given HttpRequest to get binary response back
      Specified by:
      executeAsBinaryAsync in interface HttpClient
      Parameters:
      request - The given HttpRequest to execute
      Returns:
      CompletableFuture after execution

    • executeAsString

      public HttpResponse executeAsString​(HttpRequest httpRequest) throws java.io.IOException
      Execute a given HttpRequest to get string response back
      Specified by:
      executeAsString in interface HttpClient
      Parameters:
      request - The given HttpRequest to execute
      Throws:
      java.io.IOException

    • executeAsBinary

      public HttpResponse executeAsBinary​(HttpRequest httpRequest) throws java.io.IOException
      Execute a given HttpRequest to get binary response back
      Specified by:
      executeAsBinary in interface HttpClient
      Parameters:
      request - The given HttpRequest to execute
      Throws:
      java.io.IOException

    • get

      public HttpRequest get​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create a simple HTTP GET request
      Specified by:
      get in interface HttpClient

    • head

      public HttpRequest head​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create a simple HTTP HEAD request
      Specified by:
      head in interface HttpClient

    • post

      public HttpRequest post​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create an HTTP POST request with parameters
      Specified by:
      post in interface HttpClient

    • postBody

      public HttpBodyRequest postBody​(java.lang.String _queryUrl, Headers _headers, java.lang.String _body)
      Create an HTTP POST request with body
      Specified by:
      postBody in interface HttpClient

    • put

      public HttpRequest put​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create an HTTP PUT request with parameters
      Specified by:
      put in interface HttpClient

    • putBody

      public HttpBodyRequest putBody​(java.lang.String _queryUrl, Headers _headers, java.lang.String _body)
      Create an HTTP PUT request with body
      Specified by:
      putBody in interface HttpClient

    • patch

      public HttpRequest patch​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create an HTTP PATCH request with parameters
      Specified by:
      patch in interface HttpClient

    • patchBody

      public HttpBodyRequest patchBody​(java.lang.String _queryUrl, Headers _headers, java.lang.String _body)
      Create an HTTP PATCH request with body
      Specified by:
      patchBody in interface HttpClient

    • delete

      public HttpRequest delete​(java.lang.String _queryUrl, Headers _headers, java.util.List<java.util.AbstractMap.SimpleEntry<java.lang.String,​java.lang.Object>> _parameters)
      Create an HTTP DELETE request with parameters
      Specified by:
      delete in interface HttpClient

    • deleteBody

      public HttpBodyRequest deleteBody​(java.lang.String _queryUrl, Headers _headers, java.lang.String _body)
      Create an HTTP DELETE request with body
      Specified by:
      deleteBody in interface HttpClient