com.box.sdk

Class LargeFileUpload

Object

LargeFileUpload

public final class LargeFileUpload
extends Object

Utility class for uploading large files.

Constructor Summary

Constructors

Constructor and Description
LargeFileUpload() Creates a LargeFileUpload object with a default number of parallel conections and timeout.
LargeFileUpload(int nParallelConnections, long timeOut, TimeUnit unit) Creates a LargeFileUpload object.

Method Summary

Modifier and Type	Method and Description
String	generateDigest(InputStream stream) Generates the Base64 encoded SHA-1 hash for content available in the stream.
BoxFile.Info	upload(BoxAPIConnection boxApi, InputStream stream, URL url, long fileSize) Creates a new version of a large file.
BoxFile.Info	upload(BoxAPIConnection boxApi, InputStream stream, URL url, long fileSize, Map<String,String> fileAttributes) Creates a new version of a large file and sets file attributes.
BoxFile.Info	upload(BoxAPIConnection boxApi, String folderId, InputStream stream, URL url, String fileName, long fileSize) Uploads a new large file.
BoxFile.Info	upload(BoxAPIConnection boxApi, String folderId, InputStream stream, URL url, String fileName, long fileSize, Map<String,String> fileAttributes) Uploads a new large file and sets file attributes.

Methods inherited from class Object

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

Constructor Detail

LargeFileUpload

public LargeFileUpload(int nParallelConnections,
                       long timeOut,
                       TimeUnit unit)

Creates a LargeFileUpload object.

Parameters:

nParallelConnections - number of parallel http connections to use

timeOut - time to wait before killing the job

unit - time unit for the time wait value

LargeFileUpload

public LargeFileUpload()

Creates a LargeFileUpload object with a default number of parallel conections and timeout.

Method Detail

upload

public BoxFile.Info upload(BoxAPIConnection boxApi,
                           String folderId,
                           InputStream stream,
                           URL url,
                           String fileName,
                           long fileSize)
                    throws InterruptedException,
                           IOException

Uploads a new large file.

Parameters:

boxApi - the API connection to be used by the upload session.

folderId - the id of the folder in which the file will be uploaded.

stream - the input stream that feeds the content of the file.

url - the upload session URL.

fileName - the name of the file to be created.

fileSize - the total size of the file.

Returns:

the created file instance.

Throws:

InterruptedException - when a thread gets interupted.

IOException - when reading a stream throws exception.

upload

public BoxFile.Info upload(BoxAPIConnection boxApi,
                           String folderId,
                           InputStream stream,
                           URL url,
                           String fileName,
                           long fileSize,
                           Map<String,String> fileAttributes)
                    throws InterruptedException,
                           IOException

Uploads a new large file and sets file attributes.

Parameters:

boxApi - the API connection to be used by the upload session.

folderId - the id of the folder in which the file will be uploaded.

stream - the input stream that feeds the content of the file.

url - the upload session URL.

fileName - the name of the file to be created.

fileSize - the total size of the file.

fileAttributes - file attributes to set

Returns:

the created file instance.

Throws:

InterruptedException - when a thread gets interupted.

IOException - when reading a stream throws exception.

upload

public BoxFile.Info upload(BoxAPIConnection boxApi,
                           InputStream stream,
                           URL url,
                           long fileSize)
                    throws InterruptedException,
                           IOException

Creates a new version of a large file.

Parameters:

boxApi - the API connection to be used by the upload session.

stream - the input stream that feeds the content of the file.

url - the upload session URL.

fileSize - the total size of the file.

Returns:

the file instance that also contains the version information.

Throws:

InterruptedException - when a thread gets interupted.

IOException - when reading a stream throws exception.

upload

public BoxFile.Info upload(BoxAPIConnection boxApi,
                           InputStream stream,
                           URL url,
                           long fileSize,
                           Map<String,String> fileAttributes)
                    throws InterruptedException,
                           IOException

Creates a new version of a large file and sets file attributes.

Parameters:

boxApi - the API connection to be used by the upload session.

stream - the input stream that feeds the content of the file.

url - the upload session URL.

fileSize - the total size of the file.

fileAttributes - file attributes to set.

Returns:

the file instance that also contains the version information.

Throws:

InterruptedException - when a thread gets interupted.

IOException - when reading a stream throws exception.

generateDigest

public String generateDigest(InputStream stream)

Generates the Base64 encoded SHA-1 hash for content available in the stream. It can be used to calculate the hash of a file.

Parameters:

stream - the input stream of the file or data.

Returns:

the Base64 encoded hash string.