com.box.sdkgen.managers.chunkeduploads

Class ChunkedUploadsManager

Object

ChunkedUploadsManager

public class ChunkedUploadsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChunkedUploadsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	ChunkedUploadsManager()
protected	ChunkedUploadsManager(ChunkedUploadsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
UploadSession	createFileUploadSession(CreateFileUploadSessionRequestBody requestBody) Creates an upload session for a new file.
UploadSession	createFileUploadSession(CreateFileUploadSessionRequestBody requestBody, CreateFileUploadSessionHeaders headers) Creates an upload session for a new file.
Files	createFileUploadSessionCommit(String uploadSessionId, CreateFileUploadSessionCommitRequestBody requestBody, CreateFileUploadSessionCommitHeaders headers) Close an upload session and create a file from the uploaded chunks.
Files	createFileUploadSessionCommitByUrl(String url, CreateFileUploadSessionCommitByUrlRequestBody requestBody, CreateFileUploadSessionCommitByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over CreateFileUploadSessionCommit method.
UploadSession	createFileUploadSessionForExistingFile(String fileId, CreateFileUploadSessionForExistingFileRequestBody requestBody) Creates an upload session for an existing file.
UploadSession	createFileUploadSessionForExistingFile(String fileId, CreateFileUploadSessionForExistingFileRequestBody requestBody, CreateFileUploadSessionForExistingFileHeaders headers) Creates an upload session for an existing file.
void	deleteFileUploadSessionById(String uploadSessionId) Abort an upload session and discard all data uploaded.
void	deleteFileUploadSessionById(String uploadSessionId, DeleteFileUploadSessionByIdHeaders headers) Abort an upload session and discard all data uploaded.
void	deleteFileUploadSessionByUrl(String url) Using this method with urls provided in response when creating a new upload session is preferred to use over DeleteFileUploadSessionById method.
void	deleteFileUploadSessionByUrl(String url, DeleteFileUploadSessionByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over DeleteFileUploadSessionById method.
Authentication	getAuth()
UploadSession	getFileUploadSessionById(String uploadSessionId) Return information about an upload session.
UploadSession	getFileUploadSessionById(String uploadSessionId, GetFileUploadSessionByIdHeaders headers) Return information about an upload session.
UploadSession	getFileUploadSessionByUrl(String url) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionById method.
UploadSession	getFileUploadSessionByUrl(String url, GetFileUploadSessionByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionById method.
UploadParts	getFileUploadSessionParts(String uploadSessionId) Return a list of the chunks uploaded to the upload session so far.
UploadParts	getFileUploadSessionParts(String uploadSessionId, GetFileUploadSessionPartsHeaders headers) Return a list of the chunks uploaded to the upload session so far.
UploadParts	getFileUploadSessionParts(String uploadSessionId, GetFileUploadSessionPartsQueryParams queryParams) Return a list of the chunks uploaded to the upload session so far.
UploadParts	getFileUploadSessionParts(String uploadSessionId, GetFileUploadSessionPartsQueryParams queryParams, GetFileUploadSessionPartsHeaders headers) Return a list of the chunks uploaded to the upload session so far.
UploadParts	getFileUploadSessionPartsByUrl(String url) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method.
UploadParts	getFileUploadSessionPartsByUrl(String url, GetFileUploadSessionPartsByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method.
UploadParts	getFileUploadSessionPartsByUrl(String url, GetFileUploadSessionPartsByUrlQueryParams queryParams) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method.
UploadParts	getFileUploadSessionPartsByUrl(String url, GetFileUploadSessionPartsByUrlQueryParams queryParams, GetFileUploadSessionPartsByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method.
NetworkSession	getNetworkSession()
PartAccumulator	reducer(PartAccumulator acc, InputStream chunk)
FileFull	uploadBigFile(InputStream file, String fileName, long fileSize, String parentFolderId) Starts the process of chunk uploading a big file.
UploadedPart	uploadFilePart(String uploadSessionId, InputStream requestBody, UploadFilePartHeaders headers) Uploads a chunk of a file for an upload session.
UploadedPart	uploadFilePartByUrl(String url, InputStream requestBody, UploadFilePartByUrlHeaders headers) Using this method with urls provided in response when creating a new upload session is preferred to use over UploadFilePart method.

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

ChunkedUploadsManager

public ChunkedUploadsManager()

ChunkedUploadsManager

protected ChunkedUploadsManager(ChunkedUploadsManager.Builder builder)

Method Detail

createFileUploadSession

public UploadSession createFileUploadSession(CreateFileUploadSessionRequestBody requestBody)

Creates an upload session for a new file.

Parameters:

requestBody - Request body of createFileUploadSession method

createFileUploadSession

public UploadSession createFileUploadSession(CreateFileUploadSessionRequestBody requestBody,
                                             CreateFileUploadSessionHeaders headers)

Creates an upload session for a new file.

Parameters:

requestBody - Request body of createFileUploadSession method

headers - Headers of createFileUploadSession method

createFileUploadSessionForExistingFile

public UploadSession createFileUploadSessionForExistingFile(String fileId,
                                                            CreateFileUploadSessionForExistingFileRequestBody requestBody)

Creates an upload session for an existing file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

requestBody - Request body of createFileUploadSessionForExistingFile method

createFileUploadSessionForExistingFile

public UploadSession createFileUploadSessionForExistingFile(String fileId,
                                                            CreateFileUploadSessionForExistingFileRequestBody requestBody,
                                                            CreateFileUploadSessionForExistingFileHeaders headers)

Creates an upload session for an existing file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

requestBody - Request body of createFileUploadSessionForExistingFile method

headers - Headers of createFileUploadSessionForExistingFile method

getFileUploadSessionByUrl

public UploadSession getFileUploadSessionByUrl(String url)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionById method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

Parameters:

url - URL of getFileUploadSessionById method

getFileUploadSessionByUrl

public UploadSession getFileUploadSessionByUrl(String url,
                                               GetFileUploadSessionByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionById method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

Parameters:

url - URL of getFileUploadSessionById method

headers - Headers of getFileUploadSessionById method

getFileUploadSessionById

public UploadSession getFileUploadSessionById(String uploadSessionId)

Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

getFileUploadSessionById

public UploadSession getFileUploadSessionById(String uploadSessionId,
                                              GetFileUploadSessionByIdHeaders headers)

Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

headers - Headers of getFileUploadSessionById method

uploadFilePartByUrl

public UploadedPart uploadFilePartByUrl(String url,
                                        InputStream requestBody,
                                        UploadFilePartByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over UploadFilePart method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of uploadFilePart method

requestBody - Request body of uploadFilePart method

headers - Headers of uploadFilePart method

uploadFilePart

public UploadedPart uploadFilePart(String uploadSessionId,
                                   InputStream requestBody,
                                   UploadFilePartHeaders headers)

Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

requestBody - Request body of uploadFilePart method

headers - Headers of uploadFilePart method

deleteFileUploadSessionByUrl

public void deleteFileUploadSessionByUrl(String url)

Using this method with urls provided in response when creating a new upload session is preferred to use over DeleteFileUploadSessionById method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of deleteFileUploadSessionById method

deleteFileUploadSessionByUrl

public void deleteFileUploadSessionByUrl(String url,
                                         DeleteFileUploadSessionByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over DeleteFileUploadSessionById method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of deleteFileUploadSessionById method

headers - Headers of deleteFileUploadSessionById method

deleteFileUploadSessionById

public void deleteFileUploadSessionById(String uploadSessionId)

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

deleteFileUploadSessionById

public void deleteFileUploadSessionById(String uploadSessionId,
                                        DeleteFileUploadSessionByIdHeaders headers)

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

headers - Headers of deleteFileUploadSessionById method

getFileUploadSessionPartsByUrl

public UploadParts getFileUploadSessionPartsByUrl(String url)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of getFileUploadSessionParts method

getFileUploadSessionPartsByUrl

public UploadParts getFileUploadSessionPartsByUrl(String url,
                                                  GetFileUploadSessionPartsByUrlQueryParams queryParams)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of getFileUploadSessionParts method

queryParams - Query parameters of getFileUploadSessionParts method

getFileUploadSessionPartsByUrl

public UploadParts getFileUploadSessionPartsByUrl(String url,
                                                  GetFileUploadSessionPartsByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of getFileUploadSessionParts method

headers - Headers of getFileUploadSessionParts method

getFileUploadSessionPartsByUrl

public UploadParts getFileUploadSessionPartsByUrl(String url,
                                                  GetFileUploadSessionPartsByUrlQueryParams queryParams,
                                                  GetFileUploadSessionPartsByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over GetFileUploadSessionParts method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of getFileUploadSessionParts method

queryParams - Query parameters of getFileUploadSessionParts method

headers - Headers of getFileUploadSessionParts method

getFileUploadSessionParts

public UploadParts getFileUploadSessionParts(String uploadSessionId)

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

getFileUploadSessionParts

public UploadParts getFileUploadSessionParts(String uploadSessionId,
                                             GetFileUploadSessionPartsQueryParams queryParams)

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

queryParams - Query parameters of getFileUploadSessionParts method

getFileUploadSessionParts

public UploadParts getFileUploadSessionParts(String uploadSessionId,
                                             GetFileUploadSessionPartsHeaders headers)

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

headers - Headers of getFileUploadSessionParts method

getFileUploadSessionParts

public UploadParts getFileUploadSessionParts(String uploadSessionId,
                                             GetFileUploadSessionPartsQueryParams queryParams,
                                             GetFileUploadSessionPartsHeaders headers)

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

queryParams - Query parameters of getFileUploadSessionParts method

headers - Headers of getFileUploadSessionParts method

createFileUploadSessionCommitByUrl

public Files createFileUploadSessionCommitByUrl(String url,
                                                CreateFileUploadSessionCommitByUrlRequestBody requestBody,
                                                CreateFileUploadSessionCommitByUrlHeaders headers)

Using this method with urls provided in response when creating a new upload session is preferred to use over CreateFileUploadSessionCommit method. This allows to always upload your content to the closest Box data center and can significantly improve upload speed. Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

url - URL of createFileUploadSessionCommit method

requestBody - Request body of createFileUploadSessionCommit method

headers - Headers of createFileUploadSessionCommit method

createFileUploadSessionCommit

public Files createFileUploadSessionCommit(String uploadSessionId,
                                           CreateFileUploadSessionCommitRequestBody requestBody,
                                           CreateFileUploadSessionCommitHeaders headers)

Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

Parameters:

uploadSessionId - The ID of the upload session. Example: "D5E3F7A"

requestBody - Request body of createFileUploadSessionCommit method

headers - Headers of createFileUploadSessionCommit method

reducer

public PartAccumulator reducer(PartAccumulator acc,
                               InputStream chunk)

uploadBigFile

public FileFull uploadBigFile(InputStream file,
                              String fileName,
                              long fileSize,
                              String parentFolderId)

Starts the process of chunk uploading a big file. Should return a File object representing uploaded file.

Parameters:

file - The stream of the file to upload.

fileName - The name of the file, which will be used for storage in Box.

fileSize - The total size of the file for the chunked upload in bytes.

parentFolderId - The ID of the folder where the file should be uploaded.

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()