AsyncHttpResponseHandler (library 1.4.9 API)

java.lang.Object
- com.loopj.android.http.AsyncHttpResponseHandler

All Implemented Interfaces:: ResponseHandlerInterface

Direct Known Subclasses:: BinaryHttpResponseHandler, BlackholeHttpResponseHandler, DataAsyncHttpResponseHandler, FileAsyncHttpResponseHandler, SaxAsyncHttpResponseHandler, TextHttpResponseHandler

public abstract class AsyncHttpResponseHandler
extends java.lang.Object
implements ResponseHandlerInterface

Used to intercept and handle the responses from requests made using AsyncHttpClient. The onSuccess(int, cz.msebera.android.httpclient.Header[], byte[]) 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[], byte[], Throwable), onStart(), onFinish(), onRetry(int) and onProgress(long, long) methods as required.

For example:

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

     @Override
     public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {
         // Successfully got a response
     }

     @Override
     public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable
 error)
 {
         // Response failed :(
     }

     @Override
     public void onRetry(int retryNo) {
         // Request was retried
     }

     @Override
     public void onProgress(long bytesWritten, long totalSize) {
         // Progress notification
     }

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`BUFFER_SIZE`
`protected static int`	`CANCEL_MESSAGE`
`static java.lang.String`	`DEFAULT_CHARSET`
`protected static int`	`FAILURE_MESSAGE`
`protected static int`	`FINISH_MESSAGE`
`protected static int`	`PROGRESS_MESSAGE`
`protected static int`	`RETRY_MESSAGE`
`protected static int`	`START_MESSAGE`
`protected static int`	`SUCCESS_MESSAGE`
`static java.lang.String`	`UTF8_BOM`

Constructor Summary

Constructors
Constructor and Description
`AsyncHttpResponseHandler()` Creates a new AsyncHttpResponseHandler
`AsyncHttpResponseHandler(boolean usePoolThread)` Creates a new AsyncHttpResponseHandler and decide whether the callbacks will be fired on current thread's looper or the pool thread's.
`AsyncHttpResponseHandler(android.os.Looper looper)` Creates a new AsyncHttpResponseHandler with a user-supplied looper.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCharset()`
`cz.msebera.android.httpclient.Header[]`	`getRequestHeaders()` Returns Header[] which were used to request
`java.net.URI`	`getRequestURI()` Returns URI which was used to request
`java.lang.Object`	`getTag()` Will retrieve TAG Object if it's not already freed from memory
`boolean`	`getUsePoolThread()` Returns whether the handler should be executed on the pool's thread or the UI thread
`boolean`	`getUseSynchronousMode()` Returns whether the handler is asynchronous or synchronous
`protected void`	`handleMessage(android.os.Message message)`
`protected android.os.Message`	`obtainMessage(int responseMessageId, java.lang.Object responseMessageData)` Helper method to create Message instance from handler
`void`	`onCancel()`
`abstract void`	`onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBody, java.lang.Throwable error)` Fired when a request fails to complete, override to handle in your own code
`void`	`onFinish()` Fired in all cases when the request is finished, after both success and failure, override to handle in your own code
`void`	`onPostProcessResponse(ResponseHandlerInterface instance, cz.msebera.android.httpclient.HttpResponse response)` This method is called once by the system when the request has been fully sent, handled and finished.
`void`	`onPreProcessResponse(ResponseHandlerInterface instance, cz.msebera.android.httpclient.HttpResponse response)` This method is called once by the system when the response is about to be processed by the system.
`void`	`onProgress(long bytesWritten, long totalSize)` Fired when the request progress, override to handle in your own code
`void`	`onRetry(int retryNo)` Fired when a retry occurs, override to handle in your own code
`void`	`onStart()` Fired when the request is started, override to handle in your own code
`abstract void`	`onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBody)` Fired when a request returns successfully, override to handle in your own code
`void`	`onUserException(java.lang.Throwable error)`
`protected void`	`postRunnable(java.lang.Runnable runnable)` Helper method to send runnable into local handler loop
`void`	`sendCancelMessage()` Notifies callback, that request was cancelled
`void`	`sendFailureMessage(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBody, java.lang.Throwable throwable)` Returns if request was completed with error code or failure of implementation
`void`	`sendFinishMessage()` Notifies callback, that request was completed and is being removed from thread pool
`protected void`	`sendMessage(android.os.Message msg)`
`void`	`sendProgressMessage(long bytesWritten, long bytesTotal)` Notifies callback, that request (mainly uploading) has progressed
`void`	`sendResponseMessage(cz.msebera.android.httpclient.HttpResponse response)` Returns data whether request completed successfully
`void`	`sendRetryMessage(int retryNo)` Notifies callback of retrying request
`void`	`sendStartMessage()` Notifies callback, that request started execution
`void`	`sendSuccessMessage(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBytes)` Notifies callback, that request was handled successfully
`void`	`setCharset(java.lang.String charset)` Sets the charset for the response string.
`void`	`setRequestHeaders(cz.msebera.android.httpclient.Header[] requestHeaders)` Helper for handlers to receive Request Header[] info
`void`	`setRequestURI(java.net.URI requestURI)` Helper for handlers to receive Request URI info
`void`	`setTag(java.lang.Object TAG)` Will set TAG to ResponseHandlerInterface implementation, which can be then obtained in implemented methods, such as onSuccess, onFailure, ...
`void`	`setUsePoolThread(boolean pool)` Sets whether the handler should be executed on the pool's thread or the UI thread
`void`	`setUseSynchronousMode(boolean sync)` Can set, whether the handler should be asynchronous or synchronous

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

- Field Detail
  - DEFAULT_CHARSET
```
public static final java.lang.String DEFAULT_CHARSET
```
    See Also:
    
    Constant Field Values
  - UTF8_BOM
```
public static final java.lang.String UTF8_BOM
```
    See Also:
    
    Constant Field Values
  - SUCCESS_MESSAGE
```
protected static final int SUCCESS_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FAILURE_MESSAGE
```
protected static final int FAILURE_MESSAGE
```
    See Also:
    
    Constant Field Values
  - START_MESSAGE
```
protected static final int START_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FINISH_MESSAGE
```
protected static final int FINISH_MESSAGE
```
    See Also:
    
    Constant Field Values
  - PROGRESS_MESSAGE
```
protected static final int PROGRESS_MESSAGE
```
    See Also:
    
    Constant Field Values
  - RETRY_MESSAGE
```
protected static final int RETRY_MESSAGE
```
    See Also:
    
    Constant Field Values
  - CANCEL_MESSAGE
```
protected static final int CANCEL_MESSAGE
```
    See Also:
    
    Constant Field Values
  - BUFFER_SIZE
```
protected static final int BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler()
```
    Creates a new AsyncHttpResponseHandler
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler(android.os.Looper looper)
```
    Creates a new AsyncHttpResponseHandler with a user-supplied looper. If the passed looper is null, the looper attached to the current thread will be used.
    
    Parameters:
    
    looper - The looper to work with
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler(boolean usePoolThread)
```
    Creates a new AsyncHttpResponseHandler and decide whether the callbacks will be fired on current thread's looper or the pool thread's.
    
    Parameters:
    
    usePoolThread - Whether to use the pool's thread to fire callbacks
- Method Detail
  - getTag
```
public java.lang.Object getTag()
```
    Description copied from interface: ResponseHandlerInterface
    
    Will retrieve TAG Object if it's not already freed from memory
    
    Specified by:
    
    getTag in interface ResponseHandlerInterface
    
    Returns:
    
    Object TAG or null if it's been garbage collected
  - setTag
```
public void setTag(java.lang.Object TAG)
```
    Description copied from interface: ResponseHandlerInterface
    
    Will set TAG to ResponseHandlerInterface implementation, which can be then obtained in implemented methods, such as onSuccess, onFailure, ...
    
    Specified by:
    
    setTag in interface ResponseHandlerInterface
    
    Parameters:
    
    TAG - Object to be set as TAG, will be placed in WeakReference
  - getRequestURI
```
public java.net.URI getRequestURI()
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns URI which was used to request
    
    Specified by:
    
    getRequestURI in interface ResponseHandlerInterface
    
    Returns:
    
    uri of origin request
  - setRequestURI
```
public void setRequestURI(java.net.URI requestURI)
```
    Description copied from interface: ResponseHandlerInterface
    
    Helper for handlers to receive Request URI info
    
    Specified by:
    
    setRequestURI in interface ResponseHandlerInterface
    
    Parameters:
    
    requestURI - claimed request URI
  - getRequestHeaders
```
public cz.msebera.android.httpclient.Header[] getRequestHeaders()
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns Header[] which were used to request
    
    Specified by:
    
    getRequestHeaders in interface ResponseHandlerInterface
    
    Returns:
    
    headers from origin request
  - setRequestHeaders
```
public void setRequestHeaders(cz.msebera.android.httpclient.Header[] requestHeaders)
```
    Description copied from interface: ResponseHandlerInterface
    
    Helper for handlers to receive Request Header[] info
    
    Specified by:
    
    setRequestHeaders in interface ResponseHandlerInterface
    
    Parameters:
    
    requestHeaders - Headers, claimed to be from original request
  - getUseSynchronousMode
```
public boolean getUseSynchronousMode()
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns whether the handler is asynchronous or synchronous
    
    Specified by:
    
    getUseSynchronousMode in interface ResponseHandlerInterface
    
    Returns:
    
    boolean if the ResponseHandler is running in synchronous mode
  - setUseSynchronousMode
```
public void setUseSynchronousMode(boolean sync)
```
    Description copied from interface: ResponseHandlerInterface
    
    Can set, whether the handler should be asynchronous or synchronous
    
    Specified by:
    
    setUseSynchronousMode in interface ResponseHandlerInterface
    
    Parameters:
    
    sync - whether data should be handled on background Thread on UI Thread
  - getUsePoolThread
```
public boolean getUsePoolThread()
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns whether the handler should be executed on the pool's thread or the UI thread
    
    Specified by:
    
    getUsePoolThread in interface ResponseHandlerInterface
    
    Returns:
    
    boolean if the ResponseHandler should run on pool's thread
  - setUsePoolThread
```
public void setUsePoolThread(boolean pool)
```
    Description copied from interface: ResponseHandlerInterface
    
    Sets whether the handler should be executed on the pool's thread or the UI thread
    
    Specified by:
    
    setUsePoolThread in interface ResponseHandlerInterface
    
    Parameters:
    
    pool - if the ResponseHandler should run on pool's thread
  - getCharset
```
public java.lang.String getCharset()
```
  - setCharset
```
public void setCharset(java.lang.String charset)
```
    Sets the charset for the response string. If not set, the default is UTF-8.
    
    Parameters:
    
    charset - to be used for the response string.
    
    See Also:
    
    Charset
  - onProgress
```
public void onProgress(long bytesWritten,
                       long totalSize)
```
    Fired when the request progress, override to handle in your own code
    
    Parameters:
    
    bytesWritten - offset from start of file
    
    totalSize - total size of file
  - onStart
```
public void onStart()
```
    Fired when the request is started, override to handle in your own code
  - onFinish
```
public void onFinish()
```
    Fired in all cases when the request is finished, after both success and failure, override to handle in your own code
  - onPreProcessResponse
```
public void onPreProcessResponse(ResponseHandlerInterface instance,
                                 cz.msebera.android.httpclient.HttpResponse response)
```
    Description copied from interface: ResponseHandlerInterface
    
    This method is called once by the system when the response is about to be processed by the system. The library makes sure that a single response is pre-processed only once.
    
    Please note: pre-processing does NOT run on the main thread, and thus any UI activities that you must perform should be properly dispatched to the app's UI thread.
    
    Specified by:
    
    onPreProcessResponse in interface ResponseHandlerInterface
    
    Parameters:
    
    instance - An instance of this response object
    
    response - The response to pre-processed
  - onPostProcessResponse
```
public void onPostProcessResponse(ResponseHandlerInterface instance,
                                  cz.msebera.android.httpclient.HttpResponse response)
```
    Description copied from interface: ResponseHandlerInterface
    
    This method is called once by the system when the request has been fully sent, handled and finished. The library makes sure that a single response is post-processed only once.
    
    Please note: post-processing does NOT run on the main thread, and thus any UI activities that you must perform should be properly dispatched to the app's UI thread.
    
    Specified by:
    
    onPostProcessResponse in interface ResponseHandlerInterface
    
    Parameters:
    
    instance - An instance of this response object
    
    response - The response to post-process
  - onSuccess
```
public abstract void onSuccess(int statusCode,
                               cz.msebera.android.httpclient.Header[] headers,
                               byte[] responseBody)
```
    Fired when a request returns successfully, override to handle in your own code
    
    Parameters:
    
    statusCode - the status code of the response
    
    headers - return headers, if any
    
    responseBody - the body of the HTTP response from the server
  - onFailure
```
public abstract void onFailure(int statusCode,
                               cz.msebera.android.httpclient.Header[] headers,
                               byte[] responseBody,
                               java.lang.Throwable error)
```
    Fired when a request fails to complete, override to handle in your own code
    
    Parameters:
    
    statusCode - return HTTP status code
    
    headers - return headers, if any
    
    responseBody - the response body, if any
    
    error - the underlying cause of the failure
  - onRetry
```
public void onRetry(int retryNo)
```
    Fired when a retry occurs, override to handle in your own code
    
    Parameters:
    
    retryNo - number of retry
  - onCancel
```
public void onCancel()
```
  - onUserException
```
public void onUserException(java.lang.Throwable error)
```
  - sendProgressMessage
```
public final void sendProgressMessage(long bytesWritten,
                                      long bytesTotal)
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback, that request (mainly uploading) has progressed
    
    Specified by:
    
    sendProgressMessage in interface ResponseHandlerInterface
    
    Parameters:
    
    bytesWritten - number of written bytes
    
    bytesTotal - number of total bytes to be written
  - sendSuccessMessage
```
public final void sendSuccessMessage(int statusCode,
                                     cz.msebera.android.httpclient.Header[] headers,
                                     byte[] responseBytes)
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback, that request was handled successfully
    
    Specified by:
    
    sendSuccessMessage in interface ResponseHandlerInterface
    
    Parameters:
    
    statusCode - HTTP status code
    
    headers - returned headers
    
    responseBytes - returned data
  - sendFailureMessage
```
public final void sendFailureMessage(int statusCode,
                                     cz.msebera.android.httpclient.Header[] headers,
                                     byte[] responseBody,
                                     java.lang.Throwable throwable)
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns if request was completed with error code or failure of implementation
    
    Specified by:
    
    sendFailureMessage in interface ResponseHandlerInterface
    
    Parameters:
    
    statusCode - returned HTTP status code
    
    headers - returned headers
    
    responseBody - returned data
    
    throwable - cause of request failure
  - sendStartMessage
```
public final void sendStartMessage()
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback, that request started execution
    
    Specified by:
    
    sendStartMessage in interface ResponseHandlerInterface
  - sendFinishMessage
```
public final void sendFinishMessage()
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback, that request was completed and is being removed from thread pool
    
    Specified by:
    
    sendFinishMessage in interface ResponseHandlerInterface
  - sendRetryMessage
```
public final void sendRetryMessage(int retryNo)
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback of retrying request
    
    Specified by:
    
    sendRetryMessage in interface ResponseHandlerInterface
    
    Parameters:
    
    retryNo - number of retry within one request
  - sendCancelMessage
```
public final void sendCancelMessage()
```
    Description copied from interface: ResponseHandlerInterface
    
    Notifies callback, that request was cancelled
    
    Specified by:
    
    sendCancelMessage in interface ResponseHandlerInterface
  - handleMessage
```
protected void handleMessage(android.os.Message message)
```
  - sendMessage
```
protected void sendMessage(android.os.Message msg)
```
  - postRunnable
```
protected void postRunnable(java.lang.Runnable runnable)
```
    Helper method to send runnable into local handler loop
    
    Parameters:
    
    runnable - runnable instance, can be null
  - obtainMessage
```
protected android.os.Message obtainMessage(int responseMessageId,
                                           java.lang.Object responseMessageData)
```
    Helper method to create Message instance from handler
    
    Parameters:
    
    responseMessageId - constant to identify Handler message
    
    responseMessageData - object to be passed to message receiver
    
    Returns:
    
    Message instance, should not be null
  - sendResponseMessage
```
public void sendResponseMessage(cz.msebera.android.httpclient.HttpResponse response)
                         throws java.io.IOException
```
    Description copied from interface: ResponseHandlerInterface
    
    Returns data whether request completed successfully
    
    Specified by:
    
    sendResponseMessage in interface ResponseHandlerInterface
    
    Parameters:
    
    response - HttpResponse object with data
    
    Throws:
    
    java.io.IOException - if retrieving data from response fails

Class AsyncHttpResponseHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CHARSET

UTF8_BOM

SUCCESS_MESSAGE

FAILURE_MESSAGE

START_MESSAGE

FINISH_MESSAGE

PROGRESS_MESSAGE

RETRY_MESSAGE

CANCEL_MESSAGE

BUFFER_SIZE

Constructor Detail

AsyncHttpResponseHandler

AsyncHttpResponseHandler

AsyncHttpResponseHandler

Method Detail

getTag

setTag

getRequestURI

setRequestURI

getRequestHeaders

setRequestHeaders

getUseSynchronousMode

setUseSynchronousMode

getUsePoolThread

setUsePoolThread

getCharset

setCharset

onProgress

onStart

onFinish

onPreProcessResponse

onPostProcessResponse

onSuccess

onFailure

onRetry

onCancel

onUserException

sendProgressMessage

sendSuccessMessage

sendFailureMessage

sendStartMessage

sendFinishMessage

sendRetryMessage

sendCancelMessage

handleMessage

sendMessage

postRunnable

obtainMessage

sendResponseMessage