com.box.boxjavalibv2

Class BoxClient

java.lang.Object

com.box.boxjavalibv2.dao.BoxBase

com.box.boxjavalibv2.BoxClient

All Implemented Interfaces:

IAuthFlowListener

public class BoxClient
extends BoxBase
implements IAuthFlowListener

This is the main entrance of the sdk. The client contains all resource managers and also handles authentication. Make sure you call authenticate method before making any api calls. you can use the resource managers 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
BoxClient(String clientId, String clientSecret) Deprecated.
BoxClient(String clientId, String clientSecret, IBoxResourceHub hub, IBoxJSONParser parser)
BoxClient(String clientId, String clientSecret, IBoxResourceHub hub, IBoxJSONParser parser, int maxConnection, int maxConnectionPerRoute, long timePeriodCleanUpIdleConnection, long idleTimeThreshold) This constructor has some connection parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOAuthRefreshListener(OAuthRefreshListener listener)
void	authenticate(IAuthData authData) Get authenticated using a Auth object, this could be a previously stored data.
void	authenticate(IAuthFlowUI authFlowUI, boolean autoRefreshOAuth, IAuthFlowListener listener) Get authenticated.
void	authenticateFromSecureStorage(IAuthSecureStorage storage) Authenticate from the auth object stored in the secure storage.
IAuthDataController	createAuthDataController(String clientId, String clientSecret)
IBoxRequestAuth	createAuthorization(IAuthDataController controller)
protected IBoxJSONParser	createJSONParser(IBoxResourceHub resourceHub) Create a json parser.
protected IBoxRESTClient	createMonitoredRestClient(int maxConnection, int maxConnectionPerRoute, long timePeriodCleanUpIdleConnection, long idleTimeThreshold)
protected IBoxResourceHub	createResourceHub() Create a resource hub
protected IBoxRESTClient	createRestClient() Create a REST client to make api calls.
IBoxRequestAuth	getAuth() Get the auth object used to make api calls.
BoxOAuthToken	getAuthData() Get the OAuth data.
OAuthDataController.OAuthTokenState	getAuthState() Check authentication state.
BoxCollaborationsManager	getCollaborationsManager()
BoxCommentsManager	getCommentsManager()
IBoxConfig	getConfig() Get config.
BoxEventsManager	getEventsManager()
BoxFilesManager	getFilesManager() Get the BoxFilesManager, which can be used to make API calls on files endpoints.
BoxFoldersManager	getFoldersManager()
BoxGroupsManager	getGroupsManager() Get the BoxGroupsManager, which can be used to make API calls on groups endpoints.
IBoxJSONParser	getJSONParser()
OAuthDataController	getOAuthDataController() Get the OAuthDataController that controls OAuth data.
BoxOAuthManager	getOAuthManager() Get the OAuthManager, which can be used to make OAuth related api calls.
protected BoxOAuthToken	getOAuthTokenFromMessage(IAuthFlowMessage message)
BoxResourceManager	getPluginManager(String pluginManagerKey)
IBoxResourceHub	getResourceHub() Get resource hub.
BoxResourceManager	getResourceManagerWithSharedLinkAuth(BoxResourceType type, String sharedLink, String password) A generic way to get a resourceManager with shared link auth.
protected IBoxRESTClient	getRestClient() Get rest client.
BoxSearchManager	getSearchManager()
BoxCommentsManager	getSharedCommentsManager(String sharedLink, String password) Get the BoxCommentsManager for shared items, which can be used to make API calls on comments endpoints for a shared item.
BoxFilesManager	getSharedFilesManager(String sharedLink, String password) Get the BoxFilesManager for shared items, which can be used to make API calls on files endpoints for a shared item.
BoxFoldersManager	getSharedFoldersManager(String sharedLink, String password) Get the BoxFoldersManager for shared items, which can be used to make API calls on folders endpoints for a shared item.
IBoxRequestAuth	getSharedItemAuth(String sharedLink, String password) Get the authorization needed for shared items.
BoxSharedItemsManager	getSharedItemsManager(String sharedLink, String password) Get Shared Items manager, which can be used to make API calls on shared item endpoints.
BoxUsersManager	getUsersManager()
boolean	isAuthenticated() Whether this client is authenticated.
void	onAuthFlowEvent(IAuthEvent event, IAuthFlowMessage message) On an event.
void	onAuthFlowException(Exception e) On an exception.
void	onAuthFlowMessage(IAuthFlowMessage message) On a message.
BoxResourceManager	pluginResourceManager(String key, IPluginResourceManagerBuilder builder)
void	saveAuth(IAuthSecureStorage storage) Save auth in a customized secure storage.
void	setAutoRefreshOAuth(boolean autoRefresh) Makes OAuth auto refresh itself when token expires.
void	setConnectionOpen(boolean connectionOpen)
void	setConnectionTimeOut(int timeOut) Set connection time out.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxClient

public BoxClient(String clientId,
         String clientSecret,
         IBoxResourceHub hub,
         IBoxJSONParser parser,
         int maxConnection,
         int maxConnectionPerRoute,
         long timePeriodCleanUpIdleConnection,
         long idleTimeThreshold)

This constructor has some connection parameters. They are used to periodically close idle connections that HttpClient opens.

Parameters:

maxConnection - maximum connection. Recommend value: 1000

maxConnectionPerRoute - maximum connection allowed per route. Recommend value: 50

timePeriodCleanUpIdleConnection - clean up idle connection every such period of time. in miliseconds. Recommend value: 300000(5 minutes)

idleTimeThreshold - an idle connection will be closed if idled above this threshold of time. in miliseconds. Recommend value: 60000(1 minute)

BoxClient

public BoxClient(String clientId,
         String clientSecret,
         IBoxResourceHub hub,
         IBoxJSONParser parser)

Parameters:

clientId - client id

clientSecret - client secret

hub - resource hub, use null for default resource hub.

parser - json parser, use null for default parser.

BoxClient

@Deprecated
public BoxClient(String clientId,
                    String clientSecret)

Deprecated.

Method Detail

pluginResourceManager

public BoxResourceManager pluginResourceManager(String key,
                                       IPluginResourceManagerBuilder builder)

isAuthenticated

public boolean isAuthenticated()

Whether this client is authenticated.

Returns:

setAutoRefreshOAuth

public void setAutoRefreshOAuth(boolean autoRefresh)

Makes OAuth auto refresh itself when token expires. By default, this is set to true. Note if autorefresh fails, it's not going to try refresh again.

Parameters:

autoRefresh -

setConnectionOpen

public void setConnectionOpen(boolean connectionOpen)

setConnectionTimeOut

public void setConnectionTimeOut(int timeOut)

Set connection time out.

Parameters:

timeOut -

getOAuthDataController

public OAuthDataController getOAuthDataController()

Get the OAuthDataController that controls OAuth data.

addOAuthRefreshListener

public void addOAuthRefreshListener(OAuthRefreshListener listener)

getAuthData

public BoxOAuthToken getAuthData()
                          throws AuthFatalFailureException

Get the OAuth data.

Returns:

Throws:

AuthFatalFailureException

saveAuth

public void saveAuth(IAuthSecureStorage storage)
              throws AuthFatalFailureException

Save auth in a customized secure storage.

Parameters:

storage -

Throws:

AuthFatalFailureException

authenticateFromSecureStorage

public void authenticateFromSecureStorage(IAuthSecureStorage storage)

Authenticate from the auth object stored in the secure storage.

Parameters:

storage -

getFilesManager

public BoxFilesManager getFilesManager()

Get the BoxFilesManager, which can be used to make API calls on files endpoints. Note this files manager only work on the folders you own. if you are trying to make api calls on a shared file (file shared to you via shared link), please use getSharedFilesManager().

Returns:

the filesManager

getOAuthManager

public BoxOAuthManager getOAuthManager()

Get the OAuthManager, which can be used to make OAuth related api calls.

Returns:

getGroupsManager

public BoxGroupsManager getGroupsManager()

Get the BoxGroupsManager, which can be used to make API calls on groups endpoints.

getSharedItemsManager

public BoxSharedItemsManager getSharedItemsManager(String sharedLink,
                                          String password)

Get Shared Items manager, which can be used to make API calls on shared item endpoints.

Parameters:

sharedLink - shared link

password - password

Returns:

BoxSharedItemsManager

getSharedFilesManager

public BoxFilesManager getSharedFilesManager(String sharedLink,
                                    String password)

Get the BoxFilesManager for shared items, which can be used to make API calls on files endpoints for a shared item.

Parameters:

sharedLink - shared link.

password - password of the shared link, use null if there is no password

Returns:

BoxFilesManager

getSharedFoldersManager

public BoxFoldersManager getSharedFoldersManager(String sharedLink,
                                        String password)

Get the BoxFoldersManager for shared items, which can be used to make API calls on folders endpoints for a shared item.

Parameters:

sharedLink - shared link.

password - password of the shared link, use null if there is no password

Returns:

BoxFoldersManager

getSharedCommentsManager

public BoxCommentsManager getSharedCommentsManager(String sharedLink,
                                          String password)

Get the BoxCommentsManager for shared items, which can be used to make API calls on comments endpoints for a shared item.

Parameters:

sharedLink - shared link.

password - password of the shared link, use null if there is no password

Returns:

BoxFoldersManager

getResourceManagerWithSharedLinkAuth

public BoxResourceManager getResourceManagerWithSharedLinkAuth(BoxResourceType type,
                                                      String sharedLink,
                                                      String password)

A generic way to get a resourceManager with shared link auth. Currently only supports file, folder and comment endpoints.

Parameters:

type -

sharedLink -

password -

Returns:

getPluginManager

public BoxResourceManager getPluginManager(String pluginManagerKey)

getFoldersManager

public BoxFoldersManager getFoldersManager()

Returns:

the BoxFoldersManager, which can be used to make API calls on folders endpoints. Note this folders manager only work on the folders you own. if you are trying to make api calls on a shared folder (folder shared to you via shared link), please use getSharedFoldersManager().

getSearchManager

public BoxSearchManager getSearchManager()

Returns:

BoxSearchManager through which searches can be performed.

getEventsManager

public BoxEventsManager getEventsManager()

Returns:

BoxEventsManager through which the Box Events API can be queried.

getCollaborationsManager

public BoxCollaborationsManager getCollaborationsManager()

Returns:

the collaborationsManager

getCommentsManager

public BoxCommentsManager getCommentsManager()

Returns:

the commentsManager

getUsersManager

public BoxUsersManager getUsersManager()

Returns:

the usersManager

authenticate

public void authenticate(IAuthData authData)

Get authenticated using a Auth object, this could be a previously stored data.

Parameters:

token -

authenticate

public void authenticate(IAuthFlowUI authFlowUI,
                boolean autoRefreshOAuth,
                IAuthFlowListener listener)

Get authenticated. Note authentication is done asynchronously and may not finish right after this method. The authentication result should be notified to the IAuthFlowListener parameter.

Parameters:

authFlowUI - UI for the auth(OAuth) flow.

autoRefreshOAuth - whether the OAuth token should be auto refreshed when it expires.

listener - listener listening to the auth flow events.

onAuthFlowEvent

public void onAuthFlowEvent(IAuthEvent event,
                   IAuthFlowMessage message)

Description copied from interface: IAuthFlowListener

On an event.

Specified by:

onAuthFlowEvent in interface IAuthFlowListener

Parameters:

event - state

message - context message of this event

getAuthState

public OAuthDataController.OAuthTokenState getAuthState()

Check authentication state.

Returns:

authentication state

getConfig

public IBoxConfig getConfig()

Get config.

Returns:

config

createResourceHub

protected IBoxResourceHub createResourceHub()

Create a resource hub

Returns:

IBoxResourceHub

createJSONParser

protected IBoxJSONParser createJSONParser(IBoxResourceHub resourceHub)

Create a json parser.

Parameters:

resourceHub -

Returns:

getResourceHub

public IBoxResourceHub getResourceHub()

Get resource hub.

Returns:

Resource hub

getJSONParser

public IBoxJSONParser getJSONParser()

getRestClient

protected IBoxRESTClient getRestClient()

Get rest client.

Returns:

createRestClient

protected IBoxRESTClient createRestClient()

Create a REST client to make api calls.

Returns:

IBoxRESTClient

createMonitoredRestClient

protected IBoxRESTClient createMonitoredRestClient(int maxConnection,
                                       int maxConnectionPerRoute,
                                       long timePeriodCleanUpIdleConnection,
                                       long idleTimeThreshold)

getSharedItemAuth

public IBoxRequestAuth getSharedItemAuth(String sharedLink,
                                String password)

Get the authorization needed for shared items.

Parameters:

sharedLink - shared link

password - password(use null if no password at all)

Returns:

IBoxRequestAuth

createAuthDataController

public IAuthDataController createAuthDataController(String clientId,
                                           String clientSecret)

createAuthorization

public IBoxRequestAuth createAuthorization(IAuthDataController controller)

getAuth

public IBoxRequestAuth getAuth()

Get the auth object used to make api calls.

Returns:

onAuthFlowMessage

public void onAuthFlowMessage(IAuthFlowMessage message)

Description copied from interface: IAuthFlowListener

On a message.

Specified by:

onAuthFlowMessage in interface IAuthFlowListener

Parameters:

message - message

onAuthFlowException

public void onAuthFlowException(Exception e)

Description copied from interface: IAuthFlowListener

On an exception.

Specified by:

onAuthFlowException in interface IAuthFlowListener

Parameters:

e - exception

getOAuthTokenFromMessage

protected BoxOAuthToken getOAuthTokenFromMessage(IAuthFlowMessage message)