com.box.boxjavalibv2.resourcemanagers

Class BoxUsersManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxUsersManager

public final class BoxUsersManager
extends BoxResourceManager

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
BoxUsersManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxEmailAlias	addEmailAlias(String userId, BoxUserRequestObject 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(String userId, String emailId, BoxDefaultRequestObject requestObject) Removes an email alias from a user.
List<BoxUser>	getAllEnterpriseUser(BoxDefaultRequestObject requestObject, 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 List<BoxEmailAlias>	getEmailAliases(BoxCollection collection) Get email aliases from a collection.
List<BoxEmailAlias>	getEmailAliases(String userId, BoxDefaultRequestObject requestObject) Retrieves all email aliases for this user.
static List<BoxUser>	getUsers(BoxCollection collection) Get users from a collection.
BoxFolder	moveFolderToAnotherUser(String userId, String folderId, BoxUserRequestObject requestObject) Moves all of the content from within one user's folder into a new folder in another user's account.
BoxUser	updateUserInformaiton(String userId, BoxUserRequestObject requestObject) Used to edit the settings and information about a user.
BoxUser	updateUserPrimaryLogin(String userId, BoxUserRequestObject 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.BoxResourceManager

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

BoxUsersManager

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

Get the current user's information.

Parameters:

requestObject - request object

Returns:

current user

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

getAllEnterpriseUser

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

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.

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 - exception

BoxServerException - exception

AuthFatalFailureException - exception

moveFolderToAnotherUser

public BoxFolder moveFolderToAnotherUser(String userId,
                                String folderId,
                                BoxUserRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

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

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 - exception

BoxServerException - exception

AuthFatalFailureException - exception

createEnterpriseUser

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

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

Parameters:

requestObject - request object

Returns:

newly created user

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

updateUserInformaiton

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

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

Parameters:

userId - id of the user.

requestObject - request object

Returns:

the updated user

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

getEmailAliases

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

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

Parameters:

userId - id of user

requestObject - request object

Returns:

collection of email aliases

Throws:

BoxServerException - exception

BoxRestException - exception

AuthFatalFailureException - exception

addEmailAlias

public BoxEmailAlias addEmailAlias(String userId,
                          BoxUserRequestObject requestObject)
                            throws BoxServerException,
                                   BoxRestException,
                                   AuthFatalFailureException

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).

Parameters:

userId - id of user

requestObject - request object

Returns:

the newly added email alias

Throws:

BoxServerException - exception

BoxRestException - exception

AuthFatalFailureException - exception

deleteEmailAlias

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

Removes an email alias from a user.

Parameters:

userId - id of the user

emailId - id of the email alias to be removed

requestObject - request object

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

updateUserPrimaryLogin

public BoxUser updateUserPrimaryLogin(String userId,
                             BoxUserRequestObject requestObject)
                               throws BoxRestException,
                                      BoxServerException,
                                      AuthFatalFailureException

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

Parameters:

userId - id of the user

requestObject - request object

Returns:

the updated user object

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

getUsers

public static List<BoxUser> getUsers(BoxCollection collection)

Get users from a collection.

Parameters:

collection - collection

Returns:

users

getEmailAliases

public static List<BoxEmailAlias> getEmailAliases(BoxCollection collection)

Get email aliases from a collection.

Parameters:

collection - collection

Returns:

email aliases