com.box.boxjavalibv2.resourcemanagers

Class BoxUsersManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxUsersManagerImpl

All Implemented Interfaces:

IBoxResourceManager, IBoxUsersManager

public final class BoxUsersManagerImpl
extends AbstractBoxResourceManager
implements IBoxUsersManager

Use this class to execute requests synchronously against the Box REST API(V2), users endpints. 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
BoxUsersManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxEmailAlias	addEmailAlias(java.lang.String userId, BoxEmailAliasRequestObject requestObject) Adds a new email alias to the given user's account.
BoxUser	createEnterpriseUser(BoxUserRequestObject requestObject) Used to provision a new user in an enterprise.
void	deleteEmailAlias(java.lang.String userId, java.lang.String emailId, BoxDefaultRequestObject requestObject) Removes an email alias from a user.
java.util.List<BoxUser>	getAllEnterpriseUser(BoxDefaultRequestObject requestObject, java.lang.String filterTerm) Get the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin.
BoxUser	getCurrentUser(BoxDefaultRequestObject requestObject) Get the current user's information.
static java.util.List<BoxEmailAlias>	getEmailAliases(BoxCollection collection) Deprecated.
java.util.List<BoxEmailAlias>	getEmailAliases(java.lang.String userId, BoxDefaultRequestObject requestObject) Retrieves all email aliases for this user.
static java.util.List<BoxUser>	getUsers(BoxCollection collection) Deprecated.
BoxFolder	moveFolderToAnotherUser(java.lang.String userId, java.lang.String folderId, BoxSimpleUserRequestObject requestObject) Moves all of the content from within one user's folder into a new folder in another user's account.
BoxUser	updateUserInformaiton(java.lang.String userId, BoxUserRequestObject requestObject) Used to edit the settings and information about a user.
BoxUser	updateUserPrimaryLogin(java.lang.String userId, BoxUserUpdateLoginRequestObject requestObject) Used to convert one of the user's confirmed email aliases into the user's primary login.

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

BoxUsersManagerImpl

public BoxUsersManagerImpl(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

getCurrentUser

public BoxUser getCurrentUser(BoxDefaultRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Get the current user's information.

Specified by:

getCurrentUser in interface IBoxUsersManager

Parameters:

requestObject - request object

Returns:

current user

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.

getAllEnterpriseUser

public java.util.List<BoxUser> getAllEnterpriseUser(BoxDefaultRequestObject requestObject,
                                           java.lang.String filterTerm)
                                             throws BoxRestException,
                                                    BoxServerException,
                                                    AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Get the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin. If the user is not an admin, this request returns the current user's user_id, public_name, and login.

Specified by:

getAllEnterpriseUser in interface IBoxUsersManager

Parameters:

requestObject - request object

filterTerm - A string used to filter the results to only users starting with the filter_term in either the name or the login. Use null if don't want filter.

Returns:

collection of users

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.

moveFolderToAnotherUser

public BoxFolder moveFolderToAnotherUser(java.lang.String userId,
                                java.lang.String folderId,
                                BoxSimpleUserRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Moves all of the content from within one user's folder into a new folder in another user's account. You can move folders across users as long as the you have administrative permissions. To move everything from the root folder, use 0 which always represents the root folder of a Box account

Specified by:

moveFolderToAnotherUser in interface IBoxUsersManager

Parameters:

userId - id of the user

folderId - id of the folder to be removed

requestObject - request object

Returns:

the newly created destination 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.

createEnterpriseUser

public BoxUser createEnterpriseUser(BoxUserRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Used to provision a new user in an enterprise. This method only works for enterprise admins.

Specified by:

createEnterpriseUser in interface IBoxUsersManager

Parameters:

requestObject - request object

Returns:

newly created user

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.

updateUserInformaiton

public BoxUser updateUserInformaiton(java.lang.String userId,
                            BoxUserRequestObject requestObject)
                              throws BoxRestException,
                                     BoxServerException,
                                     AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Used to edit the settings and information about a user. This method only works for enterprise admins.

Specified by:

updateUserInformaiton in interface IBoxUsersManager

Parameters:

userId - id of the user.

requestObject - request object

Returns:

the updated user

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.

getEmailAliases

public java.util.List<BoxEmailAlias> getEmailAliases(java.lang.String userId,
                                            BoxDefaultRequestObject requestObject)
                                              throws BoxServerException,
                                                     BoxRestException,
                                                     AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user

Specified by:

getEmailAliases in interface IBoxUsersManager

Parameters:

userId - id of user

requestObject - request object

Returns:

collection of email aliases

Throws:

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

addEmailAlias

public BoxEmailAlias addEmailAlias(java.lang.String userId,
                          BoxEmailAliasRequestObject requestObject)
                            throws BoxServerException,
                                   BoxRestException,
                                   AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Adds a new email alias to the given user's account. This feature is currently only available to enterprise admins and the new email must be in a domain associated with the enterprise and can not be a publicly atainable domain (e.g. gmail.com).

Specified by:

addEmailAlias in interface IBoxUsersManager

Parameters:

userId - id of user

requestObject - request object

Returns:

the newly added email alias

Throws:

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteEmailAlias

public void deleteEmailAlias(java.lang.String userId,
                    java.lang.String emailId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Removes an email alias from a user.

Specified by:

deleteEmailAlias in interface IBoxUsersManager

Parameters:

userId - id of the user

emailId - id of the email alias to be removed

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.

updateUserPrimaryLogin

public BoxUser updateUserPrimaryLogin(java.lang.String userId,
                             BoxUserUpdateLoginRequestObject requestObject)
                               throws BoxRestException,
                                      BoxServerException,
                                      AuthFatalFailureException

Description copied from interface: IBoxUsersManager

Used to convert one of the user's confirmed email aliases into the user's primary login.

Specified by:

updateUserPrimaryLogin in interface IBoxUsersManager

Parameters:

userId - id of the user

requestObject - request object

Returns:

the updated user 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.

getUsers

@Deprecated
public static java.util.List<BoxUser> getUsers(BoxCollection collection)

Deprecated.

Get users from a collection.Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

users

getEmailAliases

@Deprecated
public static java.util.List<BoxEmailAlias> getEmailAliases(BoxCollection collection)

Deprecated.

Get email aliases from a collection.Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

email aliases