com.digi.wva.device

Class HttpClient.HttpCallback

java.lang.Object

com.digi.wva.device.HttpClient.HttpCallback

Direct Known Subclasses:

HttpClient.ExpectEmptyCallback

Enclosing class:

HttpClient

public abstract static class HttpClient.HttpCallback
extends Object

Wrapper around OkHttp's Callback interface, specifically targeted at expecting and handling JSON response bodies.

Constructor Summary

Constructors

Constructor and Description
HttpClient.HttpCallback()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onFailure(Throwable error) Called when the HTTP request failed or had an error response.
void	onJsonParseError(JSONException error, String rawBody) Invoked when the HTTP request was successful, but the response body could not be parsed as a JSON object.
abstract void	onSuccess(JSONObject response) Called when an HTTP response was successfully returned from the WVA, and the response was successfully parsed as a JSON object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient.HttpCallback

public HttpClient.HttpCallback()

Method Detail

onSuccess

public abstract void onSuccess(JSONObject response)

Called when an HTTP response was successfully returned from the WVA, and the response was successfully parsed as a JSON object.

Parameters:

response - the JSON object from the HTTP response

onFailure

public abstract void onFailure(Throwable error)

Called when the HTTP request failed or had an error response. Called in any of these cases:

• The request could not be executed due to cancellation, a connectivity problem, or a timeout.
• An HTTP response was received, but its status code did not indicate success (e.g. 404, 500).
• An HTTP response was received, but its body could not be parsed as a JSON object.

Parameters:

error - the Throwable causing the failure

onJsonParseError

public void onJsonParseError(JSONException error,
                    String rawBody)

Invoked when the HTTP request was successful, but the response body could not be parsed as a JSON object. The default implementation logs the error and invokes onFailure(Throwable).

Parameters:

error - the JSONException raised while parsing the response body

rawBody - the body which could not be parsed as JSON