com.loopj.android.http

Class BinaryHttpResponseHandler

java.lang.Object

com.loopj.android.http.AsyncHttpResponseHandler

com.loopj.android.http.BinaryHttpResponseHandler

All Implemented Interfaces:

ResponseHandlerInterface

public abstract class BinaryHttpResponseHandler
extends AsyncHttpResponseHandler

Used to intercept and handle the responses from requests made using AsyncHttpClient. Receives response body as byte array with a content-type whitelist. (e.g. checks Content-Type against allowed list, Content-length).

For example:

 AsyncHttpClient client = new AsyncHttpClient();
 String[] allowedTypes = new String[] { "image/png" };
 client.get("https://www.example.com/image.png", new BinaryHttpResponseHandler(allowedTypes) {
     @Override
     public void onSuccess(byte[] imageData) {
         // Successfully got a response
     }

     @Override
     public void onFailure(Throwable e, byte[] imageData) {
         // Response failed :(
     }
 });
 

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
BinaryHttpResponseHandler() Creates a new BinaryHttpResponseHandler
BinaryHttpResponseHandler(java.lang.String[] allowedContentTypes) Creates a new BinaryHttpResponseHandler, and overrides the default allowed content types with passed String array (hopefully) of content types.
BinaryHttpResponseHandler(java.lang.String[] allowedContentTypes, android.os.Looper looper) Creates a new BinaryHttpResponseHandler with a user-supplied looper, and overrides the default allowed content types with passed String array (hopefully) of content types.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllowedContentTypes() Method can be overriden to return allowed content types, can be sometimes better than passing data in constructor
abstract void	onFailure(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] binaryData, java.lang.Throwable error) Fired when a request fails to complete, override to handle in your own code
abstract void	onSuccess(int statusCode, cz.msebera.android.httpclient.Header[] headers, byte[] binaryData) Fired when a request returns successfully, override to handle in your own code
void	sendResponseMessage(cz.msebera.android.httpclient.HttpResponse response) Returns data whether request completed successfully

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

BinaryHttpResponseHandler

public BinaryHttpResponseHandler()

Creates a new BinaryHttpResponseHandler

BinaryHttpResponseHandler

public BinaryHttpResponseHandler(java.lang.String[] allowedContentTypes)

Creates a new BinaryHttpResponseHandler, and overrides the default allowed content types with passed String array (hopefully) of content types.

Parameters:

allowedContentTypes - content types array, eg. 'image/jpeg' or pattern '.*'

BinaryHttpResponseHandler

public BinaryHttpResponseHandler(java.lang.String[] allowedContentTypes,
                                 android.os.Looper looper)

Creates a new BinaryHttpResponseHandler with a user-supplied looper, and overrides the default allowed content types with passed String array (hopefully) of content types.

Parameters:

allowedContentTypes - content types array, eg. 'image/jpeg' or pattern '.*'

looper - The looper to work with

Method Detail

getAllowedContentTypes

public java.lang.String[] getAllowedContentTypes()

Method can be overriden to return allowed content types, can be sometimes better than passing data in constructor

Returns:

array of content-types or Pattern string templates (eg. '.*' to match every response)

onSuccess

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

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

binaryData - the body of the HTTP response from the server

onFailure

public abstract void onFailure(int statusCode,
                               cz.msebera.android.httpclient.Header[] headers,
                               byte[] binaryData,
                               java.lang.Throwable error)

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

binaryData - the response body, if any

error - the underlying cause of the failure

sendResponseMessage

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

Overrides:

sendResponseMessage in class AsyncHttpResponseHandler

Parameters:

response - HttpResponse object with data

Throws:

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