Package 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	Description
GroupAdminResource(BambooPermissionManager bambooPermissionManager, BambooUserManager userManager, com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate, com.atlassian.struts.TextProvider textProvider, PaginationService paginationService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addUsersToGroup(String groupName, List<String> usersToAdd)
javax.ws.rs.core.Response	createGroup(RestGroup group)
javax.ws.rs.core.Response	deleteGroup(String groupName)
RestPageModel<RestUserDetails>	findUsersInGroup(String groupName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestUserDetails>	findUsersNotInGroup(String groupName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestGroup>	getGroups(String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	removeUsersFromGroup(String groupName, List<String> usersToRemove)

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

Throws:

com.atlassian.user.EntityException

createGroup

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

Throws:

WebValidationException

deleteGroup

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

Throws:

WebValidationException

addUsersToGroup

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

Throws:

WebValidationException

removeUsersFromGroup

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

Throws:

WebValidationException

findUsersInGroup

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

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

Throws:

com.atlassian.user.EntityException