com.box.androidsdk.content.requests

Class BoxRequestUpload<E extends BoxJsonObject,R extends BoxRequest<E,R>>

java.lang.Object

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

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

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

Type Parameters:

E - type of BoxJsonObject to be returned in the response.

R - type of BoxRequest being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsFile.UploadFile, BoxRequestsFile.UploadNewVersion

public abstract class BoxRequestUpload<E extends BoxJsonObject,R extends BoxRequest<E,R>>
extends BoxRequestItem<E,R>

Abstract class representing a request to upload a file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

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

Field Summary

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

mId, QUERY_FIELDS

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
BoxRequestUpload(java.lang.Class<E> clazz, java.io.InputStream fileInputStream, java.lang.String requestUrl, BoxSession session) Creates an upload request from an InputStream with the default parameters.

Method Summary

Modifier and Type	Method and Description
protected com.box.androidsdk.content.requests.BoxHttpRequest	createHttpRequest()
protected com.box.androidsdk.content.requests.BoxRequestMultipart	createMultipartRequest()
java.util.Date	getCreatedDate() Returns the content created date currently set in the request.
java.io.File	getFile() Returns the file to upload.
protected java.io.InputStream	getInputStream()
java.util.Date	getModifiedDate() Returns the content modified date currently set in the request.
java.lang.String	getSha1() Returns the sha1 currently set in the request.
long	getUploadSize() Returns the size of the upload.
protected BoxHttpResponse	sendRequest(com.box.androidsdk.content.requests.BoxHttpRequest request, java.net.HttpURLConnection connection)
R	setCreatedDate(java.util.Date mCreatedDate) Sets the content created date in the request.
protected void	setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)
R	setModifiedDate(java.util.Date mModifiedDate) Sets the content modified date in the request.
R	setProgressListener(ProgressListener listener) Sets the progress listener for the upload request.
void	setSha1(java.lang.String sha1) Sets the sha1 in the request.
R	setUploadSize(long mUploadSize) Sets the upload size in the request.

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

getId, onSendCompleted, setFields

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxRequestUpload

public BoxRequestUpload(java.lang.Class<E> clazz,
                        java.io.InputStream fileInputStream,
                        java.lang.String requestUrl,
                        BoxSession session)

Creates an upload request from an InputStream with the default parameters.

Parameters:

clazz - class of the object returned in the response.

fileInputStream - file input stream to upload.

requestUrl - URL for the upload endpoint.

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

Method Detail

setHeaders

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

Overrides:

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

getInputStream

protected java.io.InputStream getInputStream()
                                      throws java.io.FileNotFoundException

Returns:

a stream in which to get the contents to upload from. This may have been directly set or will create a stream from the file specified.

Throws:

java.io.FileNotFoundException - thrown if a file was specified, but is not found.

createMultipartRequest

protected com.box.androidsdk.content.requests.BoxRequestMultipart createMultipartRequest()
                                                                                  throws java.io.IOException,
                                                                                         BoxException

Throws:

java.io.IOException

BoxException

createHttpRequest

protected com.box.androidsdk.content.requests.BoxHttpRequest createHttpRequest()
                                                                        throws java.io.IOException,
                                                                               BoxException

Overrides:

createHttpRequest in class BoxRequest<E extends BoxJsonObject,R extends BoxRequest<E,R>>

Throws:

java.io.IOException

BoxException

sendRequest

protected BoxHttpResponse sendRequest(com.box.androidsdk.content.requests.BoxHttpRequest request,
                                      java.net.HttpURLConnection connection)
                               throws java.io.IOException,
                                      BoxException

Overrides:

sendRequest in class BoxRequest<E extends BoxJsonObject,R extends BoxRequest<E,R>>

Throws:

java.io.IOException

BoxException

setProgressListener

public R setProgressListener(ProgressListener listener)

Sets the progress listener for the upload request.

Parameters:

listener - progress listener for the request.

Returns:

request with the updated progress listener.

getUploadSize

public long getUploadSize()

Returns the size of the upload.

Returns:

the size of the upload in bytes.

setUploadSize

public R setUploadSize(long mUploadSize)

Sets the upload size in the request.

Parameters:

mUploadSize - size of the upload in bytes.

Returns:

request with the updated size.

getModifiedDate

public java.util.Date getModifiedDate()

Returns the content modified date currently set in the request.

Returns:

the content modified date currently set in the request, or null if not set.

setModifiedDate

public R setModifiedDate(java.util.Date mModifiedDate)

Sets the content modified date in the request.

Parameters:

mModifiedDate - date to set as the content modified date.

Returns:

request with the updated content modified date.

getCreatedDate

public java.util.Date getCreatedDate()

Returns the content created date currently set in the request.

Returns:

the content created date currently set in the request, or null if not set.

setCreatedDate

public R setCreatedDate(java.util.Date mCreatedDate)

Sets the content created date in the request.

Parameters:

mCreatedDate - date to set as the content created date in the request.

Returns:

request with the updated content created date.

getSha1

public java.lang.String getSha1()

Returns the sha1 currently set in the request.

Returns:

sha1 currently set in the request, or null if not set.

setSha1

public void setSha1(java.lang.String sha1)

Sets the sha1 in the request.

Parameters:

sha1 - sha1 to set in the request.

getFile

public java.io.File getFile()

Returns the file to upload.

Returns:

file to upload.