GroupsResource (Atlassian Crowd 2.1.0-beta2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  com.atlassian.crowd.plugin.rest.service.resources.AbstractResource
      com.atlassian.crowd.plugin.rest.service.resources.GroupsResource

public class GroupsResource
extends AbstractResource
extends AbstractResource

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resources.AbstractResource
`DEFAULT_SEARCH_RESULT_SIZE, MAX_RESULTS_PARAM, request, START_INDEX_PARAM, uriInfo`

Constructor Summary
`GroupsResource(GroupsController groupsController)`

Method Summary
`javax.ws.rs.core.Response`	`addDirectChildGroup(java.lang.String groupName, GroupEntity childGroup)`
`javax.ws.rs.core.Response`	`addDirectParentGroup(java.lang.String groupName, GroupEntity parentGroup)`
`javax.ws.rs.core.Response`	`addDirectUser(java.lang.String groupName, UserEntity user)`
`javax.ws.rs.core.Response`	`addGroup(GroupEntity restGroup)` Example POST document to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <group> <name>crowd-administrators</name> <active>true</active> <description>Group Description</description> <type>GROUP</type> </group>
`javax.ws.rs.core.Response`	`deleteDirectChildGroup(java.lang.String groupName, java.lang.String childGroupName)`
`javax.ws.rs.core.Response`	`deleteDirectUser(java.lang.String groupName, java.lang.String username)`
`javax.ws.rs.core.Response`	`deleteGroupAttribute(java.lang.String groupname, java.lang.String attributeName)`
`javax.ws.rs.core.Response`	`getDirectChildGroups(java.lang.String groupName, java.lang.String childGroupName, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`getDirectParentGroups(java.lang.String groupName, java.lang.String childGroupName, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`getDirectUsers(java.lang.String groupName, java.lang.String username, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`getGroup(java.lang.String groupName)`
`javax.ws.rs.core.Response`	`getGroupAttributes(java.lang.String groupName)`
`javax.ws.rs.core.Response`	`getNestedChildGroups(java.lang.String groupName, java.lang.String childGroupName, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`getNestedParentGroups(java.lang.String groupName, java.lang.String parentGroupName, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`getNestedUsers(java.lang.String groupName, java.lang.String username, int startIndex, int maxResults)`
`javax.ws.rs.core.Response`	`removeGroup(java.lang.String groupname)`
`javax.ws.rs.core.Response`	`storeGroupAttributes(java.lang.String groupname, AttributeEntityList attributes)` Example POST command to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group/crowd-administrators/attribute `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <attributes> <attribute key="pet"> <values> <value>dog</value> <value>cat</value> <value>bird</value> </values> </attribute> </attributes>`
`javax.ws.rs.core.Response`	`updateGroup(java.lang.String groupName, GroupEntity restGroup)` Example PUT document to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group/crowd-administrators <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <group> <name>crowd-administrators</name> <active>true</active> <description>Updated Group Description</description> <type>GROUP</type> </group>

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resources.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)

Method Detail

getGroup

public javax.ws.rs.core.Response getGroup(java.lang.String groupName)
                                   throws OperationFailedException

Throws:: OperationFailedException

addGroup

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

Example POST document to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<group>
  <name>crowd-administrators</name>
  <active>true</active>
  <description>Group Description</description>
  <type>GROUP</type>
</group>

Parameters:: restGroup - the group to create
Returns:
Throws:: ApplicationPermissionException; OperationFailedException

updateGroup

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

Example PUT document to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group/crowd-administrators

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<group>
  <name>crowd-administrators</name>
  <active>true</active>
  <description>Updated Group Description</description>
  <type>GROUP</type>
</group>

Parameters:: restGroup - the group to update
Returns:
Throws:: ApplicationPermissionException; OperationFailedException

removeGroup

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

Throws:: ApplicationPermissionException; OperationFailedException

getGroupAttributes

public javax.ws.rs.core.Response getGroupAttributes(java.lang.String groupName)
                                             throws OperationFailedException

Throws:: OperationFailedException

storeGroupAttributes

public javax.ws.rs.core.Response storeGroupAttributes(java.lang.String groupname,
                                                      AttributeEntityList attributes)
                                               throws ApplicationPermissionException,
                                                      OperationFailedException

Example POST command to the URL: http://localhost:8095/crowd/rest/service/latest/{applicationName}/group/crowd-administrators/attribute

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <attributes> <attribute key="pet"> <values> <value>dog</value> <value>cat</value> <value>bird</value> </values> </attribute> </attributes>

Parameters:: groupname -; attributes -
Returns:
Throws:: ApplicationPermissionException; OperationFailedException

deleteGroupAttribute

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

Throws:: ApplicationPermissionException; OperationFailedException

getDirectUsers

public javax.ws.rs.core.Response getDirectUsers(java.lang.String groupName,
                                                java.lang.String username,
                                                int startIndex,
                                                int maxResults)
                                         throws OperationFailedException

Throws:: OperationFailedException

addDirectUser

public javax.ws.rs.core.Response addDirectUser(java.lang.String groupName,
                                               UserEntity user)
                                        throws OperationFailedException,
                                               ApplicationPermissionException

Throws:: OperationFailedException; ApplicationPermissionException

deleteDirectUser

public javax.ws.rs.core.Response deleteDirectUser(java.lang.String groupName,
                                                  java.lang.String username)
                                           throws OperationFailedException,
                                                  ApplicationPermissionException

Throws:: OperationFailedException; ApplicationPermissionException

getNestedUsers

public javax.ws.rs.core.Response getNestedUsers(java.lang.String groupName,
                                                java.lang.String username,
                                                int startIndex,
                                                int maxResults)
                                         throws OperationFailedException

Throws:: OperationFailedException

getDirectParentGroups

public javax.ws.rs.core.Response getDirectParentGroups(java.lang.String groupName,
                                                       java.lang.String childGroupName,
                                                       int startIndex,
                                                       int maxResults)
                                                throws OperationFailedException

Throws:: OperationFailedException

addDirectParentGroup

public javax.ws.rs.core.Response addDirectParentGroup(java.lang.String groupName,
                                                      GroupEntity parentGroup)
                                               throws OperationFailedException,
                                                      ApplicationPermissionException

Throws:: OperationFailedException; ApplicationPermissionException

getNestedParentGroups

public javax.ws.rs.core.Response getNestedParentGroups(java.lang.String groupName,
                                                       java.lang.String parentGroupName,
                                                       int startIndex,
                                                       int maxResults)
                                                throws OperationFailedException

Throws:: OperationFailedException

getDirectChildGroups

public javax.ws.rs.core.Response getDirectChildGroups(java.lang.String groupName,
                                                      java.lang.String childGroupName,
                                                      int startIndex,
                                                      int maxResults)
                                               throws OperationFailedException

Throws:: OperationFailedException

addDirectChildGroup

public javax.ws.rs.core.Response addDirectChildGroup(java.lang.String groupName,
                                                     GroupEntity childGroup)
                                              throws OperationFailedException,
                                                     ApplicationPermissionException

Throws:: OperationFailedException; ApplicationPermissionException

deleteDirectChildGroup

public javax.ws.rs.core.Response deleteDirectChildGroup(java.lang.String groupName,
                                                        java.lang.String childGroupName)
                                                 throws OperationFailedException,
                                                        ApplicationPermissionException

Throws:: OperationFailedException; ApplicationPermissionException

getNestedChildGroups

public javax.ws.rs.core.Response getNestedChildGroups(java.lang.String groupName,
                                                      java.lang.String childGroupName,
                                                      int startIndex,
                                                      int maxResults)
                                               throws OperationFailedException

Throws:: OperationFailedException