com.loopj.android.http

Interface ResponseHandlerInterface

All Known Implementing Classes:

AsyncHttpResponseHandler, BaseJsonHttpResponseHandler, BinaryHttpResponseHandler, BlackholeHttpResponseHandler, DataAsyncHttpResponseHandler, FileAsyncHttpResponseHandler, JsonHttpResponseHandler, RangeFileAsyncHttpResponseHandler, SaxAsyncHttpResponseHandler, TextHttpResponseHandler

public interface ResponseHandlerInterface

Interface to standardize implementations

Method Summary

Modifier and Type	Method and Description
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
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	sendCancelMessage() Notifies callback, that request was cancelled
void	sendFailureMessage(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] responseBody, java.lang.Throwable error) 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
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[] responseBody) Notifies callback, that request was handled successfully
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 usePoolThread) Sets whether the handler should be executed on the pool's thread or the UI thread
void	setUseSynchronousMode(boolean useSynchronousMode) Can set, whether the handler should be asynchronous or synchronous

Method Detail

sendResponseMessage

void sendResponseMessage(cz.msebera.android.httpclient.HttpResponse response)
                  throws java.io.IOException

Returns data whether request completed successfully

Parameters:

response - HttpResponse object with data

Throws:

java.io.IOException - if retrieving data from response fails

sendStartMessage

void sendStartMessage()

Notifies callback, that request started execution

sendFinishMessage

void sendFinishMessage()

Notifies callback, that request was completed and is being removed from thread pool

sendProgressMessage

void sendProgressMessage(long bytesWritten,
                         long bytesTotal)

Notifies callback, that request (mainly uploading) has progressed

Parameters:

bytesWritten - number of written bytes

bytesTotal - number of total bytes to be written

sendCancelMessage

void sendCancelMessage()

Notifies callback, that request was cancelled

sendSuccessMessage

void sendSuccessMessage(int statusCode,
                        cz.msebera.android.httpclient.Header[] headers,
                        byte[] responseBody)

Notifies callback, that request was handled successfully

Parameters:

statusCode - HTTP status code

headers - returned headers

responseBody - returned data

sendFailureMessage

void sendFailureMessage(int statusCode,
                        cz.msebera.android.httpclient.Header[] headers,
                        byte[] responseBody,
                        java.lang.Throwable error)

Returns if request was completed with error code or failure of implementation

Parameters:

statusCode - returned HTTP status code

headers - returned headers

responseBody - returned data

error - cause of request failure

sendRetryMessage

void sendRetryMessage(int retryNo)

Notifies callback of retrying request

Parameters:

retryNo - number of retry within one request

getRequestURI

java.net.URI getRequestURI()

Returns URI which was used to request

Returns:

uri of origin request

setRequestURI

void setRequestURI(java.net.URI requestURI)

Helper for handlers to receive Request URI info

Parameters:

requestURI - claimed request URI

getRequestHeaders

cz.msebera.android.httpclient.Header[] getRequestHeaders()

Returns Header[] which were used to request

Returns:

headers from origin request

setRequestHeaders

void setRequestHeaders(cz.msebera.android.httpclient.Header[] requestHeaders)

Helper for handlers to receive Request Header[] info

Parameters:

requestHeaders - Headers, claimed to be from original request

getUseSynchronousMode

boolean getUseSynchronousMode()

Returns whether the handler is asynchronous or synchronous

Returns:

boolean if the ResponseHandler is running in synchronous mode

setUseSynchronousMode

void setUseSynchronousMode(boolean useSynchronousMode)

Can set, whether the handler should be asynchronous or synchronous

Parameters:

useSynchronousMode - whether data should be handled on background Thread on UI Thread

getUsePoolThread

boolean getUsePoolThread()

Returns whether the handler should be executed on the pool's thread or the UI thread

Returns:

boolean if the ResponseHandler should run on pool's thread

setUsePoolThread

void setUsePoolThread(boolean usePoolThread)

Sets whether the handler should be executed on the pool's thread or the UI thread

Parameters:

usePoolThread - if the ResponseHandler should run on pool's thread

onPreProcessResponse

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

Parameters:

instance - An instance of this response object

response - The response to pre-processed

onPostProcessResponse

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

Parameters:

instance - An instance of this response object

response - The response to post-process

getTag

java.lang.Object getTag()

Will retrieve TAG Object if it's not already freed from memory

Returns:

Object TAG or null if it's been garbage collected

setTag

void setTag(java.lang.Object TAG)

Will set TAG to ResponseHandlerInterface implementation, which can be then obtained in implemented methods, such as onSuccess, onFailure, ...

Parameters:

TAG - Object to be set as TAG, will be placed in WeakReference