com.box.androidsdk.content.requests

Class BoxRequestDownload<E extends BoxObject,R extends BoxRequest<E,R>>

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestDownload<E,R>

Type Parameters:

E - type of BoxObject returned in the response.

R - type of BoxRequest being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsFile.DownloadFile, BoxRequestsFile.DownloadThumbnail

public abstract class BoxRequestDownload<E extends BoxObject,R extends BoxRequest<E,R>>
extends BoxRequest<E,R>

Abstract class that represents a request to download a file or thumbnail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxRequestDownload.DownloadRequestHandler A request handler that is designed to handle the parsing logic necessary for a BoxRequestDownload.

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
protected DownloadStartListener	mDownloadStartListener
protected java.io.OutputStream	mFileOutputStream
protected java.lang.String	mId
protected long	mRangeEnd
protected long	mRangeStart
protected java.io.File	mTarget

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
BoxRequestDownload(java.lang.Class<E> clazz, java.io.File target, java.lang.String requestUrl, BoxSession session) Deprecated. Please use the BoxRequestDownload constructor that takes in an id as this method may be removed in future releases
BoxRequestDownload(java.lang.Class<E> clazz, java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Deprecated. Please use the BoxRequestDownload constructor that takes in an id as this method may be removed in future releases
BoxRequestDownload(java.lang.String id, java.lang.Class<E> clazz, java.io.File target, java.lang.String requestUrl, BoxSession session) Creates a download request to a file with the default parameters.
BoxRequestDownload(java.lang.String id, java.lang.Class<E> clazz, java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Creates a download request to an output stream with the default parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of the Box item being modified.
long	getRangeEnd() Returns the end range for the download.
long	getRangeStart() Returns the start range for the download.
java.io.File	getTarget() Returns the target file for the download.
java.io.OutputStream	getTargetStream() Returns the target output stream for the download.
java.lang.String	getVersion() If set in this request, the version id of an item to be downloaded.
protected void	logDebug(BoxHttpResponse response)
R	setDownloadStartListener(DownloadStartListener listener) Sets the download start listener for the request.
protected void	setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)
R	setProgressListener(ProgressListener listener) Sets the progress listener for the download request.
R	setRange(long rangeStart, long rangeEnd) The portion of a file to download.
R	setVersion(java.lang.String versionId) Sets the version of the file to download.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logRequest, onSend, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mRangeStart

protected long mRangeStart

mRangeEnd

protected long mRangeEnd

mFileOutputStream

protected java.io.OutputStream mFileOutputStream

mTarget

protected java.io.File mTarget

mDownloadStartListener

protected DownloadStartListener mDownloadStartListener

mId

protected java.lang.String mId

Constructor Detail

BoxRequestDownload

public BoxRequestDownload(java.lang.String id,
                          java.lang.Class<E> clazz,
                          java.io.OutputStream outputStream,
                          java.lang.String requestUrl,
                          BoxSession session)

Creates a download request to an output stream with the default parameters.

Parameters:

id - id of the item to download

clazz - class of the object returned in the response.

outputStream - output stream to download the file to.

requestUrl - URL of the download endpoint.

session - the authenticated session that will be used to make the request with.

BoxRequestDownload

@Deprecated
public BoxRequestDownload(java.lang.Class<E> clazz,
                                      java.io.OutputStream outputStream,
                                      java.lang.String requestUrl,
                                      BoxSession session)

Deprecated. Please use the BoxRequestDownload constructor that takes in an id as this method may be removed in future releases

Creates a download request to an output stream with the default parameters.

Parameters:

clazz - class of the object returned in the response.

outputStream - output stream to download the file to.

requestUrl - URL of the download endpoint.

session - the authenticated session that will be used to make the request with.

BoxRequestDownload

public BoxRequestDownload(java.lang.String id,
                          java.lang.Class<E> clazz,
                          java.io.File target,
                          java.lang.String requestUrl,
                          BoxSession session)

Creates a download request to a file with the default parameters.

Parameters:

id - box file id to download.

clazz - class of the object returned in the response.

target - target file to download the file to.

requestUrl - URL of the download endpoint.

session - the authenticated session that will be used to make the request with.

BoxRequestDownload

@Deprecated
public BoxRequestDownload(java.lang.Class<E> clazz,
                                      java.io.File target,
                                      java.lang.String requestUrl,
                                      BoxSession session)

Deprecated. Please use the BoxRequestDownload constructor that takes in an id as this method may be removed in future releases

Creates a download request to a file with the default parameters.

Parameters:

clazz - class of the object returned in the response.

target - target file to download the file to.

requestUrl - URL of the download endpoint.

session - the authenticated session that will be used to make the request with.

Method Detail

getId

public java.lang.String getId()

Returns the id of the Box item being modified.

Returns:

the id of the Box item that this request is attempting to modify.

setHeaders

protected void setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)

Overrides:

setHeaders in class BoxRequest<E extends BoxObject,R extends BoxRequest<E,R>>

logDebug

protected void logDebug(BoxHttpResponse response)
                 throws BoxException

Overrides:

logDebug in class BoxRequest<E extends BoxObject,R extends BoxRequest<E,R>>

Throws:

BoxException

getTarget

public java.io.File getTarget()

Returns the target file for the download.

Returns:

file to target for the download.

getTargetStream

public java.io.OutputStream getTargetStream()

Returns the target output stream for the download.

Returns:

output stream to target for the download.

getRangeStart

public long getRangeStart()

Returns the start range for the download.

Returns:

if set returns the start range specified by setRange, -1 otherwise.

getRangeEnd

public long getRangeEnd()

Returns the end range for the download.

Returns:

if set returns the end range specified by setRange, -1 otherwise.

setRange

public R setRange(long rangeStart,
                  long rangeEnd)

The portion of a file to download.

Parameters:

rangeStart - value in bytes from which to begin downloading an item.

rangeEnd - value in bytes to end downloading an item.

Returns:

this download request

setVersion

public R setVersion(java.lang.String versionId)

Sets the version of the file to download.

Parameters:

versionId - the version id of an item if a previous version(see file_version field for file) is desired instead of the current.

Returns:

this download request

getVersion

public java.lang.String getVersion()

If set in this request, the version id of an item to be downloaded.

Returns:

the version set for this request.

setProgressListener

public R setProgressListener(ProgressListener listener)

Sets the progress listener for the download request.

Parameters:

listener - progress listener for the download.

Returns:

this download request.

setDownloadStartListener

public R setDownloadStartListener(DownloadStartListener listener)

Sets the download start listener for the request.

Parameters:

listener - an optional listener for knowing when the download for this request has started.

Returns:

this download request object.