com.loopj.android.http

Class JsonHttpResponseHandler

java.lang.Object

com.loopj.android.http.AsyncHttpResponseHandler

com.loopj.android.http.TextHttpResponseHandler

com.loopj.android.http.JsonHttpResponseHandler

All Implemented Interfaces:

ResponseHandlerInterface

public class JsonHttpResponseHandler
extends TextHttpResponseHandler

Used to intercept and handle the responses from requests made using AsyncHttpClient, with automatic parsing into a JSONObject or JSONArray.

This class is designed to be passed to get, post, put and delete requests with the onSuccess(int, cz.msebera.android.httpclient.Header[], org.json.JSONArray) or onSuccess(int, cz.msebera.android.httpclient.Header[], org.json.JSONObject) methods anonymously overridden.

Additionally, you can override the other event methods from the parent class.

Field Summary

Fields inherited from class com.loopj.android.http.AsyncHttpResponseHandler

BUFFER_SIZE, CANCEL_MESSAGE, DEFAULT_CHARSET, FAILURE_MESSAGE, FINISH_MESSAGE, PROGRESS_MESSAGE, RETRY_MESSAGE, START_MESSAGE, SUCCESS_MESSAGE, UTF8_BOM

Constructor Summary

Constructors

Constructor and Description
JsonHttpResponseHandler() Creates new JsonHttpResponseHandler, with JSON String encoding UTF-8
JsonHttpResponseHandler(boolean useRFC5179CompatibilityMode) Creates new JsonHttpResponseHandler with JSON String encoding UTF-8 and given RFC5179CompatibilityMode
JsonHttpResponseHandler(java.lang.String encoding) Creates new JsonHttpResponseHandler with given JSON String encoding
JsonHttpResponseHandler(java.lang.String encoding, boolean useRFC5179CompatibilityMode) Creates new JsonHttpResponseHandler with given JSON String encoding and RFC5179CompatibilityMode

Method Summary

Modifier and Type	Method and Description
boolean	isUseRFC5179CompatibilityMode()
void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBytes, java.lang.Throwable throwable) Fired when a request fails to complete, override to handle in your own code
void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString, java.lang.Throwable throwable) Called when request fails
void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.Throwable throwable, org.json.JSONArray errorResponse) Returns when request failed
void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.Throwable throwable, org.json.JSONObject errorResponse) Returns when request failed
void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBytes) Fired when a request returns successfully, override to handle in your own code
void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, org.json.JSONArray response) Returns when request succeeds
void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, org.json.JSONObject response) Returns when request succeeds
void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString) Called when request succeeds
protected java.lang.Object	parseResponse(byte[] responseBody) Returns Object of type JSONObject, JSONArray, String, Boolean, Integer, Long, Double or JSONObject.NULL, see JSONTokener.nextValue()
void	setUseRFC5179CompatibilityMode(boolean useRFC5179CompatibilityMode)

Methods inherited from class com.loopj.android.http.TextHttpResponseHandler

getResponseString

Methods inherited from class com.loopj.android.http.AsyncHttpResponseHandler

getCharset, getRequestHeaders, getRequestURI, getTag, getUsePoolThread, getUseSynchronousMode, handleMessage, obtainMessage, onCancel, onFinish, onPostProcessResponse, onPreProcessResponse, onProgress, onRetry, onStart, onUserException, postRunnable, sendCancelMessage, sendFailureMessage, sendFinishMessage, sendMessage, sendProgressMessage, sendResponseMessage, sendRetryMessage, sendStartMessage, sendSuccessMessage, setCharset, setRequestHeaders, setRequestURI, setTag, setUsePoolThread, setUseSynchronousMode

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonHttpResponseHandler

public JsonHttpResponseHandler()

Creates new JsonHttpResponseHandler, with JSON String encoding UTF-8

JsonHttpResponseHandler

public JsonHttpResponseHandler(java.lang.String encoding)

Creates new JsonHttpResponseHandler with given JSON String encoding

Parameters:

encoding - String encoding to be used when parsing JSON

JsonHttpResponseHandler

public JsonHttpResponseHandler(boolean useRFC5179CompatibilityMode)

Creates new JsonHttpResponseHandler with JSON String encoding UTF-8 and given RFC5179CompatibilityMode

Parameters:

useRFC5179CompatibilityMode - Boolean mode to use RFC5179 or latest

JsonHttpResponseHandler

public JsonHttpResponseHandler(java.lang.String encoding,
                               boolean useRFC5179CompatibilityMode)

Creates new JsonHttpResponseHandler with given JSON String encoding and RFC5179CompatibilityMode

Parameters:

encoding - String encoding to be used when parsing JSON

useRFC5179CompatibilityMode - Boolean mode to use RFC5179 or latest

Method Detail

onSuccess

public void onSuccess(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      org.json.JSONObject response)

Returns when request succeeds

Parameters:

statusCode - http response status line

headers - response headers if any

response - parsed response if any

onSuccess

public void onSuccess(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      org.json.JSONArray response)

Returns when request succeeds

Parameters:

statusCode - http response status line

headers - response headers if any

response - parsed response if any

onFailure

public void onFailure(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      java.lang.Throwable throwable,
                      org.json.JSONObject errorResponse)

Returns when request failed

Parameters:

statusCode - http response status line

headers - response headers if any

throwable - throwable describing the way request failed

errorResponse - parsed response if any

onFailure

public void onFailure(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      java.lang.Throwable throwable,
                      org.json.JSONArray errorResponse)

Returns when request failed

Parameters:

statusCode - http response status line

headers - response headers if any

throwable - throwable describing the way request failed

errorResponse - parsed response if any

onFailure

public void onFailure(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      java.lang.String responseString,
                      java.lang.Throwable throwable)

Description copied from class: TextHttpResponseHandler

Called when request fails

Specified by:

onFailure in class TextHttpResponseHandler

Parameters:

statusCode - http response status line

headers - response headers if any

responseString - string response of given charset

throwable - throwable returned when processing request

onSuccess

public void onSuccess(int statusCode,
                      cz.msebera.android.httpclient.Header[] headers,
                      java.lang.String responseString)

Description copied from class: TextHttpResponseHandler

Called when request succeeds

Specified by:

onSuccess in class TextHttpResponseHandler

Parameters:

statusCode - http response status line

headers - response headers if any

responseString - string response of given charset

onSuccess

public final void onSuccess(int statusCode,
                            cz.msebera.android.httpclient.Header[] headers,
                            byte[] responseBytes)

Description copied from class: AsyncHttpResponseHandler

Fired when a request returns successfully, override to handle in your own code

Overrides:

onSuccess in class TextHttpResponseHandler

Parameters:

statusCode - the status code of the response

headers - return headers, if any

responseBytes - the body of the HTTP response from the server

onFailure

public final void onFailure(int statusCode,
                            cz.msebera.android.httpclient.Header[] headers,
                            byte[] responseBytes,
                            java.lang.Throwable throwable)

Description copied from class: AsyncHttpResponseHandler

Fired when a request fails to complete, override to handle in your own code

Overrides:

onFailure in class TextHttpResponseHandler

Parameters:

statusCode - return HTTP status code

headers - return headers, if any

responseBytes - the response body, if any

throwable - the underlying cause of the failure

parseResponse

protected java.lang.Object parseResponse(byte[] responseBody)
                                  throws org.json.JSONException

Returns Object of type JSONObject, JSONArray, String, Boolean, Integer, Long, Double or JSONObject.NULL, see JSONTokener.nextValue()

Parameters:

responseBody - response bytes to be assembled in String and parsed as JSON

Returns:

Object parsedResponse

Throws:

org.json.JSONException - exception if thrown while parsing JSON

isUseRFC5179CompatibilityMode

public boolean isUseRFC5179CompatibilityMode()

setUseRFC5179CompatibilityMode

public void setUseRFC5179CompatibilityMode(boolean useRFC5179CompatibilityMode)