com.atlassian.bamboo.plugins.rest.admin.group

Class GroupResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.group.GroupResource

public class GroupResource
extends Object

REST resource to manage groups in bamboo. If user repositories is set to use external crowd or ldap instance any modification to groups will result in 400 status code.

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static RestGroup	REST_GROUP
static List<RestGroup>	REST_GROUPS

Constructor Summary

Constructors

Constructor and Description
GroupResource(UserService restGroupService, GroupConversionFunction groupConversionFunction)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createGroup(RestGroup restGroup, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Create a group in Bamboo
List<RestGroup>	getGroup(String name, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of groups in Bamboo.

Methods inherited from class java.lang.Object

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

Field Detail

REST_GROUP

public static final RestGroup REST_GROUP

REST_GROUPS

public static final List<RestGroup> REST_GROUPS

Constructor Detail

GroupResource

public GroupResource(UserService restGroupService,
                     GroupConversionFunction groupConversionFunction)

Method Detail

getGroup

public List<RestGroup> getGroup(String name,
                                @Context
                                Expansion expansion,
                                @Context
                                javax.ws.rs.core.UriInfo uriInfo)
                         throws WebValidationException

Retrieve a list of groups in Bamboo. The list can be filter by some attributes, e.g. name. Currently name is mandatory. Since name is unique, the result only contains 0 or 1 entry.

Parameters:

name - Name of group

Returns:

List of groups

Throws:

WebValidationException

createGroup

public javax.ws.rs.core.Response createGroup(RestGroup restGroup,
                                             @Context
                                             Expansion expansion,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)
                                      throws WebValidationException

Create a group in Bamboo

Parameters:

restGroup - RestGroup object that contains name of the group.

Returns:

Response A response contains the created group.

Throws:

WebValidationException