com.atlassian.confluence.user.extras.rest

Class GroupsResource

java.lang.Object

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

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 and Description
GroupsResource(GroupEntityBuilder groupEntityBuilder, PermissionManager permissionManager)

Method Summary

Methods

Modifier and Type	Method and 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 Detail

GroupsResource

public GroupsResource(GroupEntityBuilder groupEntityBuilder,
              PermissionManager permissionManager)

Method Detail

getGroups

public javax.ws.rs.core.Response getGroups(int startIndex,
                                  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.