com.box.androidsdk.content.requests

Class BoxRequestsFile.UploadSessionPart

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxUploadSessionPart,BoxRequestsFile.UploadSessionPart>

com.box.androidsdk.content.requests.BoxRequestsFile.UploadSessionPart

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.UploadSessionPart
extends BoxRequest<BoxUploadSessionPart,BoxRequestsFile.UploadSessionPart>

Request for uploading a session part

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

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
UploadSessionPart(java.io.File file, BoxUploadSession uploadSession, int partNumber, BoxSession session) Creates an Object to upload one specific multiput part of a file
UploadSessionPart(java.io.InputStream is, long fileSize, BoxUploadSession uploadSession, int partNumber, BoxSession session) Creates an Object to upload one specific multiput part of a file

Method Summary

Modifier and Type	Method and Description
protected void	createHeaderMap()
protected java.io.InputStream	getInputStream()
long	getPartSize() Returns the multiput part size to be uploaded
BoxRequestsFile.UploadSessionPart	setAlreadyPositioned(boolean alreadyPositioned) Set to true only if the file or input stream used in the constructor starts at the beginning of this part.
protected void	setBody(com.box.androidsdk.content.requests.BoxHttpRequest request)
BoxRequestsFile.UploadSessionPart	setProgressListener(ProgressListener listener) Sets the progress listener for the upload request.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadSessionPart

public UploadSessionPart(java.io.File file,
                         BoxUploadSession uploadSession,
                         int partNumber,
                         BoxSession session)
                  throws java.io.IOException

Creates an Object to upload one specific multiput part of a file

Parameters:

file - Creates an upload file session part with the default parameters

uploadSession - The uploadSession object

partNumber - the part number from the file

session - The BoxSession object

Throws:

java.io.IOException

UploadSessionPart

public UploadSessionPart(java.io.InputStream is,
                         long fileSize,
                         BoxUploadSession uploadSession,
                         int partNumber,
                         BoxSession session)
                  throws java.io.IOException

Creates an Object to upload one specific multiput part of a file

Parameters:

is - the InputStream from where this object will read the file

fileSize - the InputStream length to be read

uploadSession - the Upload session object

partNumber - the part number from the file/InputStream

session - The BoxSession object

Throws:

java.io.IOException

Method Detail

getInputStream

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

Throws:

java.io.FileNotFoundException

createHeaderMap

protected void createHeaderMap()

Overrides:

createHeaderMap in class BoxRequest<BoxUploadSessionPart,BoxRequestsFile.UploadSessionPart>

setBody

protected void setBody(com.box.androidsdk.content.requests.BoxHttpRequest request)
                throws java.io.IOException

Overrides:

setBody in class BoxRequest<BoxUploadSessionPart,BoxRequestsFile.UploadSessionPart>

Throws:

java.io.IOException

setProgressListener

public BoxRequestsFile.UploadSessionPart 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.

setAlreadyPositioned

public BoxRequestsFile.UploadSessionPart setAlreadyPositioned(boolean alreadyPositioned)

Set to true only if the file or input stream used in the constructor starts at the beginning of this part. Default is false, in which case the parameter is assumed to represent the entire file.

Parameters:

alreadyPositioned - true to reuse the input stream.

Returns:

request which will not try to skip to a new place in the position.

getPartSize

public long getPartSize()

Returns the multiput part size to be uploaded

Returns:

the part size