HttpClient (Digi WVA Android Library (wvalib) v2.0-SNAPSHOT API Docs)

java.lang.Object
- com.digi.wva.device.HttpClient

```
public class HttpClient
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpClient.ExpectEmptyCallback` Version of `HttpClient.HttpCallback` which expects the HTTP response body to be empty.
`static class`	`HttpClient.HttpCallback` Wrapper around OkHttp's `Callback` interface, specifically targeted at expecting and handling JSON response bodies.

Constructor Summary

Constructors
Constructor and Description

HttpClient(String hostname)

Constructors
Constructor and Description
`HttpClient(String hostname)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearBasicAuth()` Clears any previously-set basic authentication for HTTP requests.
`void`	`delete(String url, HttpClient.HttpCallback callback)` Asynchronously perform an HTTP DELETE request on the given path.
`Response`	`deleteSynchronous(String url)` Synchronous version of `delete(String, HttpCallback)`.
`void`	`get(String url, HttpClient.HttpCallback callback)` Asynchronously perform an HTTP GET request on the given path.
`URL`	`getAbsoluteUrl(String relativePath)` Given a relative path (such as `"config"`), return a `URL` object representing the corresponding full path in the WVA's web services (such as `"http://192.168.100.1/ws/config"`).
`Response`	`getSynchronous(String url)` Synchronous version of `get(String, HttpCallback)`.
`protected RequestBody`	`makeBody(JSONObject obj)` Converts a JSONObject, to be used as the body of a request, to its corresponding `RequestBody` representation.
`protected Request.Builder`	`makeBuilder(String url)` Create a new `Request.Builder` for accessing the given URL, and adds the `Accept: application/json` header, as well as an `Authorization` header if authentication is being used.
`void`	`post(String url, JSONObject obj, HttpClient.HttpCallback callback)` Asynchronously perform an HTTP POST request on the given path, with the given JSON data.
`Response`	`postSynchronous(String url, JSONObject obj)` Synchronous version of `put(String, JSONObject, HttpCallback)`.
`void`	`put(String url, JSONObject obj, HttpClient.HttpCallback callback)` Asynchronously perform an HTTP PUT request on the given path, with the given JSON data.
`Response`	`putSynchronous(String url, JSONObject obj)` Synchronous version of `put(String, JSONObject, HttpCallback)`.
`void`	`setHttpPort(int port)` Sets the port to be used when making HTTP requests.
`void`	`setHttpsPort(int port)` Sets the port to be used when making HTTPS requests.
`void`	`useBasicAuth(String username, String password)` Sets the basic authentication parameters to be added to every HTTP request made by this client.
`void`	`useSecureHttp(boolean secure)` Sets whether this HTTP client should communicate over HTTP or HTTPS.
`Callback`	`wrapCallback(HttpClient.HttpCallback callback)` Wrap an HttpCallback in an OkHttp `Callback` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpClient
```
public HttpClient(String hostname)
```
- Method Detail
  - makeBuilder
```
protected Request.Builder makeBuilder(String url)
```
    Create a new Request.Builder for accessing the given URL, and adds the Accept: application/json header, as well as an Authorization header if authentication is being used.
    This method is protected, rather than private, due to a bug between JaCoCo and the Android build tools which causes the instrumented bytecode to be invalid when this method is private: http://stackoverflow.com/questions/17603192/dalvik-transformation-using-wrong-invoke-opcode
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a request
    
    Returns:
    a corresponding Request.Builder object
  - makeBody
```
protected RequestBody makeBody(JSONObject obj)
```
    Converts a JSONObject, to be used as the body of a request, to its corresponding RequestBody representation.
    Used by post(java.lang.String, org.json.JSONObject, com.digi.wva.device.HttpClient.HttpCallback) and put(java.lang.String, org.json.JSONObject, com.digi.wva.device.HttpClient.HttpCallback), as well as their synchronous variants.
    
    This method is protected, rather than private, due to a bug between JaCoCo and the Android build tools which causes the instrumented bytecode to be invalid when this method is private: http://stackoverflow.com/questions/17603192/dalvik-transformation-using-wrong-invoke-opcode
    
    Parameters:
    obj - the JSON data to be used
    
    Returns:
    the request body
  - wrapCallback
```
public Callback wrapCallback(HttpClient.HttpCallback callback)
```
    Wrap an HttpCallback in an OkHttp Callback instance. Also will automatically attempt to parse the response as JSON.
    Used internally by HttpClient, and made public for unit-testing.
    
    Parameters:
    callback - the HttpClient.HttpCallback to wrap
    
    Returns:
    a corresponding Callback
  - get
```
public void get(String url,
       HttpClient.HttpCallback callback)
```
    Asynchronously perform an HTTP GET request on the given path.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a GET request
    callback - a callback for when the request completes or is in error
  - getSynchronous
```
public Response getSynchronous(String url)
                        throws IOException
```
    Synchronous version of get(String, HttpCallback). Invokes a GET request to the given relative path immediately, and blocks until the response can be processed or is in error.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a GET request
    
    Returns:
    the OkHttp Response to the request
    
    Throws:
    
    IOException - if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the WVA accepted the request before the failure.
  - post
```
public void post(String url,
        JSONObject obj,
        HttpClient.HttpCallback callback)
```
    Asynchronously perform an HTTP POST request on the given path, with the given JSON data.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a POST request
    obj - the JSON object to POST to the device
    callback - a callback for when the request completes or is in error
  - postSynchronous
```
public Response postSynchronous(String url,
                       JSONObject obj)
                         throws IOException
```
    Synchronous version of put(String, JSONObject, HttpCallback). Invokes a POST request to the given relative path immediately, and blocks until the response can be processed or is in error.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a POST request
    obj - the JSON object to POST to the device
    
    Returns:
    the OkHttp Response to the request
    
    Throws:
    
    IOException - if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the WVA accepted the request before the failure.
  - put
```
public void put(String url,
       JSONObject obj,
       HttpClient.HttpCallback callback)
```
    Asynchronously perform an HTTP PUT request on the given path, with the given JSON data.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a PUT request
    obj - the JSON object to PUT to the device
    callback - a callback for when the request completes or is in error
  - putSynchronous
```
public Response putSynchronous(String url,
                      JSONObject obj)
                        throws IOException
```
    Synchronous version of put(String, JSONObject, HttpCallback). Invokes a PUT request to the given relative path immediately, and blocks until the response can be processed or is in error.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a PUT request
    obj - the JSON object to PUT to the device
    
    Returns:
    the OkHttp Response to the request
    
    Throws:
    
    IOException - if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the WVA accepted the request before the failure.
  - delete
```
public void delete(String url,
          HttpClient.HttpCallback callback)
```
    Asynchronously perform an HTTP DELETE request on the given path.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a DELETE request
    callback - a callback for when the request completes or is in error
  - deleteSynchronous
```
public Response deleteSynchronous(String url)
                           throws IOException
```
    Synchronous version of delete(String, HttpCallback). Invokes a DELETE request to the given relative path immediately, and blocks until the response can be processed or is in error.
    
    Parameters:
    url - the path, relative to /ws/, on which to perform a DELETE request
    
    Returns:
    the OkHttp Response to the request
    
    Throws:
    
    IOException - if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the WVA accepted the request before the failure.
  - getAbsoluteUrl
```
public URL getAbsoluteUrl(String relativePath)
```
    Given a relative path (such as "config"), return a URL object representing the corresponding full path in the WVA's web services (such as "http://192.168.100.1/ws/config").
    This method is used internally by HttpClient when constructing its HTTP requests.
    
    Parameters:
    relativePath - the web services path to use
    
    Returns:
    a {link URL} representing the full path to relativePath
  - useBasicAuth
```
public void useBasicAuth(String username,
                String password)
```
    Sets the basic authentication parameters to be added to every HTTP request made by this client.
    
    Parameters:
    username - the username for authentication
    password - the password for authentication
  - clearBasicAuth
```
public void clearBasicAuth()
```
    Clears any previously-set basic authentication for HTTP requests.
  - useSecureHttp
```
public void useSecureHttp(boolean secure)
```
    Sets whether this HTTP client should communicate over HTTP or HTTPS.
    
    Parameters:
    secure - true to use HTTPS, false to use HTTP
  - setHttpPort
```
public void setHttpPort(int port)
```
    Sets the port to be used when making HTTP requests.
    
    Parameters:
    port - the port to use for HTTP
  - setHttpsPort
```
public void setHttpsPort(int port)
```
    Sets the port to be used when making HTTPS requests.
    
    Parameters:
    port - the port to use for HTTPS

Class HttpClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClient

Method Detail

makeBuilder

makeBody

wrapCallback

get

getSynchronous

post

postSynchronous

put

putSynchronous

delete

deleteSynchronous

getAbsoluteUrl

useBasicAuth

clearBasicAuth

useSecureHttp

setHttpPort

setHttpsPort