com.box.boxjavalibv2.resourcemanagers

Class BoxResourceManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

Direct Known Subclasses:

BoxCollaborationsManager, BoxCommentsManager, BoxEventsManager, BoxGroupsManager, BoxItemsManager, BoxOAuthManager, BoxSharedItemsManager, BoxUsersManager

public abstract class BoxResourceManager
extends Object

Base class for BoxAPI classes.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeRequestWithNoResponseBody(DefaultBoxRequest request) Execute a request and expect no response body.
IBoxRequestAuth	getAuth() Get auth.
protected Class	getClassFromType(IBoxType type)
IBoxConfig	getConfig() Get config.
IBoxJSONParser	getJSONParser()
IBoxResourceHub	getResourceHub()
Object	getResponseAndParse(DefaultBoxRequest request, IBoxType type, IBoxJSONParser parser) Make a rest api request, get response, and then parse the response.
Object	getResponseAndParseAndTryCast(DefaultBoxRequest request, IBoxType type, IBoxJSONParser parser) Make a rest api request, get response, parse the response, and try to cast parsed out object into expected object.
protected IBoxRESTClient	getRestClient()
protected Object	tryCastBoxItem(BoxResourceType type, Object item) Try to cast a box item into a concrete class(i.e.
Object	tryCastObject(IBoxType expectedType, Object obj) Try to cast an object into a specific class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxResourceManager

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

private constructor.

Parameters:

config - Config

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getAuth

public IBoxRequestAuth getAuth()

Get auth.

Returns:

auth

getRestClient

protected IBoxRESTClient getRestClient()

getResourceHub

public IBoxResourceHub getResourceHub()

Returns:

the IResourceHub

getJSONParser

public IBoxJSONParser getJSONParser()

getConfig

public IBoxConfig getConfig()

Get config.

executeRequestWithNoResponseBody

protected void executeRequestWithNoResponseBody(DefaultBoxRequest request)
                                         throws BoxServerException,
                                                BoxRestException,
                                                AuthFatalFailureException

Execute a request and expect no response body.

Parameters:

request - request

Throws:

BoxServerException - excepiton

BoxRestException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

getResponseAndParseAndTryCast

public Object getResponseAndParseAndTryCast(DefaultBoxRequest request,
                                   IBoxType type,
                                   IBoxJSONParser parser)
                                     throws BoxRestException,
                                            AuthFatalFailureException,
                                            BoxServerException

Make a rest api request, get response, parse the response, and try to cast parsed out object into expected object.

Parameters:

request - request

type - type

parser - json parser

Returns:

parsed object

Throws:

AuthFatalFailureException - exception

BoxRestException - exception

BoxServerException - exception

getResponseAndParse

public Object getResponseAndParse(DefaultBoxRequest request,
                         IBoxType type,
                         IBoxJSONParser parser)
                           throws BoxRestException,
                                  AuthFatalFailureException

Make a rest api request, get response, and then parse the response.

Parameters:

request - request

type - type

parser - ObjectMapper

Returns:

parsed object

Throws:

BoxRestException - exception

AuthFatalFailureException - exception indicating authenticating totally failed

tryCastObject

public Object tryCastObject(IBoxType expectedType,
                   Object obj)
                     throws BoxServerException,
                            BoxRestException

Try to cast an object into a specific class.

Parameters:

expectedType - expected resource type class

obj - object

Returns:

object

Throws:

BoxServerException - exception

BoxRestException - exception

getClassFromType

protected Class getClassFromType(IBoxType type)

tryCastBoxItem

protected Object tryCastBoxItem(BoxResourceType type,
                    Object item)
                         throws BoxServerException,
                                BoxRestException

Try to cast a box item into a concrete class(i.e. file or folder)

Parameters:

isFolder - whether it's folder

item - the box item.

Returns:

box items

Throws:

BoxServerException - exception

BoxRestException - exception