com.box.boxjavalibv2.resourcemanagers

Class BoxFoldersManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManager

com.box.boxjavalibv2.resourcemanagers.BoxFoldersManager

public class BoxFoldersManager
extends BoxItemsManager

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BoxFolder	copyFolder(String folderId, BoxFolderRequestObject requestObject) Copy a folder.
BoxFolder	createFolder(BoxFolderRequestObject requestObject) Create a folder.
BoxFolder	createSharedLink(String folderId, BoxFolderRequestObject requestObject) Create a shared link for a folder, given the id of the file/folder.
void	deleteFolder(String folderId, BoxFolderRequestObject requestObject) Delete a folder.
void	deleteTrashFolder(String id, BoxFileRequestObject requestObject) Permanently delete a trashed folder.
BoxFolder	getFolder(String folderId, BoxDefaultRequestObject requestObject) Get folder given a folder id.
List<BoxCollaboration>	getFolderCollaborations(String folderId, BoxDefaultRequestObject requestObject) Get collaborations of a folder.
BoxCollection	getFolderItems(String folderId, BoxFolderRequestObject requestObject) Get the items(subfolders, files, weblinks...) under a folder.
static List<BoxFolder>	getFolders(BoxCollection collection) Get folders in a collection.
BoxCollection	getFolderTrashItems(String folderId, BoxFolderRequestObject requestObject) Get the trashed items(subfolders, files, weblinks...) under a folder.
BoxFolder	getTrashFolder(String folderId, BoxDefaultRequestObject requestObject) Get trash folder given a folder id.
BoxFolder	restoreTrashFolder(String id, BoxItemRestoreRequestObject requestObject) Restore a trashed folder.
BoxFolder	updateFolderInfo(String folderId, BoxFolderRequestObject requestObject) Update info for a folder.

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

BoxFoldersManager

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

Constructor.

Parameters:

config - Config

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getFolder

public BoxFolder getFolder(String folderId,
                  BoxDefaultRequestObject requestObject)
                    throws BoxRestException,
                           BoxServerException,
                           AuthFatalFailureException

Get folder given a folder id.

Parameters:

folderId - id of the folder

requestObject - object that goes into request.

Returns:

requested box folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getTrashFolder

public BoxFolder getTrashFolder(String folderId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Get trash folder given a folder id.

Parameters:

folderId - id of the folder

requestObject - object that goes into request.

Returns:

requested box folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

createFolder

public BoxFolder createFolder(BoxFolderRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Create a folder.

Parameters:

requestObject - request object

Returns:

created folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteFolder

public void deleteFolder(String folderId,
                BoxFolderRequestObject requestObject)
                  throws BoxRestException,
                         BoxServerException,
                         AuthFatalFailureException

Delete a folder.

Parameters:

folderId - id of the folder

requestObject - request object

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

deleteTrashFolder

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

Permanently delete a trashed folder.

Parameters:

id - id of the folder

requestObject - request object

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

restoreTrashFolder

public BoxFolder restoreTrashFolder(String id,
                           BoxItemRestoreRequestObject requestObject)
                             throws BoxRestException,
                                    AuthFatalFailureException,
                                    BoxServerException

Restore a trashed folder.

Parameters:

id - id of the trashed folder.

requestObject -

Returns:

the folder

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

copyFolder

public BoxFolder copyFolder(String folderId,
                   BoxFolderRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Copy a folder.

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

copied folder

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

getFolderItems

public BoxCollection getFolderItems(String folderId,
                           BoxFolderRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Get the items(subfolders, files, weblinks...) under a folder. By default, returning maximum of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_LIMIT items, at an offset of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_OFFSET

Parameters:

folderId - id of the folder.

requestObject - request object

Returns:

Items(subfolders, files, weblinks...) under the folder.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getFolderTrashItems

public BoxCollection getFolderTrashItems(String folderId,
                                BoxFolderRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Get the trashed items(subfolders, files, weblinks...) under a folder. By default, returning maximum of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_LIMIT items, at an offset of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_OFFSET

Parameters:

folderId - id of the folder.

requestObject - request object

Returns:

Items(subfolders, files, weblinks...) under the folder.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

updateFolderInfo

public BoxFolder updateFolderInfo(String folderId,
                         BoxFolderRequestObject requestObject)
                           throws UnsupportedEncodingException,
                                  BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Update info for a folder.

Parameters:

fileFolderId - id of the folder

requestObject - request object

Returns:

updated folder

Throws:

UnsupportedEncodingException - exception

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

createSharedLink

public BoxFolder createSharedLink(String folderId,
                         BoxFolderRequestObject requestObject)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

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

Parameters:

fileFolderId - id of the folder

isFolder - whether this is a folder.

perm - SharedLinkPermissions

access - SharedLinkAccess, String can be the strings defined in BoxSharedLinkAccess.

unsharedAt - the time the created shared link expires.

Returns:

the file/folder, with shared link related fields filled in.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getFolderCollaborations

public List<BoxCollaboration> getFolderCollaborations(String folderId,
                                             BoxDefaultRequestObject requestObject)
                                               throws BoxRestException,
                                                      BoxServerException,
                                                      AuthFatalFailureException

Get collaborations of a folder.

Parameters:

folderId - id of the folder

Returns:

collaborations

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getFolders

public static List<BoxFolder> getFolders(BoxCollection collection)

Get folders in a collection.

Parameters:

collection - collection

Returns:

list of folders