com.loopj.android.http

Class BaseJsonHttpResponseHandler<JSON_TYPE>

java.lang.Object

com.loopj.android.http.AsyncHttpResponseHandler

com.loopj.android.http.TextHttpResponseHandler

com.loopj.android.http.BaseJsonHttpResponseHandler<JSON_TYPE>

Type Parameters:

JSON_TYPE - Generic type meant to be returned in callback

All Implemented Interfaces:

ResponseHandlerInterface

public abstract class BaseJsonHttpResponseHandler<JSON_TYPE>
extends TextHttpResponseHandler

Class meant to be used with custom JSON parser (such as GSON or Jackson JSON)

parseResponse(String, boolean) should be overriden and must return type of generic param class, response will be then handled to implementation of abstract methods onSuccess(int, cz.msebera.android.httpclient.Header[], String, Object) or onFailure(int, cz.msebera.android.httpclient.Header[], Throwable, String, Object), depending of response HTTP status line (result http code)

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
BaseJsonHttpResponseHandler() Creates a new JsonHttpResponseHandler with default charset "UTF-8"
BaseJsonHttpResponseHandler(java.lang.String encoding) Creates a new JsonHttpResponseHandler with given string encoding

Method Summary

Modifier and Type	Method and Description
void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString, java.lang.Throwable throwable) Called when request fails
abstract void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.Throwable throwable, java.lang.String rawJsonData, JSON_TYPE errorResponse) Base abstract method, handling defined generic type
void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString) Called when request succeeds
abstract void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String rawJsonResponse, JSON_TYPE response) Base abstract method, handling defined generic type
protected abstract JSON_TYPE	parseResponse(java.lang.String rawJsonData, boolean isFailure) Should return deserialized instance of generic type, may return object for more vague handling

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

getResponseString, onFailure, onSuccess

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

BaseJsonHttpResponseHandler

public BaseJsonHttpResponseHandler()

Creates a new JsonHttpResponseHandler with default charset "UTF-8"

BaseJsonHttpResponseHandler

public BaseJsonHttpResponseHandler(java.lang.String encoding)

Creates a new JsonHttpResponseHandler with given string encoding

Parameters:

encoding - result string encoding, see Charset

Method Detail

onSuccess

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

Base abstract method, handling defined generic type

Parameters:

statusCode - HTTP status line

headers - response headers

rawJsonResponse - string of response, can be null

response - response returned by parseResponse(String, boolean)

onFailure

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

Base abstract method, handling defined generic type

Parameters:

statusCode - HTTP status line

headers - response headers

throwable - error thrown while processing request

rawJsonData - raw string data returned if any

errorResponse - response returned by parseResponse(String, boolean)

onSuccess

public final 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

onFailure

public final 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

parseResponse

protected abstract JSON_TYPE parseResponse(java.lang.String rawJsonData,
                                           boolean isFailure)
                                    throws java.lang.Throwable

Should return deserialized instance of generic type, may return object for more vague handling

Parameters:

rawJsonData - response string, may be null

isFailure - indicating if this method is called from onFailure or not

Returns:

object of generic type or possibly null if you choose so

Throws:

java.lang.Throwable - allows you to throw anything from within deserializing JSON response