com.atlassian.bamboo.plugins.rest.user

Class GroupAdminResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.user.GroupAdminResource

public class GroupAdminResource
extends Object

REST resource to manage groups in Bamboo.

Since:

6.6

Constructor Summary

Constructors

Constructor and Description
GroupAdminResource(BambooPermissionManager bambooPermissionManager, BambooUserManager userManager, GravatarService gravatarService, com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate, com.atlassian.struts.TextProvider textProvider, PaginationService paginationService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUsersToGroup(String groupName, List<String> usersToAdd) Add multiple users to a group.
javax.ws.rs.core.Response	createGroup(RestGroup group) Create a new group.
javax.ws.rs.core.Response	deleteGroup(String groupName) Deletes the specified group, removing it from the system.
RestPageModel<RestUserDetails>	findUsersInGroup(String groupName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieves a list of users that are members of a specified group.
RestPageModel<RestUserDetails>	findUsersNotInGroup(String groupName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieves a list of users that are not members of a specified group.
RestPageModel<RestGroup>	getGroups(String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a paginated list of groups.
javax.ws.rs.core.Response	removeUsersFromGroup(String groupName, List<String> usersToAdd) Remove multiple users from a group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupAdminResource

@Inject
public GroupAdminResource(BambooPermissionManager bambooPermissionManager,
                                  BambooUserManager userManager,
                                  GravatarService gravatarService,
                                  com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate,
                                  com.atlassian.struts.TextProvider textProvider,
                                  PaginationService paginationService)

Method Detail

getGroups

public RestPageModel<RestGroup> getGroups(String filter,
                                          @Context
                                          PageRequest pageRequest,
                                          @Context
                                          Expansion expansion,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)
                                   throws com.atlassian.user.EntityException

Retrieve a paginated list of groups. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

filter - if specified only group names containing the supplied string (case insensitive) will be returned

Throws:

com.atlassian.user.EntityException

createGroup

public javax.ws.rs.core.Response createGroup(RestGroup group)
                                      throws WebValidationException

Create a new group. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

group - Group to create

Throws:

WebValidationException

deleteGroup

public javax.ws.rs.core.Response deleteGroup(String groupName)
                                      throws WebValidationException

Deletes the specified group, removing it from the system. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

groupName - the name identifying the group to delete

Throws:

WebValidationException

addUsersToGroup

public javax.ws.rs.core.Response addUsersToGroup(String groupName,
                                                 List<String> usersToAdd)
                                          throws WebValidationException

Add multiple users to a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.

Throws:

WebValidationException

removeUsersFromGroup

public javax.ws.rs.core.Response removeUsersFromGroup(String groupName,
                                                      List<String> usersToAdd)
                                               throws WebValidationException

Remove multiple users from a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.

Throws:

WebValidationException

findUsersInGroup

public RestPageModel<RestUserDetails> findUsersInGroup(String groupName,
                                                       String filter,
                                                       @Context
                                                       PageRequest pageRequest,
                                                       @Context
                                                       Expansion expansion,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo)

Retrieves a list of users that are members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

groupName - the group which should be used to locate members

filter - if specified only users with usernames, display names or email addresses containing the supplied string (case insensitive) will be returned

findUsersNotInGroup

public RestPageModel<RestUserDetails> findUsersNotInGroup(String groupName,
                                                          String filter,
                                                          @Context
                                                          PageRequest pageRequest,
                                                          @Context
                                                          Expansion expansion,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws com.atlassian.user.EntityException

Retrieves a list of users that are not members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

groupName - the group which should be used to locate non-members

filter - if specified only users with usernames, display names or email addresses containing the supplied string will be returned

Throws:

com.atlassian.user.EntityException