com.atlassian.crowd.plugin.rest.service.controller

Class GroupsController

java.lang.Object

com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

com.atlassian.crowd.plugin.rest.service.controller.GroupsController

public class GroupsController
extends AbstractResourceController

Controller for the Group resource.

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

applicationManager, applicationService

Constructor Summary

Constructors

Constructor and Description
GroupsController(ApplicationService applicationService, ApplicationManager applicationManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDirectChildGroup(String applicationName, String groupName, String childGroupName) Adds a direct child group membership.
void	addDirectParentGroup(String applicationName, String groupName, String parentGroupName) Adds a direct parent group membership.
void	addDirectUser(String applicationName, String groupName, String username) Adds user as direct member of group.
String	addGroup(String applicationName, GroupEntity group) Adds a new group.
void	deleteDirectChildGroup(String applicationName, String groupName, String childGroupName) Deletes a child group membership.
void	deleteDirectUser(String applicationName, String groupName, String username) Removes the user membership.
GroupEntity	findGroupByName(String applicationName, String name, boolean expandAttributes, URI baseURI) Returns the group specified by the name.
GroupEntity	getDirectChildGroup(String applicationName, String groupName, String childGroupName, URI baseUri) Retrieves the group that is a direct child of the specified group.
GroupEntityList	getDirectChildGroups(String applicationName, String groupName, boolean expandGroups, int maxResults, int startIndex, URI baseUri) Retrieves the groups that are direct members of the specified group.
GroupEntity	getDirectParentGroup(String applicationName, String groupName, String parentGroupName, URI baseUri) Retrieves the group that is a direct parent of the specified group.
GroupEntityList	getDirectParentGroups(String applicationName, String groupName, boolean expandGroups, int maxResults, int startIndex, URI baseUri) Retrieves the groups that are direct parents of the specified group.
UserEntity	getDirectUser(String applicationName, String groupName, String username, URI baseUri) Retrieves the user that is a direct member of the specified group.
UserEntityList	getDirectUsers(String applicationName, String groupName, boolean expandUsers, int maxResults, int startIndex, URI baseUri) Retrieves the users that are direct members of the specified group.
GroupEntity	getNestedChildGroup(String applicationName, String groupName, String childGroupName, URI baseUri) Retrieves the group that is a nested child of the specified group.
GroupEntityList	getNestedChildGroups(String applicationName, String groupName, boolean expandGroups, int maxResults, int startIndex, URI baseUri) Retrieves the groups that are nested children of the specified group.
GroupEntity	getNestedParentGroup(String applicationName, String groupName, String parentGroupName, URI baseUri) Retrieves the group that is a nested parent of the specified group.
GroupEntityList	getNestedParentGroups(String applicationName, String groupName, boolean expandGroups, int maxResults, int startIndex, URI baseUri) Retrieves the groups that are nested parents of the specified group.
UserEntity	getNestedUser(String applicationName, String groupName, String username, URI baseUri) Retrieves the user that is a nested member of the specified group.
UserEntityList	getNestedUsers(String applicationName, String groupName, boolean expandUsers, int maxResults, int startIndex, URI baseUri) Retrieves the users that are nested members of the specified group.
void	removeGroup(String applicationName, String groupName) Removes a group.
void	removeGroupAttributes(String applicationName, String groupName, String attributeName) Removes a group's attribute.
void	storeGroupAttributes(String applicationName, String groupName, MultiValuedAttributeEntityList attributes) Stores the attributes for a group.
GroupEntity	updateGroup(String applicationName, GroupEntity group, URI baseURI) Updates a group.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

getApplication

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsController

public GroupsController(ApplicationService applicationService,
                ApplicationManager applicationManager)

Method Detail

findGroupByName

public GroupEntity findGroupByName(String applicationName,
                          String name,
                          boolean expandAttributes,
                          URI baseURI)
                            throws GroupNotFoundException

Returns the group specified by the name.

Parameters:

applicationName - name of the application

name - name of the group to return

expandAttributes - should attributes be expanded

baseURI - base URI

Returns:

group

Throws:

GroupNotFoundException

addGroup

public String addGroup(String applicationName,
              GroupEntity group)
                throws ApplicationPermissionException,
                       OperationFailedException,
                       InvalidGroupException,
                       GroupNotFoundException

Adds a new group.

Parameters:

applicationName - name of the application

group - group to add

Returns:

group name just added

Throws:

ApplicationPermissionException - if none of the application's underlying directories are allowed to create a group

OperationFailedException - if the operation failed for any other reason

InvalidGroupException

GroupNotFoundException

updateGroup

public GroupEntity updateGroup(String applicationName,
                      GroupEntity group,
                      URI baseURI)
                        throws ApplicationPermissionException,
                               OperationFailedException,
                               InvalidGroupException,
                               GroupNotFoundException

Updates a group.

Parameters:

applicationName - name of the application

group - group to update

baseURI - base URI

Returns:

group

Throws:

InvalidGroupException - if the group already exists in ANY associated directory or the group template does not have the required properties populated.

OperationFailedException - underlying directory implementation failed to execute the operation.

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

GroupNotFoundException - group does not exist in any of the associated directories of the application.

removeGroup

public void removeGroup(String applicationName,
               String groupName)
                 throws ApplicationPermissionException,
                        OperationFailedException,
                        GroupNotFoundException

Removes a group.

Parameters:

applicationName - name of the application

groupName - name of the group

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

GroupNotFoundException - if group with given name does not exist in ANY assigned directory.

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.DELETE_GROUP.

storeGroupAttributes

public void storeGroupAttributes(String applicationName,
                        String groupName,
                        MultiValuedAttributeEntityList attributes)
                          throws ApplicationPermissionException,
                                 OperationFailedException,
                                 GroupNotFoundException

Stores the attributes for a group.

Parameters:

applicationName - name of the application

groupName - name of the group

attributes - attributes to add/update

Throws:

GroupNotFoundException - if the group with the supplied groupname does not exist in ANY assigned directory.

OperationFailedException - underlying directory implementation failed to execute the operation.

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP_ATTRIBUTE.

removeGroupAttributes

public void removeGroupAttributes(String applicationName,
                         String groupName,
                         String attributeName)
                           throws ApplicationPermissionException,
                                  OperationFailedException,
                                  GroupNotFoundException

Removes a group's attribute.

Parameters:

applicationName - name of the application

groupName - name of the group

attributeName - attribute to remove

Throws:

GroupNotFoundException - if the group with the supplied groupname does not exist in ANY assigned directory.

OperationFailedException - underlying directory implementation failed to execute the operation.

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP_ATTRIBUTE.

getDirectUsers

public UserEntityList getDirectUsers(String applicationName,
                            String groupName,
                            boolean expandUsers,
                            int maxResults,
                            int startIndex,
                            URI baseUri)

Retrieves the users that are direct members of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandUsers - should users be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

users that are direct members of the specified group

addDirectUser

public void addDirectUser(String applicationName,
                 String groupName,
                 String username)
                   throws ApplicationPermissionException,
                          UserNotFoundException,
                          GroupNotFoundException,
                          OperationFailedException

Adds user as direct member of group.

Parameters:

applicationName - name of the application

groupName - name of the group

username - name of the child group

Throws:

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

UserNotFoundException

GroupNotFoundException

OperationFailedException

getDirectUser

public UserEntity getDirectUser(String applicationName,
                       String groupName,
                       String username,
                       URI baseUri)
                         throws MembershipNotFoundException

Retrieves the user that is a direct member of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

username - name of the child group

baseUri - base URI

Returns:

user that is a direct member of the specified group

Throws:

MembershipNotFoundException

deleteDirectUser

public void deleteDirectUser(String applicationName,
                    String groupName,
                    String username)
                      throws ApplicationPermissionException,
                             MembershipNotFoundException,
                             UserNotFoundException,
                             GroupNotFoundException,
                             OperationFailedException

Removes the user membership.

Parameters:

applicationName - name of the application

groupName - name of the group

username - name of the user

Throws:

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

MembershipNotFoundException

UserNotFoundException

GroupNotFoundException

OperationFailedException

getNestedUsers

public UserEntityList getNestedUsers(String applicationName,
                            String groupName,
                            boolean expandUsers,
                            int maxResults,
                            int startIndex,
                            URI baseUri)

Retrieves the users that are nested members of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandUsers - should groups be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

users that are nested members of the specified group

getNestedUser

public UserEntity getNestedUser(String applicationName,
                       String groupName,
                       String username,
                       URI baseUri)
                         throws MembershipNotFoundException

Retrieves the user that is a nested member of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

username - name of the user

baseUri - base URI

Returns:

user that is a nested member of the specified group

Throws:

MembershipNotFoundException

getDirectParentGroups

public GroupEntityList getDirectParentGroups(String applicationName,
                                    String groupName,
                                    boolean expandGroups,
                                    int maxResults,
                                    int startIndex,
                                    URI baseUri)

Retrieves the groups that are direct parents of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandGroups - should groups be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

groups that are direct parents of the specified group

addDirectParentGroup

public void addDirectParentGroup(String applicationName,
                        String groupName,
                        String parentGroupName)
                          throws ApplicationPermissionException,
                                 InvalidMembershipException,
                                 GroupNotFoundException,
                                 OperationFailedException

Adds a direct parent group membership.

Parameters:

applicationName - name of the application

groupName - name of the group

parentGroupName - name of the parent group

Throws:

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

InvalidMembershipException

GroupNotFoundException

OperationFailedException

getDirectParentGroup

public GroupEntity getDirectParentGroup(String applicationName,
                               String groupName,
                               String parentGroupName,
                               URI baseUri)
                                 throws MembershipNotFoundException

Retrieves the group that is a direct parent of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

parentGroupName - name of the child group

baseUri - base URI

Returns:

group that is a direct parent of the specified group

Throws:

MembershipNotFoundException

getNestedParentGroups

public GroupEntityList getNestedParentGroups(String applicationName,
                                    String groupName,
                                    boolean expandGroups,
                                    int maxResults,
                                    int startIndex,
                                    URI baseUri)

Retrieves the groups that are nested parents of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandGroups - should groups be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

groups that are nested parents of the specified group

getNestedParentGroup

public GroupEntity getNestedParentGroup(String applicationName,
                               String groupName,
                               String parentGroupName,
                               URI baseUri)
                                 throws MembershipNotFoundException

Retrieves the group that is a nested parent of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

parentGroupName - name of the parent group

baseUri - base URI

Returns:

group that is a nested parent of the specified group

Throws:

MembershipNotFoundException

getDirectChildGroups

public GroupEntityList getDirectChildGroups(String applicationName,
                                   String groupName,
                                   boolean expandGroups,
                                   int maxResults,
                                   int startIndex,
                                   URI baseUri)

Retrieves the groups that are direct members of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandGroups - should groups be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

groups that are direct members of the specified group

addDirectChildGroup

public void addDirectChildGroup(String applicationName,
                       String groupName,
                       String childGroupName)
                         throws ApplicationPermissionException,
                                InvalidMembershipException,
                                GroupNotFoundException,
                                OperationFailedException

Adds a direct child group membership.

Parameters:

applicationName - name of the application

groupName - name of the group

childGroupName - name of the child group

Throws:

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

InvalidMembershipException

GroupNotFoundException

OperationFailedException

getDirectChildGroup

public GroupEntity getDirectChildGroup(String applicationName,
                              String groupName,
                              String childGroupName,
                              URI baseUri)
                                throws MembershipNotFoundException

Retrieves the group that is a direct child of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

childGroupName - name of the child group

baseUri - base URI

Returns:

group that is a direct child of the specified group

Throws:

MembershipNotFoundException

deleteDirectChildGroup

public void deleteDirectChildGroup(String applicationName,
                          String groupName,
                          String childGroupName)
                            throws ApplicationPermissionException,
                                   MembershipNotFoundException,
                                   GroupNotFoundException,
                                   OperationFailedException

Deletes a child group membership.

Parameters:

applicationName - name of the application

groupName - name of the group

childGroupName - name of the child group

Throws:

ApplicationPermissionException - if none of the application's associated directories are allowed to perform operations of type OperationType.UPDATE_GROUP.

MembershipNotFoundException

GroupNotFoundException

OperationFailedException

getNestedChildGroups

public GroupEntityList getNestedChildGroups(String applicationName,
                                   String groupName,
                                   boolean expandGroups,
                                   int maxResults,
                                   int startIndex,
                                   URI baseUri)

Retrieves the groups that are nested children of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

expandGroups - should groups be expanded

maxResults - maximum number of results returned. If -1, then all the results are returned.

startIndex - starting index of the results

baseUri - base URI

Returns:

groups that are nested children of the specified group

getNestedChildGroup

public GroupEntity getNestedChildGroup(String applicationName,
                              String groupName,
                              String childGroupName,
                              URI baseUri)
                                throws MembershipNotFoundException

Retrieves the group that is a nested child of the specified group.

Parameters:

applicationName - name of the application

groupName - name of the group

childGroupName - name of the child group

baseUri - base URI

Returns:

group that is a nested child of the specified group

Throws:

MembershipNotFoundException