com.atlassian.crowd.plugin.rest.service.resource
Class GroupsResource

java.lang.Object
  extended by com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
      extended by com.atlassian.crowd.plugin.rest.service.resource.GroupsResource

public class GroupsResource
extends AbstractResource


Field Summary
 
Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
DEFAULT_SEARCH_RESULT_SIZE, MAX_RESULTS_PARAM, request, START_INDEX_PARAM, uriInfo
 
Constructor Summary
GroupsResource(GroupsController groupsController, MembershipsController membershipsController)
           
 
Method Summary
 javax.ws.rs.core.Response addDirectChildGroup(String groupName, GroupEntity childGroup)
           
 javax.ws.rs.core.Response addDirectParentGroup(String groupName, GroupEntity parentGroup)
           
 javax.ws.rs.core.Response addDirectUser(String groupName, UserEntity user)
           
 javax.ws.rs.core.Response addGroup(GroupEntity restGroup)
          Adds a new group.
 javax.ws.rs.core.Response deleteDirectChildGroup(String groupName, String childGroupName)
           
 javax.ws.rs.core.Response deleteDirectUser(String groupName, String username)
           
 javax.ws.rs.core.Response deleteGroupAttribute(String groupname, String attributeName)
           
 javax.ws.rs.core.Response getDirectChildGroups(String groupName, String childGroupName, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response getDirectParentGroups(String groupName, String childGroupName, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response getDirectUsers(String groupName, String username, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response getGroup(String groupName)
           
 javax.ws.rs.core.Response getGroupAttributes(String groupName)
           
 javax.ws.rs.core.Response getMemberships()
          This method will only return XML, not JSON.
 javax.ws.rs.core.Response getNestedChildGroups(String groupName, String childGroupName, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response getNestedParentGroups(String groupName, String parentGroupName, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response getNestedUsers(String groupName, String username, int startIndex, int maxResults)
           
 javax.ws.rs.core.Response removeGroup(String groupname)
           
 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
 
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
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:
restGroup - the group to update
Throws:
GroupNotFoundException
InvalidGroupException
ApplicationPermissionException
OperationFailedException

removeGroup

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

getGroupAttributes

public javax.ws.rs.core.Response getGroupAttributes(String groupName)
                                             throws GroupNotFoundException,
                                                    OperationFailedException
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 - group attributes
Throws:
GroupNotFoundException
ApplicationPermissionException
OperationFailedException

deleteGroupAttribute

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

getDirectUsers

public javax.ws.rs.core.Response getDirectUsers(String groupName,
                                                String username,
                                                int startIndex,
                                                int maxResults)
                                         throws MembershipNotFoundException,
                                                OperationFailedException
Throws:
MembershipNotFoundException
OperationFailedException

addDirectUser

public javax.ws.rs.core.Response addDirectUser(String groupName,
                                               UserEntity user)
                                        throws GroupNotFoundException,
                                               OperationFailedException,
                                               ApplicationPermissionException
Throws:
GroupNotFoundException
OperationFailedException
ApplicationPermissionException

deleteDirectUser

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

getNestedUsers

public javax.ws.rs.core.Response getNestedUsers(String groupName,
                                                String username,
                                                int startIndex,
                                                int maxResults)
                                         throws MembershipNotFoundException,
                                                OperationFailedException
Throws:
MembershipNotFoundException
OperationFailedException

getDirectParentGroups

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

addDirectParentGroup

public javax.ws.rs.core.Response addDirectParentGroup(String groupName,
                                                      GroupEntity parentGroup)
                                               throws InvalidMembershipException,
                                                      OperationFailedException,
                                                      ApplicationPermissionException
Throws:
InvalidMembershipException
OperationFailedException
ApplicationPermissionException

getNestedParentGroups

public javax.ws.rs.core.Response getNestedParentGroups(String groupName,
                                                       String parentGroupName,
                                                       int startIndex,
                                                       int maxResults)
                                                throws MembershipNotFoundException,
                                                       OperationFailedException
Throws:
MembershipNotFoundException
OperationFailedException

getDirectChildGroups

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

addDirectChildGroup

public javax.ws.rs.core.Response addDirectChildGroup(String groupName,
                                                     GroupEntity childGroup)
                                              throws InvalidMembershipException,
                                                     ApplicationPermissionException,
                                                     OperationFailedException
Throws:
InvalidMembershipException
ApplicationPermissionException
OperationFailedException

deleteDirectChildGroup

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

getNestedChildGroups

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

getMemberships

public javax.ws.rs.core.Response getMemberships()
                                         throws GroupNotFoundException
This method will only return XML, not JSON.

Throws:
GroupNotFoundException


Copyright © 2012 Atlassian. All Rights Reserved.