com.box.boxjavalibv2.resourcemanagers

Class BoxFilesManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManager

com.box.boxjavalibv2.resourcemanagers.BoxFilesManager

public class BoxFilesManager
extends BoxItemsManager

Constructor Summary

Constructors

Constructor and Description
BoxFilesManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxFile	copyFile(String fileId, BoxFileRequestObject requestObject) Copy a file.
BoxFile	createSharedLink(String fileId, BoxFileRequestObject requestObject) Create a shared link for a file, given the id of the file/folder.
void	deleteFile(String fileId, BoxFileRequestObject requestObject) Delete a file.
void	deleteTrashFile(String id, BoxFileRequestObject requestObject) Permanently delete a trashed file.
InputStream	downloadFile(String fileId, BoxDefaultRequestObject requestObject) Execute the download and return the raw InputStream.
void	downloadFile(String fileId, File destination, IFileTransferListener listener, BoxDefaultRequestObject requestObject) Download a file.
void	downloadFile(String fileId, OutputStream[] outputStreams, IFileTransferListener listener, BoxDefaultRequestObject requestObject) Download a file.
InputStream	downloadThumbnail(String fileId, String extension, BoxImageRequestObject requestObject) Get thumbnail of a file.
BoxFile	getFile(String fileId, BoxDefaultRequestObject requestObject) Get file given a file id.
BoxCollection	getFileComments(String fileId, BoxDefaultRequestObject requestObject) Get comments on a file.
static List<BoxFile>	getFiles(BoxCollection collection) Get files in a collection.
static List<BoxFileVersion>	getFileVersions(BoxCollection collection) Get file versions in a collection.
List<BoxFileVersion>	getFileVersions(String fileId, BoxDefaultRequestObject requestObject) Get file versions(Note: Versions are only tracked for Box users with premium accounts.).
BoxPreview	getPreview(String fileId, String extension, BoxImageRequestObject requestObject) Get preview of a file.
BoxFile	getTrashFile(String fileId, BoxDefaultRequestObject requestObject) Get trashed file given a file id.
BoxFile	restoreTrashFile(String id, BoxItemRestoreRequestObject requestObject) Restore a trashed file.
BoxFile	updateFileInfo(String fileId, BoxFileRequestObject requestObject) Update info for a file.
BoxFile	uploadFile(BoxFileUploadRequestObject requestObject) Upload file/files.
BoxFile	uploadNewVersion(String fileId, BoxFileUploadRequestObject requestObject) Upload a new version of a file.

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxItemsManager

copyItem, createSharedLink, deleteTrashItem, getItem, getTrashItem, restoreTrashItem, updateItemInfo

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxFilesManager

public BoxFilesManager(IBoxConfig config,
               IBoxResourceHub resourceHub,
               IBoxJSONParser parser,
               IBoxRequestAuth auth,
               IBoxRESTClient restClient)

Constructor.

Parameters:

config - BoxConfig

resourceHub - resource hub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getFile

public BoxFile getFile(String fileId,
              BoxDefaultRequestObject requestObject)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Get file given a file id.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Returns:

requested box file

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getTrashFile

public BoxFile getTrashFile(String fileId,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Get trashed file given a file id.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Returns:

requested box file

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteFile

public void deleteFile(String fileId,
              BoxFileRequestObject requestObject)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Delete a file.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteTrashFile

public void deleteTrashFile(String id,
                   BoxFileRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Permanently delete a trashed file.

Parameters:

id - id of the file

requestObject - request object

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

restoreTrashFile

public BoxFile restoreTrashFile(String id,
                       BoxItemRestoreRequestObject requestObject)
                         throws BoxRestException,
                                AuthFatalFailureException,
                                BoxServerException

Restore a trashed file.

Parameters:

id - id of the trashed file.

requestObject -

Returns:

the file

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

getPreview

public BoxPreview getPreview(String fileId,
                    String extension,
                    BoxImageRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Get preview of a file.

Parameters:

fileId - id of the file

extension - requested of the preview image file extension

requestObject - request object

Returns:

preview

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

downloadThumbnail

public InputStream downloadThumbnail(String fileId,
                            String extension,
                            BoxImageRequestObject requestObject)
                              throws BoxRestException,
                                     BoxServerException,
                                     AuthFatalFailureException

Get thumbnail of a file.

Parameters:

fileId - id of the file

extension - file extension of requested thumbnail

requestObject - request object

Returns:

InputStream

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

uploadFile

public BoxFile uploadFile(BoxFileUploadRequestObject requestObject)
                   throws BoxRestException,
                          BoxServerException,
                          AuthFatalFailureException,
                          InterruptedException

Upload file/files.

Parameters:

requestObject - reqeust object

Returns:

newly created box file object

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

InterruptedException

copyFile

public BoxFile copyFile(String fileId,
               BoxFileRequestObject requestObject)
                 throws BoxRestException,
                        BoxServerException,
                        AuthFatalFailureException

Copy a file.

Parameters:

fileId - id of the file

requestObject - request object

Returns:

copied file

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

downloadFile

public void downloadFile(String fileId,
                File destination,
                IFileTransferListener listener,
                BoxDefaultRequestObject requestObject)
                  throws BoxRestException,
                         BoxServerException,
                         IllegalStateException,
                         IOException,
                         InterruptedException,
                         AuthFatalFailureException

Download a file.

Parameters:

fileId - id of the file

destination - destination of the downloaded file

listener - listener to monitor the download progress

requestObject - extra request object going into api request

Throws:

BoxRestException - exception

BoxServerException - exception

IllegalStateException - exception

IOException - exception

InterruptedException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

downloadFile

public InputStream downloadFile(String fileId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Execute the download and return the raw InputStream. This method is not involved with download listeners and will not publish anything through download listeners. Instead caller handles the InputStream as she/he wishes.

Parameters:

fileId - id of the file to be downloaded

requestObject - request object

Returns:

InputStream

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

downloadFile

public void downloadFile(String fileId,
                OutputStream[] outputStreams,
                IFileTransferListener listener,
                BoxDefaultRequestObject requestObject)
                  throws BoxRestException,
                         IOException,
                         BoxServerException,
                         InterruptedException,
                         AuthFatalFailureException

Download a file.

Parameters:

fileId - id of the file

outputStreams - OutputStream's the file will be downloaded into

listener - listener to monitor the download progress

requestObject - request object

Throws:

BoxRestException - exception

BoxServerException - exception

IOException - exception

InterruptedException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

uploadNewVersion

public BoxFile uploadNewVersion(String fileId,
                       BoxFileUploadRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException,
                                InterruptedException

Upload a new version of a file.

Parameters:

fileId - id of the file

BoxFileUploadRequestObject - requestObject

Returns:

a FileVersion object

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

InterruptedException

getFileVersions

public List<BoxFileVersion> getFileVersions(String fileId,
                                   BoxDefaultRequestObject requestObject)
                                     throws BoxRestException,
                                            BoxServerException,
                                            AuthFatalFailureException

Get file versions(Note: Versions are only tracked for Box users with premium accounts.).

Parameters:

fileId - id of the file

requestObject - request object

Returns:

FileVersions

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

updateFileInfo

public BoxFile updateFileInfo(String fileId,
                     BoxFileRequestObject requestObject)
                       throws UnsupportedEncodingException,
                              BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Update info for a file.

Parameters:

fileId - id of the file

requestObject - request object

Returns:

updated file

Throws:

UnsupportedEncodingException - exception

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

createSharedLink

public BoxFile createSharedLink(String fileId,
                       BoxFileRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Create a shared link for a file, given the id of the file/folder.

Parameters:

fileId - id of the file

requestObject - request object

Returns:

the file, with shared link related fields filled in.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getFileComments

public BoxCollection getFileComments(String fileId,
                            BoxDefaultRequestObject requestObject)
                              throws BoxRestException,
                                     BoxServerException,
                                     AuthFatalFailureException

Get comments on a file.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Returns:

collection of comments

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getFiles

public static List<BoxFile> getFiles(BoxCollection collection)

Get files in a collection.

Parameters:

collection - collection

Returns:

list of files

getFileVersions

public static List<BoxFileVersion> getFileVersions(BoxCollection collection)

Get file versions in a collection.

Parameters:

collection - collection

Returns:

list of file versions