com.atlassian.crowd.plugin.rest.service.resource.admin

Class GroupAdminResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.admin.GroupAdminResource

@Path(value="group")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class GroupAdminResource
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupAdminResource(GroupAdminController controller, NestedGroupsMembershipController nestedMembershipController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addGroupsToGroup(DirectoryEntityId groupId, GroupIdentifiersEntityList groups) Adds multiple groups to a single group placed in the same directory
javax.ws.rs.core.Response	getNestedGroups(DirectoryEntityId groupId, RestPageRequest pageRequest) Returns group's direct members (groups).
RestPage<GroupSearchResultEntity>	searchDirectoryGroups(long dirId, String term, Boolean active, RestPageRequest pageRequest) Searches the given directory for groups matching the search term.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupAdminResource

public GroupAdminResource(GroupAdminController controller,
                          NestedGroupsMembershipController nestedMembershipController)

Method Detail

searchDirectoryGroups

@GET
 @Path(value="search/{directoryId}")
 @ExperimentalApi
public RestPage<GroupSearchResultEntity> searchDirectoryGroups(@PathParam(value="directoryId")
                                                                                                                           long dirId,
                                                                                                                           @QueryParam(value="term") @Nullable
                                                                                                                           String term,
                                                                                                                           @QueryParam(value="active") @Nullable
                                                                                                                           Boolean active,
                                                                                                                           @Context
                                                                                                                           RestPageRequest pageRequest)
                                                                                                                    throws DirectoryNotFoundException,
                                                                                                                           OperationFailedException

Searches the given directory for groups matching the search term.

Parameters:

dirId - the id of the directory to search

term - the search term

active - status of the groups to search

Throws:

DirectoryNotFoundException

OperationFailedException

getNestedGroups

@GET
 @Path(value="/{groupId}/groups")
 @ExperimentalApi
public javax.ws.rs.core.Response getNestedGroups(@PathParam(value="groupId")
                                                                                                          DirectoryEntityId groupId,
                                                                                                          @Context
                                                                                                          RestPageRequest pageRequest)
                                                                                                   throws DirectoryNotFoundException,
                                                                                                          OperationFailedException,
                                                                                                          GroupNotFoundException,
                                                                                                          FeatureInaccessibleException

Returns group's direct members (groups).

Parameters:

groupId - Group's unique identifier

Throws:

DirectoryNotFoundException

OperationFailedException

GroupNotFoundException

FeatureInaccessibleException

addGroupsToGroup

@POST
 @Path(value="/{groupId}/groups")
 @ExperimentalApi
public javax.ws.rs.core.Response addGroupsToGroup(@PathParam(value="groupId")
                                                                                                            DirectoryEntityId groupId,
                                                                                                            GroupIdentifiersEntityList groups)
                                                                                                     throws DirectoryNotFoundException,
                                                                                                            GroupNotFoundException,
                                                                                                            OperationFailedException,
                                                                                                            DirectoryPermissionException,
                                                                                                            FeatureInaccessibleException

Adds multiple groups to a single group placed in the same directory

Parameters:

groupId - Group's unique identifier

groups - Entity with group's unique identifiers

Throws:

DirectoryNotFoundException

GroupNotFoundException

OperationFailedException

DirectoryPermissionException

FeatureInaccessibleException