com.box.boxjavalibv2.resourcemanagers

Class BoxFoldersManageImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManagerImpl

com.box.boxjavalibv2.resourcemanagers.BoxFoldersManageImpl

All Implemented Interfaces:

IBoxFoldersManager, IBoxItemsManager, IBoxResourceManager

public class BoxFoldersManageImpl
extends BoxItemsManagerImpl
implements IBoxFoldersManager

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BoxFolder	copyFolder(java.lang.String folderId, BoxItemCopyRequestObject requestObject) Copy a folder.
BoxFolder	createFolder(BoxFolderRequestObject requestObject) Create a folder.
BoxFolder	createSharedLink(java.lang.String folderId, BoxSharedLinkRequestObject requestObject) Create a shared link for a folder, given the id of the file/folder.
void	deleteFolder(java.lang.String folderId, BoxFolderDeleteRequestObject requestObject) Delete a folder.
BoxFolder	getFolder(java.lang.String folderId, BoxDefaultRequestObject requestObject) Get folder given a folder id.
java.util.List<BoxCollaboration>	getFolderCollaborations(java.lang.String folderId, BoxDefaultRequestObject requestObject) Get collaborations of a folder.
BoxCollection	getFolderItems(java.lang.String folderId, BoxPagingRequestObject requestObject) Get the items(subfolders, files, weblinks...) under a folder.
static java.util.List<BoxFolder>	getFolders(BoxCollection collection) Deprecated.
BoxFolder	updateFolderInfo(java.lang.String folderId, BoxFolderRequestObject requestObject) Update info for a folder.

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

BoxFoldersManageImpl

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

Description copied from interface: IBoxFoldersManager

Get folder given a folder id.

Specified by:

getFolder in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

requestObject - object that goes into request.

Returns:

requested box folder

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.

createFolder

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

Description copied from interface: IBoxFoldersManager

Create a folder.

Specified by:

createFolder in interface IBoxFoldersManager

Parameters:

requestObject - request object

Returns:

created folder

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.

deleteFolder

public void deleteFolder(java.lang.String folderId,
                BoxFolderDeleteRequestObject requestObject)
                  throws BoxRestException,
                         BoxServerException,
                         AuthFatalFailureException

Description copied from interface: IBoxFoldersManager

Delete a folder.

Specified by:

deleteFolder in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

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.

copyFolder

public BoxFolder copyFolder(java.lang.String folderId,
                   BoxItemCopyRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Description copied from interface: IBoxFoldersManager

Copy a folder.

Specified by:

copyFolder in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

copied folder

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.

getFolderItems

public BoxCollection getFolderItems(java.lang.String folderId,
                           BoxPagingRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Description copied from interface: IBoxFoldersManager

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

Specified by:

getFolderItems in interface IBoxFoldersManager

Parameters:

folderId - id of the folder.

requestObject - request object

Returns:

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

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.

updateFolderInfo

public BoxFolder updateFolderInfo(java.lang.String folderId,
                         BoxFolderRequestObject requestObject)
                           throws java.io.UnsupportedEncodingException,
                                  BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Description copied from interface: IBoxFoldersManager

Update info for a folder.

Specified by:

updateFolderInfo in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

updated folder

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 BoxFolder createSharedLink(java.lang.String folderId,
                         BoxSharedLinkRequestObject requestObject)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Description copied from interface: IBoxFoldersManager

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

Specified by:

createSharedLink in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

the folder, 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.

getFolderCollaborations

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

Description copied from interface: IBoxFoldersManager

Get collaborations of a folder.

Specified by:

getFolderCollaborations in interface IBoxFoldersManager

Parameters:

folderId - id of the folder

Returns:

collaborations

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.

getFolders

@Deprecated
public static java.util.List<BoxFolder> getFolders(BoxCollection collection)

Deprecated.

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

Parameters:

collection - collection

Returns:

list of folders