com.atlassian.confluence.plugins.restapi.resources

Class GroupResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.GroupResource

@ExperimentalApi
public class GroupResource
extends Object

Non-admin operations for user groups

Constructor Summary

Constructors

Constructor and Description
GroupResource(GroupService groupService, PersonService personService)

Method Summary

Modifier and Type	Method and Description
Group	getGroup(String groupName, String expand) Get the user group with the group name
PageResponse<Group>	getGroups(String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Get a paginated collection of user groups
PageResponse<Person>	getMembers(Group group, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Get a paginated collection of users in the given group

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupResource

public GroupResource(GroupService groupService,
                     PersonService personService)

Method Detail

getGroups

public PageResponse<Group> getGroups(String expand,
                                     int start,
                                     int limit,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)

Get a paginated collection of user groups

Parameters:

start - the start point of the collection to return

limit - the limit of the number of items to return, this may be restricted by fixed system limits

Returns:

a paginated collection of user groups

getGroup

public Group getGroup(String groupName,
                      String expand)

Get the user group with the group name

Parameters:

groupName -

Returns:

the user group with the group name

getMembers

public PageResponse<Person> getMembers(Group group,
                                       String expand,
                                       int start,
                                       int limit,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo)

Get a paginated collection of users in the given group

Parameters:

group - the group to look up the members for

start - the start point of the collection to return

limit - the limit of the number of items to return, this may be restricted by fixed system limits

Returns:

a collection of users in the given group