Package com.atlassian.confluence.user.extras.rest

Class GroupsResource

java.lang.Object

com.atlassian.confluence.user.extras.rest.GroupsResource

@Path("/groups")
@Produces({"application/json","application/xml"})
public class GroupsResource
extends Object

This rest plugin is capable of returning admin only information about groups in the confluence instance.

Constructor Summary

Constructors

Constructor	Description
GroupsResource(GroupEntityBuilder groupEntityBuilder, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getGroups(int startIndex, int maxResults)	This gets groups out of this instance in a paginated fashion.

Methods inherited from class java.lang.Object

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

Constructor Details

GroupsResource

@Inject
public GroupsResource(GroupEntityBuilder groupEntityBuilder,
 PermissionManager permissionManager)

Method Details

getGroups

@GET
public javax.ws.rs.core.Response getGroups(@QueryParam("startIndex")
 int startIndex,
 @DefaultValue("50") @QueryParam("maxResults")
 int maxResults)

This gets groups out of this instance in a paginated fashion.

Parameters:

startIndex - The initial zero-based index to get values from.

maxResults - The maximum number of groups to pull out of the index.

Returns:

The groups in the range requested.