com.box.sdk

Class BoxFileUploadSession

Object

BoxResource

BoxFileUploadSession

@BoxResourceType(value="upload_session")
public class BoxFileUploadSession
extends BoxResource

This API provides a way to reliably upload larger files to Box by chunking them into a sequence of parts. When using this APIinstead of the single file upload API, a request failure means a client only needs to retry upload of a single part instead of the entire file. Parts can also be uploaded in parallel allowing for potential performance improvement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxFileUploadSession.Endpoints Represents the end points specific to an upload session.
class	BoxFileUploadSession.Info Model contains the upload session information.

Method Summary

Modifier and Type	Method and Description
void	abort() Abort an upload session, discarding any chunks that were uploaded to it.
BoxFile.Info	commit(String digest, List<BoxFileUploadSessionPart> parts, Map<String,String> attributes, String ifMatch, String ifNoneMatch) Commit an upload session after all parts have been uploaded, creating the new file or the version.
BoxFileUploadSession.Info	getStatus() Get the status of the upload session.
protected Iterable<BoxFileUploadSessionPart>	listParts() Returns a list of all parts that have been uploaded to an upload session.
BoxFileUploadSessionPartList	listParts(int offset, int limit) Returns a list of all parts that have been uploaded to an upload session.
BoxFileUploadSessionPart	uploadPart(byte[] data, long offset, int partSize, long totalSizeOfFile) Uploads bytes to an open upload session.
BoxFileUploadSessionPart	uploadPart(InputStream stream, long offset, int partSize, long totalSizeOfFile) Uploads chunk of a stream to an open upload session.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Method Detail

uploadPart

public BoxFileUploadSessionPart uploadPart(InputStream stream,
                                           long offset,
                                           int partSize,
                                           long totalSizeOfFile)

Uploads chunk of a stream to an open upload session.

Parameters:

stream - the stream that is used to read the chunck using the offset and part size.

offset - the byte position where the chunk begins in the file.

partSize - the part size returned as part of the upload session instance creation. Only the last chunk can have a lesser value.

totalSizeOfFile - The total size of the file being uploaded.

Returns:

the part instance that contains the part id, offset and part size.

uploadPart

public BoxFileUploadSessionPart uploadPart(byte[] data,
                                           long offset,
                                           int partSize,
                                           long totalSizeOfFile)

Uploads bytes to an open upload session.

Parameters:

data - data

offset - the byte position where the chunk begins in the file.

partSize - the part size returned as part of the upload session instance creation. Only the last chunk can have a lesser value.

totalSizeOfFile - The total size of the file being uploaded.

Returns:

the part instance that contains the part id, offset and part size.

listParts

public BoxFileUploadSessionPartList listParts(int offset,
                                              int limit)

Returns a list of all parts that have been uploaded to an upload session.

Parameters:

offset - paging marker for the list of parts.

limit - maximum number of parts to return.

Returns:

the list of parts.

listParts

protected Iterable<BoxFileUploadSessionPart> listParts()

Returns a list of all parts that have been uploaded to an upload session.

Returns:

the list of parts.

commit

public BoxFile.Info commit(String digest,
                           List<BoxFileUploadSessionPart> parts,
                           Map<String,String> attributes,
                           String ifMatch,
                           String ifNoneMatch)

Commit an upload session after all parts have been uploaded, creating the new file or the version.

Parameters:

digest - the base64-encoded SHA-1 hash of the file being uploaded.

parts - the list of uploaded parts to be committed.

attributes - the key value pairs of attributes from the file instance.

ifMatch - ensures that your app only alters files/folders on Box if you have the current version.

ifNoneMatch - ensure that it retrieve unnecessary data if the most current version of file is on-hand.

Returns:

the created file instance.

getStatus

public BoxFileUploadSession.Info getStatus()

Get the status of the upload session. It contains the number of parts that are processed so far, the total number of parts required for the commit and expiration date and time of the upload session.

Returns:

the status.

abort

public void abort()

Abort an upload session, discarding any chunks that were uploaded to it.