com.box.boxjavalibv2.resourcemanagers

Interface IBoxFilesManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxFilesManagerImpl

public interface IBoxFilesManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxFile	copyFile(String fileId, BoxItemCopyRequestObject requestObject) Copy a file.
BoxFile	createSharedLink(String fileId, BoxSharedLinkRequestObject requestObject) Create a shared link for a file, given the id of the file/folder.
void	deleteFile(String fileId, BoxDefaultRequestObject requestObject) Delete a 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) Deprecated.
BoxFile	getFile(String fileId, BoxDefaultRequestObject requestObject) Get file given a file id.
BoxCollection	getFileComments(String fileId, BoxDefaultRequestObject requestObject) Get comments on a file.
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.
BoxThumbnail	getThumbnail(String fileId, String extension, BoxImageRequestObject requestObject) Get thumbnail of a 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.

Method Detail

getFile

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteFile

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

Delete a file.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getPreview

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

downloadThumbnail

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

Deprecated.

Get thumbnail of a file. Deprecated, use getThumbnail instead.s

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

getThumbnail

BoxThumbnail getThumbnail(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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

uploadFile

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

Upload file/files.

Parameters:

requestObject - reqeust object

Returns:

newly created box file object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

InterruptedException

copyFile

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

Copy a file.

Parameters:

fileId - id of the file

requestObject - request object

Returns:

copied file

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

downloadFile

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

IllegalStateException - IllegalStateException

IOException - IOException

InterruptedException - InterruptedException

downloadFile

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

downloadFile

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

IOException - exception

InterruptedException - exception

uploadNewVersion

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

Upload a new version of a file.

Parameters:

fileId - id of the file

requestObject - requestObject

Returns:

a FileVersion object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

InterruptedException

getFileVersions

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateFileInfo

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createSharedLink

BoxFile createSharedLink(String fileId,
                       BoxSharedLinkRequestObject 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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getFileComments

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 - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.