com.box.boxjavalibv2.resourcemanagers

Class BoxGroupsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxGroupsManagerImpl

All Implemented Interfaces:

IBoxGroupsManager, IBoxResourceManager

public class BoxGroupsManagerImpl
extends AbstractBoxResourceManager
implements IBoxGroupsManager

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BoxGroup	createGroup(BoxGroupRequestObject requestObject) Create a group.
BoxGroup	createGroup(java.lang.String name) Create a group.
BoxGroupMembership	createMembership(BoxGroupMembershipRequestObject requestObject)
BoxGroupMembership	createMembership(java.lang.String groupId, java.lang.String userId, java.lang.String role)
void	deleteGroup(java.lang.String groupId, BoxDefaultRequestObject requestObject) Delete a group.
void	deleteMembership(java.lang.String membershipId, BoxDefaultRequestObject requestObject) Delete a membership.
BoxCollection	getAllCollaborations(java.lang.String groupId, BoxDefaultRequestObject requestObject) Get all collaborations of this group.
BoxCollection	getAllGroups(BoxDefaultRequestObject requestObject) Get all groups.
BoxGroupMembership	getMembership(java.lang.String membershipId, BoxDefaultRequestObject requestObject)
BoxCollection	getMemberships(java.lang.String groupId, BoxDefaultRequestObject requestObject) Get memberships of a group.
BoxGroup	updateGroup(java.lang.String groupId, BoxGroupRequestObject requestObject) Update group information.
BoxGroupMembership	updateMembership(java.lang.String membershipId, BoxGroupMembershipRequestObject requestObject) update a membership.
BoxGroupMembership	updateMembership(java.lang.String membershipId, java.lang.String role) Update role of a membership.

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

BoxGroupsManagerImpl

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

Method Detail

getAllGroups

public BoxCollection getAllGroups(BoxDefaultRequestObject requestObject)
                           throws BoxRestException,
                                  AuthFatalFailureException,
                                  BoxServerException

Description copied from interface: IBoxGroupsManager

Get all groups.

Specified by:

getAllGroups in interface IBoxGroupsManager

Returns:

All groups.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

createGroup

public BoxGroup createGroup(BoxGroupRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Description copied from interface: IBoxGroupsManager

Create a group.

Specified by:

createGroup in interface IBoxGroupsManager

Returns:

the group created.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

createGroup

public BoxGroup createGroup(java.lang.String name)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Description copied from interface: IBoxGroupsManager

Create a group.

Specified by:

createGroup in interface IBoxGroupsManager

Parameters:

name - name of the group.

Returns:

The group created.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

updateGroup

public BoxGroup updateGroup(java.lang.String groupId,
                   BoxGroupRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Description copied from interface: IBoxGroupsManager

Update group information.

Specified by:

updateGroup in interface IBoxGroupsManager

Parameters:

groupId - id of the group.

Returns:

the updated group.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

deleteGroup

public void deleteGroup(java.lang.String groupId,
               BoxDefaultRequestObject requestObject)
                 throws BoxRestException,
                        AuthFatalFailureException,
                        BoxServerException

Description copied from interface: IBoxGroupsManager

Delete a group.

Specified by:

deleteGroup in interface IBoxGroupsManager

Parameters:

groupId - id of the group.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

getMemberships

public BoxCollection getMemberships(java.lang.String groupId,
                           BoxDefaultRequestObject requestObject)
                             throws BoxRestException,
                                    AuthFatalFailureException,
                                    BoxServerException

Description copied from interface: IBoxGroupsManager

Get memberships of a group.

Specified by:

getMemberships in interface IBoxGroupsManager

Parameters:

groupId - id of the group.

Returns:

memberships.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

getMembership

public BoxGroupMembership getMembership(java.lang.String membershipId,
                               BoxDefaultRequestObject requestObject)
                                 throws BoxRestException,
                                        AuthFatalFailureException,
                                        BoxServerException

Specified by:

getMembership in interface IBoxGroupsManager

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

public BoxGroupMembership createMembership(BoxGroupMembershipRequestObject requestObject)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Specified by:

createMembership in interface IBoxGroupsManager

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

public BoxGroupMembership createMembership(java.lang.String groupId,
                                  java.lang.String userId,
                                  java.lang.String role)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Specified by:

createMembership in interface IBoxGroupsManager

Parameters:

groupId - id of the group

userId - id of the user to be added.

role - role of the user. e.g. BoxGroupMembership.ROLE_ADMIN

Throws:

BoxRestException - See BoxRestException for more info.

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

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

updateMembership

public BoxGroupMembership updateMembership(java.lang.String membershipId,
                                  BoxGroupMembershipRequestObject requestObject)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Description copied from interface: IBoxGroupsManager

update a membership.

Specified by:

updateMembership in interface IBoxGroupsManager

Parameters:

membershipId - id of the membership to be updated.

Returns:

Updated membership.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

updateMembership

public BoxGroupMembership updateMembership(java.lang.String membershipId,
                                  java.lang.String role)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Description copied from interface: IBoxGroupsManager

Update role of a membership.

Specified by:

updateMembership in interface IBoxGroupsManager

Parameters:

membershipId - id of the membership.

role - new role.

Returns:

updated membership.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

deleteMembership

public void deleteMembership(java.lang.String membershipId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             AuthFatalFailureException,
                             BoxServerException

Description copied from interface: IBoxGroupsManager

Delete a membership.

Specified by:

deleteMembership in interface IBoxGroupsManager

Parameters:

membershipId - id of the membership.

Throws:

BoxRestException - See BoxRestException for more info.

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

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

getAllCollaborations

public BoxCollection getAllCollaborations(java.lang.String groupId,
                                 BoxDefaultRequestObject requestObject)
                                   throws BoxRestException,
                                          AuthFatalFailureException,
                                          BoxServerException

Description copied from interface: IBoxGroupsManager

Get all collaborations of this group.

Specified by:

getAllCollaborations in interface IBoxGroupsManager

Parameters:

groupId - id of the group.

Returns:

collection of all the collaboration.

Throws:

BoxRestException - See BoxRestException for more info.

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

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