com.loopj.android.http

Class TextHttpResponseHandler

java.lang.Object

com.loopj.android.http.AsyncHttpResponseHandler

com.loopj.android.http.TextHttpResponseHandler

All Implemented Interfaces:

ResponseHandlerInterface

Direct Known Subclasses:

BaseJsonHttpResponseHandler, JsonHttpResponseHandler

public abstract class TextHttpResponseHandler
extends AsyncHttpResponseHandler

Used to intercept and handle the responses from requests made using AsyncHttpClient. The onSuccess(int, cz.msebera.android.httpclient.Header[], String) method is designed to be anonymously overridden with your own response handling code.

Additionally, you can override the onFailure(int, cz.msebera.android.httpclient.Header[], String, Throwable), AsyncHttpResponseHandler.onStart(), and AsyncHttpResponseHandler.onFinish() methods as required.

For example:

 AsyncHttpClient client = new AsyncHttpClient();
 client.get("https://www.google.com", new TextHttpResponseHandler() {
     @Override
     public void onStart() {
         // Initiated the request
     }

     @Override
     public void onSuccess(String responseBody) {
         // Successfully got a response
     }

     @Override
     public void onFailure(String responseBody, Throwable e) {
         // Response failed :(
     }

     @Override
     public void onFinish() {
         // Completed the request (either success or failure)
     }
 });
 

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
TextHttpResponseHandler() Creates new instance with default UTF-8 encoding
TextHttpResponseHandler(java.lang.String encoding) Creates new instance with given string encoding

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getResponseString(byte[] stringBytes, java.lang.String charset) Attempts to encode response bytes as string of set encoding
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
abstract void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString, java.lang.Throwable throwable) Called when request fails
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
abstract void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, java.lang.String responseString) Called when request succeeds

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

TextHttpResponseHandler

public TextHttpResponseHandler()

Creates new instance with default UTF-8 encoding

TextHttpResponseHandler

public TextHttpResponseHandler(java.lang.String encoding)

Creates new instance with given string encoding

Parameters:

encoding - String encoding, see AsyncHttpResponseHandler.setCharset(String)

Method Detail

getResponseString

public static java.lang.String getResponseString(byte[] stringBytes,
                                                 java.lang.String charset)

Attempts to encode response bytes as string of set encoding

Parameters:

charset - charset to create string with

stringBytes - response bytes

Returns:

String of set encoding or null

onFailure

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

Called when request fails

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 abstract void onSuccess(int statusCode,
                               cz.msebera.android.httpclient.Header[] headers,
                               java.lang.String responseString)

Called when request succeeds

Parameters:

statusCode - http response status line

headers - response headers if any

responseString - string response of given charset

onSuccess

public 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

Specified by:

onSuccess in class AsyncHttpResponseHandler

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

Specified by:

onFailure in class AsyncHttpResponseHandler

Parameters:

statusCode - return HTTP status code

headers - return headers, if any

responseBytes - the response body, if any

throwable - the underlying cause of the failure