com.box.boxjavalibv2.resourcemanagers

Class BoxItemsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManagerImpl

All Implemented Interfaces:

IBoxItemsManager, IBoxResourceManager

Direct Known Subclasses:

BoxFilesManagerImpl, BoxFoldersManageImpl, BoxSearchManagerImpl

public class BoxItemsManagerImpl
extends AbstractBoxResourceManager
implements IBoxItemsManager

Use this class to execute requests synchronously against the Box REST API(V2). Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BoxItem	copyItem(String id, BoxItemCopyRequestObject requestObject, BoxResourceType type) Copy an item.
BoxItem	createSharedLink(String id, BoxSharedLinkRequestObject requestObject, BoxResourceType type) Create a shared link for an item, given the id .
BoxItem	getItem(String id, BoxDefaultRequestObject requestObject, BoxResourceType type) Get item given an item id.
BoxItem	updateItemInfo(String id, BoxItemRequestObject requestObject, BoxResourceType type) Update info for an item

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

BoxItemsManagerImpl

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

Constructor.

Parameters:

config - BoxConfig

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getItem

public BoxItem getItem(String id,
              BoxDefaultRequestObject requestObject,
              BoxResourceType type)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Description copied from interface: IBoxItemsManager

Get item given an item id.

Specified by:

getItem in interface IBoxItemsManager

Parameters:

id - id of the item

requestObject - requestObject

type - resource type

Returns:

requested box file/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.

copyItem

public BoxItem copyItem(String id,
               BoxItemCopyRequestObject requestObject,
               BoxResourceType type)
                 throws BoxRestException,
                        BoxServerException,
                        AuthFatalFailureException

Description copied from interface: IBoxItemsManager

Copy an item.

Specified by:

copyItem in interface IBoxItemsManager

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

copied file/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.

updateItemInfo

public BoxItem updateItemInfo(String id,
                     BoxItemRequestObject requestObject,
                     BoxResourceType type)
                       throws UnsupportedEncodingException,
                              BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Description copied from interface: IBoxItemsManager

Update info for an item

Specified by:

updateItemInfo in interface IBoxItemsManager

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

updated file/folder

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

public BoxItem createSharedLink(String id,
                       BoxSharedLinkRequestObject requestObject,
                       BoxResourceType type)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Description copied from interface: IBoxItemsManager

Create a shared link for an item, given the id .

Specified by:

createSharedLink in interface IBoxItemsManager

Parameters:

id - id of the item

requestObject - request object

type - resource type of this item

Returns:

the file/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.