com.box.boxjavalibv2.resourcemanagers

Class BoxFilesManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManagerImpl

com.box.boxjavalibv2.resourcemanagers.BoxFilesManagerImpl

All Implemented Interfaces:

IBoxFilesManager, IBoxItemsManager, IBoxResourceManager

public class BoxFilesManagerImpl
extends BoxItemsManagerImpl
implements IBoxFilesManager

Constructor Summary

Constructors

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

Method Summary

Methods

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

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

copyItem, createSharedLink, getItem, updateItemInfo

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

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

BoxFilesManagerImpl

public BoxFilesManagerImpl(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(java.lang.String fileId,
              BoxDefaultRequestObject requestObject)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Description copied from interface: IBoxFilesManager

Get file given a file id.

Specified by:

getFile in interface IBoxFilesManager

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

public void deleteFile(java.lang.String fileId,
              BoxDefaultRequestObject requestObject)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Description copied from interface: IBoxFilesManager

Delete a file.

Specified by:

deleteFile in interface IBoxFilesManager

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

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

Description copied from interface: IBoxFilesManager

Get preview of a file.

Specified by:

getPreview in interface IBoxFilesManager

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.

getThumbnail

public BoxThumbnail getThumbnail(java.lang.String fileId,
                        java.lang.String extension,
                        BoxImageRequestObject requestObject)
                          throws BoxRestException,
                                 BoxServerException,
                                 AuthFatalFailureException

Description copied from interface: IBoxFilesManager

Get thumbnail of a file.

Specified by:

getThumbnail in interface IBoxFilesManager

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.

downloadThumbnail

@Deprecated
public java.io.InputStream downloadThumbnail(java.lang.String fileId,
                                               java.lang.String extension,
                                               BoxImageRequestObject requestObject)
                                      throws BoxRestException,
                                             BoxServerException,
                                             AuthFatalFailureException

Deprecated.

Description copied from interface: IBoxFilesManager

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

Specified by:

downloadThumbnail in interface IBoxFilesManager

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

uploadFile

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

Description copied from interface: IBoxFilesManager

Upload file/files.

Specified by:

uploadFile in interface IBoxFilesManager

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.

java.lang.InterruptedException

copyFile

public BoxFile copyFile(java.lang.String fileId,
               BoxItemCopyRequestObject requestObject)
                 throws BoxRestException,
                        BoxServerException,
                        AuthFatalFailureException

Description copied from interface: IBoxFilesManager

Copy a file.

Specified by:

copyFile in interface IBoxFilesManager

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

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

Description copied from interface: IBoxFilesManager

Download a file.

Specified by:

downloadFile in interface IBoxFilesManager

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.

java.lang.IllegalStateException - IllegalStateException

java.io.IOException - IOException

java.lang.InterruptedException - InterruptedException

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

downloadFile

public java.io.InputStream downloadFile(java.lang.String fileId,
                               BoxDefaultRequestObject requestObject)
                                 throws BoxRestException,
                                        BoxServerException,
                                        AuthFatalFailureException

Description copied from interface: IBoxFilesManager

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.

Specified by:

downloadFile in interface IBoxFilesManager

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

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

Description copied from interface: IBoxFilesManager

Download a file.

Specified by:

downloadFile in interface IBoxFilesManager

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.

java.io.IOException - exception

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

java.lang.InterruptedException - exception

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

uploadNewVersion

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

Description copied from interface: IBoxFilesManager

Upload a new version of a file.

Specified by:

uploadNewVersion in interface IBoxFilesManager

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.

java.lang.InterruptedException

getFileVersions

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

Description copied from interface: IBoxFilesManager

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

Specified by:

getFileVersions in interface IBoxFilesManager

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

public BoxFile updateFileInfo(java.lang.String fileId,
                     BoxFileRequestObject requestObject)
                       throws java.io.UnsupportedEncodingException,
                              BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Description copied from interface: IBoxFilesManager

Update info for a file.

Specified by:

updateFileInfo in interface IBoxFilesManager

Parameters:

fileId - id of the file

requestObject - request object

Returns:

updated file

Throws:

java.io.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

public BoxFile createSharedLink(java.lang.String fileId,
                       BoxSharedLinkRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Description copied from interface: IBoxFilesManager

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

Specified by:

createSharedLink in interface IBoxFilesManager

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

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

Description copied from interface: IBoxFilesManager

Get comments on a file.

Specified by:

getFileComments in interface IBoxFilesManager

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.

getFiles

@Deprecated
public static java.util.List<BoxFile> getFiles(BoxCollection collection)

Deprecated.

Get files in a collection.Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

list of files

getFileVersions

@Deprecated
public static java.util.List<BoxFileVersion> getFileVersions(BoxCollection collection)

Deprecated.

Get file versions in a collection. Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

list of file versions