GroupsResource (Atlassian Crowd 4.0.0 API)

java.lang.Object
- com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
- - com.atlassian.crowd.plugin.rest.service.resource.usermanagement.GroupsResource

public class GroupsResource
extends AbstractResource

Field Summary
- Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
  request, uriInfo

Constructor Summary

Constructors
Constructor and Description

GroupsResource(GroupsController groupsController, MembershipsController membershipsController)

Constructors
Constructor and Description
`GroupsResource(GroupsController groupsController, MembershipsController membershipsController)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addDirectChildGroupMembership(String groupName, GroupEntity childGroup)` Adds a direct child group membership.
`javax.ws.rs.core.Response`	`addDirectParentGroupMembership(String groupName, GroupEntity parentGroup)` Adds a direct parent group membership.
`javax.ws.rs.core.Response`	`addGroup(GroupEntity restGroup)` Adds a new group.
`javax.ws.rs.core.Response`	`addUserAsDirectGroupMember(String groupName, UserEntity user)` Adds a user as a direct member of the specified group.
`javax.ws.rs.core.Response`	`deleteGroupAttribute(String groupname, String attributeName)` Deletes a group attribute.
`javax.ws.rs.core.Response`	`getAllMemberships(javax.ws.rs.core.Request request)` Retrieves full details of all group memberships, with users and nested groups.
`javax.ws.rs.core.Response`	`getDirectChildrenOfGroup(String groupName, String childGroupName, int startIndex, int maxResults)` Retrieves the groups that are direct children of the specified group or a single direct child of that group with the specified name.
`javax.ws.rs.core.Response`	`getDirectMembersOfGroup(String groupName, String username, int startIndex, int maxResults)` Retrieves the users that are direct members of the specified group or a specified user who is a direct member of that group.
`javax.ws.rs.core.Response`	`getDirectParentsOfGroup(String groupName, String childGroupName, int startIndex, int maxResults)` Retrieves the groups that are direct parents of the specified group or a direct parent group of the specified child group.
`javax.ws.rs.core.Response`	`getGroup(String groupName)` Retrieves a group.
`javax.ws.rs.core.Response`	`getGroupAttributes(String groupName)` Retrieves a list of group attributes.
`javax.ws.rs.core.Response`	`getNestedChildrenOfGroup(String groupName, String childGroupName, int startIndex, int maxResults)` Retrieves nested children of the specified group or a single nested child of that group with the specified name.
`javax.ws.rs.core.Response`	`getNestedMembersOfGroup(String groupName, String username, int startIndex, int maxResults)` Retrieves the users that are nested members of the specified group or a single user who is a nested member of the specified group.
`javax.ws.rs.core.Response`	`getNestedParentGroups(String groupName, String parentGroupName, int startIndex, int maxResults)` Retrieves the groups that are nested parents of the specified group or a single nested parent of that group with the specified name.
`javax.ws.rs.core.Response`	`removeDirectChildGroupMembership(String groupName, String childGroupName)` Deletes a child group membership.
`javax.ws.rs.core.Response`	`removeDirectGroupMembership(String groupName, String username)` Removes the user membership.
`javax.ws.rs.core.Response`	`removeGroup(String groupname)` Deletes a group.
`javax.ws.rs.core.Response`	`storeGroupAttributes(String groupname, MultiValuedAttributeEntityList attributes)` Stores the group attributes.
`javax.ws.rs.core.Response`	`updateGroup(String groupName, GroupEntity restGroup)` Updates an existing group.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupsResource

public GroupsResource(GroupsController groupsController,
                      MembershipsController membershipsController)

Method Detail

getGroup

public javax.ws.rs.core.Response getGroup(String groupName)
                                   throws GroupNotFoundException,
                                          OperationFailedException

Retrieves a group.

Parameters:: groupName - Name of the group to retrieve.
Throws:: GroupNotFoundException; OperationFailedException

addGroup

public javax.ws.rs.core.Response addGroup(GroupEntity restGroup)
                                   throws GroupNotFoundException,
                                          InvalidGroupException,
                                          ApplicationPermissionException,
                                          OperationFailedException

Adds a new group.

Parameters:: restGroup - the group to create.
Throws:: GroupNotFoundException; InvalidGroupException; ApplicationPermissionException; OperationFailedException

updateGroup

public javax.ws.rs.core.Response updateGroup(String groupName,
                                             GroupEntity restGroup)
                                      throws GroupNotFoundException,
                                             InvalidGroupException,
                                             ApplicationPermissionException,
                                             OperationFailedException

Updates an existing group.

Parameters:: groupName - the name of the group to update.; restGroup - the update data.
Throws:: GroupNotFoundException; InvalidGroupException; ApplicationPermissionException; OperationFailedException

removeGroup

public javax.ws.rs.core.Response removeGroup(String groupname)
                                      throws GroupNotFoundException,
                                             ApplicationPermissionException,
                                             OperationFailedException

Deletes a group.

Parameters:: groupname - Name of the group to delete.
Throws:: GroupNotFoundException; ApplicationPermissionException; OperationFailedException

getGroupAttributes

public javax.ws.rs.core.Response getGroupAttributes(String groupName)
                                             throws GroupNotFoundException,
                                                    OperationFailedException

Retrieves a list of group attributes.

Parameters:: groupName - Name of the group to fetch attributes from.
Throws:: GroupNotFoundException; OperationFailedException

storeGroupAttributes

public javax.ws.rs.core.Response storeGroupAttributes(String groupname,
                                                      MultiValuedAttributeEntityList attributes)
                                               throws GroupNotFoundException,
                                                      ApplicationPermissionException,
                                                      OperationFailedException

Stores the group attributes.

Parameters:: groupname - name of the group.; attributes - the attributes to store.
Throws:: GroupNotFoundException; ApplicationPermissionException; OperationFailedException

deleteGroupAttribute

public javax.ws.rs.core.Response deleteGroupAttribute(String groupname,
                                                      String attributeName)
                                               throws GroupNotFoundException,
                                                      ApplicationPermissionException,
                                                      OperationFailedException

Deletes a group attribute.

Parameters:: groupname - name of the group.; attributeName - name of the attribute to delete.
Throws:: GroupNotFoundException; ApplicationPermissionException; OperationFailedException

getDirectMembersOfGroup

public javax.ws.rs.core.Response getDirectMembersOfGroup(String groupName,
                                                         String username,
                                                         int startIndex,
                                                         int maxResults)
                                                  throws MembershipNotFoundException,
                                                         OperationFailedException,
                                                         GroupNotFoundException

Retrieves the users that are direct members of the specified group or a specified user who is a direct member of that group.

Parameters:: groupName - name of the group.; username - if specified it will return a single user if the user is a direct member of the specified group.; startIndex - start index if using paged queries, only applicable when username is not provided.; maxResults - maximum amount of results to return, only applicable when username is not provided.
Throws:: MembershipNotFoundException; OperationFailedException; GroupNotFoundException

addUserAsDirectGroupMember

public javax.ws.rs.core.Response addUserAsDirectGroupMember(String groupName,
                                                            UserEntity user)
                                                     throws GroupNotFoundException,
                                                            OperationFailedException,
                                                            ApplicationPermissionException,
                                                            MembershipAlreadyExistsException

Adds a user as a direct member of the specified group.

Parameters:: groupName - name of the group to which the user will be added.; user - the user to add to the group.
Throws:: GroupNotFoundException; OperationFailedException; ApplicationPermissionException; MembershipAlreadyExistsException

removeDirectGroupMembership

public javax.ws.rs.core.Response removeDirectGroupMembership(String groupName,
                                                             String username)
                                                      throws GroupNotFoundException,
                                                             MembershipNotFoundException,
                                                             UserNotFoundException,
                                                             OperationFailedException,
                                                             ApplicationPermissionException

Removes the user membership.

Parameters:: groupName - name of the group from which the user membership will be removed.; username - name the user to have their membership removed.
Throws:: GroupNotFoundException; MembershipNotFoundException; UserNotFoundException; OperationFailedException; ApplicationPermissionException

getNestedMembersOfGroup

public javax.ws.rs.core.Response getNestedMembersOfGroup(String groupName,
                                                         String username,
                                                         int startIndex,
                                                         int maxResults)
                                                  throws MembershipNotFoundException,
                                                         OperationFailedException,
                                                         GroupNotFoundException

Retrieves the users that are nested members of the specified group or a single user who is a nested member of the specified group.

Parameters:: groupName - name of the group.; username - if specified it will return a single user if the user is a nested member of the specified group.; startIndex - start index if using paged queries, only applicable when username is not provided.; maxResults - maximum amount of results to return, only applicable when username is not provided.
Throws:: MembershipNotFoundException; OperationFailedException; GroupNotFoundException

getDirectParentsOfGroup
```
public javax.ws.rs.core.Response getDirectParentsOfGroup(String groupName,
                                                         String childGroupName,
                                                         int startIndex,
                                                         int maxResults)
                                                  throws MembershipNotFoundException,
                                                         OperationFailedException
```
Retrieves the groups that are direct parents of the specified group or a direct parent group of the specified child group.

Parameters:

groupName - if child-groupname is specified then the direct parents of this group will be returned. Otherwise this is the direct parent group.

childGroupName - if specified this will return a single direct parent group of this group with the name groupname.

startIndex - start index if using paged queries, only applicable when child-groupname is not provided.

maxResults - maximum amount of results to return, only applicable when child-groupname is not provided.

Throws:

MembershipNotFoundException

OperationFailedException

addDirectParentGroupMembership

public javax.ws.rs.core.Response addDirectParentGroupMembership(String groupName,
                                                                GroupEntity parentGroup)
                                                         throws InvalidMembershipException,
                                                                OperationFailedException,
                                                                ApplicationPermissionException,
                                                                MembershipAlreadyExistsException

Adds a direct parent group membership.

Parameters:: groupName - name of the child group.; parentGroup - the parent group.
Throws:: InvalidMembershipException; OperationFailedException; ApplicationPermissionException; MembershipAlreadyExistsException

getNestedParentGroups
```
public javax.ws.rs.core.Response getNestedParentGroups(String groupName,
                                                       String parentGroupName,
                                                       int startIndex,
                                                       int maxResults)
                                                throws MembershipNotFoundException,
                                                       OperationFailedException
```
Retrieves the groups that are nested parents of the specified group or a single nested parent of that group with the specified name.

Parameters:

groupName - name of the group of which the nested parents will be returned.

parentGroupName - if specified then the single nested parent group with this name of the group specified by groupname will be returned.

startIndex - start index if using paged queries, only applicable when parent-groupname is not provided.

maxResults - maximum amount of results to return, only applicable when parent-groupname is not provided.

Throws:

MembershipNotFoundException

OperationFailedException

getDirectChildrenOfGroup

public javax.ws.rs.core.Response getDirectChildrenOfGroup(String groupName,
                                                          String childGroupName,
                                                          int startIndex,
                                                          int maxResults)
                                                   throws MembershipNotFoundException,
                                                          OperationFailedException

Retrieves the groups that are direct children of the specified group or a single direct child of that group with the specified name.

Parameters:: groupName - Name of the parent group which will have its children fetched.; childGroupName - If specified then only the direct child group with this name will be returned.; startIndex - start index if using paged queries, only applicable when child-groupname is not provided.; maxResults - maximum amount of results to return, only applicable when child-groupname is not provided.
Throws:: MembershipNotFoundException; OperationFailedException

addDirectChildGroupMembership

public javax.ws.rs.core.Response addDirectChildGroupMembership(String groupName,
                                                               GroupEntity childGroup)
                                                        throws InvalidMembershipException,
                                                               ApplicationPermissionException,
                                                               OperationFailedException,
                                                               MembershipAlreadyExistsException

Adds a direct child group membership.

Parameters:: groupName - Name of the parent group to which the direct child group will be added.; childGroup - The child group.
Throws:: InvalidMembershipException; ApplicationPermissionException; OperationFailedException; MembershipAlreadyExistsException

removeDirectChildGroupMembership

public javax.ws.rs.core.Response removeDirectChildGroupMembership(String groupName,
                                                                  String childGroupName)
                                                           throws MembershipNotFoundException,
                                                                  GroupNotFoundException,
                                                                  ApplicationPermissionException,
                                                                  OperationFailedException

Deletes a child group membership.

Parameters:: groupName - Name of the parent group.; childGroupName - Name of the child group.
Throws:: MembershipNotFoundException; GroupNotFoundException; ApplicationPermissionException; OperationFailedException

getNestedChildrenOfGroup
```
public javax.ws.rs.core.Response getNestedChildrenOfGroup(String groupName,
                                                          String childGroupName,
                                                          int startIndex,
                                                          int maxResults)
                                                   throws MembershipNotFoundException,
                                                          OperationFailedException
```
Retrieves nested children of the specified group or a single nested child of that group with the specified name.

Parameters:

groupName - Name of the parent group which will have its nested children fetched.

childGroupName - If provided then only a single nested child group with this name will be fetched from the group specified by groupname.

startIndex - start index if using paged queries, only applicable when child-groupname is not provided.

maxResults - maximum amount of results to return, only applicable when child-groupname is not provided.

Throws:

MembershipNotFoundException

OperationFailedException

getAllMemberships

public javax.ws.rs.core.Response getAllMemberships(@Context
                                                   javax.ws.rs.core.Request request)
                                            throws GroupNotFoundException,
                                                   NoSuchAlgorithmException

Retrieves full details of all group memberships, with users and nested groups. This resource is optimised for streaming XML responses, and does not support JSON responses.

Throws:: GroupNotFoundException; NoSuchAlgorithmException

Class GroupsResource

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

Constructor Summary