com.loopj.android.http

Class FileAsyncHttpResponseHandler

java.lang.Object

com.loopj.android.http.AsyncHttpResponseHandler

com.loopj.android.http.FileAsyncHttpResponseHandler

All Implemented Interfaces:

ResponseHandlerInterface

Direct Known Subclasses:

RangeFileAsyncHttpResponseHandler

public abstract class FileAsyncHttpResponseHandler
extends AsyncHttpResponseHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	append
protected java.io.File	file
protected java.io.File	frontendFile
protected boolean	renameIfExists

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
FileAsyncHttpResponseHandler(android.content.Context context) Obtains new FileAsyncHttpResponseHandler against context with target being temporary file
FileAsyncHttpResponseHandler(java.io.File file) Obtains new FileAsyncHttpResponseHandler and stores response in passed file
FileAsyncHttpResponseHandler(java.io.File file, boolean append) Obtains new FileAsyncHttpResponseHandler and stores response in passed file
FileAsyncHttpResponseHandler(java.io.File file, boolean append, boolean renameTargetFileIfExists) Obtains new FileAsyncHttpResponseHandler and stores response in passed file
FileAsyncHttpResponseHandler(java.io.File file, boolean append, boolean renameTargetFileIfExists, boolean usePoolThread) Obtains new FileAsyncHttpResponseHandler and stores response in passed file

Method Summary

Modifier and Type	Method and Description
boolean	deleteTargetFile() Attempts to delete file with stored response
protected java.io.File	getOriginalFile() Retrieves File object in which the response is stored
protected byte[]	getResponseData(cz.msebera.android.httpclient.HttpEntity entity) Returns byte array of response HttpEntity contents
java.io.File	getTargetFile() Retrieves File which represents response final location after possible renaming
protected java.io.File	getTargetFileByParsingURL() Will return File instance for file representing last URL segment in given folder.
protected java.io.File	getTemporaryFile(android.content.Context context) Used when there is no file to be used when calling constructor
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.Throwable throwable, java.io.File file) Method to be overriden, receives as much of file as possible Called when the file is considered failure or if there is error when retrieving file
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.io.File file) Method to be overriden, receives as much of response as possible

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

Field Detail

file

protected final java.io.File file

append

protected final boolean append

renameIfExists

protected final boolean renameIfExists

frontendFile

protected java.io.File frontendFile

Constructor Detail

FileAsyncHttpResponseHandler

public FileAsyncHttpResponseHandler(java.io.File file)

Obtains new FileAsyncHttpResponseHandler and stores response in passed file

Parameters:

file - File to store response within, must not be null

FileAsyncHttpResponseHandler

public FileAsyncHttpResponseHandler(java.io.File file,
                                    boolean append)

Obtains new FileAsyncHttpResponseHandler and stores response in passed file

Parameters:

file - File to store response within, must not be null

append - whether data should be appended to existing file

FileAsyncHttpResponseHandler

public FileAsyncHttpResponseHandler(java.io.File file,
                                    boolean append,
                                    boolean renameTargetFileIfExists)

Obtains new FileAsyncHttpResponseHandler and stores response in passed file

Parameters:

file - File to store response within, must not be null

append - whether data should be appended to existing file

renameTargetFileIfExists - whether target file should be renamed if it already exists

FileAsyncHttpResponseHandler

public FileAsyncHttpResponseHandler(java.io.File file,
                                    boolean append,
                                    boolean renameTargetFileIfExists,
                                    boolean usePoolThread)

Obtains new FileAsyncHttpResponseHandler and stores response in passed file

Parameters:

file - File to store response within, must not be null

append - whether data should be appended to existing file

renameTargetFileIfExists - whether target file should be renamed if it already exists

usePoolThread - Whether to use the pool's thread to fire callbacks

FileAsyncHttpResponseHandler

public FileAsyncHttpResponseHandler(android.content.Context context)

Obtains new FileAsyncHttpResponseHandler against context with target being temporary file

Parameters:

context - Context, must not be null

Method Detail

deleteTargetFile

public boolean deleteTargetFile()

Attempts to delete file with stored response

Returns:

false if the file does not exist or is null, true if it was successfully deleted

getTemporaryFile

protected java.io.File getTemporaryFile(android.content.Context context)

Used when there is no file to be used when calling constructor

Parameters:

context - Context, must not be null

Returns:

temporary file or null if creating file failed

getOriginalFile

protected java.io.File getOriginalFile()

Retrieves File object in which the response is stored

Returns:

File file in which the response was to be stored

getTargetFile

public java.io.File getTargetFile()

Retrieves File which represents response final location after possible renaming

Returns:

File final target file

getTargetFileByParsingURL

protected java.io.File getTargetFileByParsingURL()

Will return File instance for file representing last URL segment in given folder. If file already exists and renameTargetFileIfExists was set as true, will try to find file which doesn't exist, naming template for such cases is "filename.ext" => "filename (%d).ext", or without extension "filename" => "filename (%d)"

Returns:

File in given directory constructed by last segment of request URL

onFailure

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

onFailure

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

Method to be overriden, receives as much of file as possible Called when the file is considered failure or if there is error when retrieving file

Parameters:

statusCode - http file status line

headers - file http headers if any

throwable - returned throwable

file - file in which the file is stored

onSuccess

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

onSuccess

public abstract void onSuccess(int statusCode,
                               cz.msebera.android.httpclient.Header[] headers,
                               java.io.File file)

Method to be overriden, receives as much of response as possible

Parameters:

statusCode - http response status line

headers - response http headers if any

file - file in which the response is stored

getResponseData

protected byte[] getResponseData(cz.msebera.android.httpclient.HttpEntity entity)
                          throws java.io.IOException

Description copied from class: AsyncHttpResponseHandler

Returns byte array of response HttpEntity contents

Parameters:

entity - can be null

Returns:

response entity body or null

Throws:

java.io.IOException - if reading entity or creating byte array failed