com.atlassian.bamboo.plugins.rest.permission

Class ProjectPlanPermissionsResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.permission.ProjectPlanPermissionsResource

All Implemented Interfaces:

PermissionsResource

public class ProjectPlanPermissionsResource
extends Object
implements PermissionsResource

REST endpoint to manage user/group project plan permissions in Bamboo. Project plan permission is permission applied on project and defines base permissions for plans in that project. Additional permission for given plans can be applied on a plan level.

Since:

6.2

Field Summary

Fields inherited from interface com.atlassian.bamboo.plugins.rest.permission.PermissionsResource

ROLE_ANONYMOUS, ROLE_LOGGED_IN

Method Summary

Modifier and Type	Method and Description
boolean	addAnonymousPermissions(String key)
boolean	addGroupPermissions(String projectKey, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissions(String projectKey, List<BambooPermission> permissionsToAdd)
javax.ws.rs.core.Response	addPermissionsForGroup(String projectKey, String group, List<String> permissionsToAdd) Grants project plan permissions to a given group.
javax.ws.rs.core.Response	addPermissionsForRole(String projectKey, String role, List<String> permissionsToAdd) Grants project plan permissions to a given role.
javax.ws.rs.core.Response	addPermissionsForUser(String projectKey, String username, List<String> permissionsToAdd) Grants project plan permissions to a given user.
boolean	addUserPermissions(String projectKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissions(String projectKey)
RestPageModel<RestGroup>	getAvailableGroups(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Returns list of groups which weren't granted explicitly any project plan permissions.
RestPageModel<RestUser>	getAvailableUsers(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Returns list of users which weren't granted explicitly any project plan permissions.
List<BambooPermission>	getGroupPermissions(String projectKey, String group)
List<BambooPermission>	getLoggedInPermissions(String projectKey)
List<BambooPermission>	getUserPermissions(String projectKey, String username)
RestPageModel<RestGroupPermission>	listGroupPermissions(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of groups with their project plan permissions.
Iterable<String>	listGroupsWithPermissions(String projectKey)
RestPageModel<RestRolePermission>	listRolePermissions(String projectKey, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of roles with their project plan permissions.
RestPageModel<RestUserPermission>	listUserPermissions(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of users with their explicit permissions to given resource.
Iterable<String>	listUsersWithPermissions(String projectKey)
boolean	removeAnonymousPermissions(String key)
boolean	removeGroupPermissions(String projectKey, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissions(String projectKey, List<BambooPermission> permissionsToRemove)
javax.ws.rs.core.Response	removePermissionsForGroup(String projectKey, String group, List<String> permissionsToRemove) Revokes project plan permissions from a given group.
javax.ws.rs.core.Response	removePermissionsForRole(String projectKey, String role, List<String> permissionsToRemove) Revokes project plan permissions from a given role.
javax.ws.rs.core.Response	removePermissionsForUser(String projectKey, String username, List<String> permissionsToRemove) Revokes project plan permissions from a given user.
boolean	removeUserPermissions(String projectKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions()
Set<String>	supportedRoles()

Methods inherited from class java.lang.Object

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

Method Detail

listUserPermissions

public RestPageModel<RestUserPermission> listUserPermissions(String projectKey,
                                                             String nameFilter,
                                                             @Context
                                                             PageRequest pageRequest,
                                                             @Context
                                                             Expansion expansion,
                                                             @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.

Specified by:

listUserPermissions in interface PermissionsResource

Parameters:

projectKey - project entity key

nameFilter - user filter, filter is case insensitive matches: username, user's full name, user's email

pageRequest - represents the params that define which page the request is after

expansion - ignored

uriInfo - ignored

Returns:

a list of user's permissions

addPermissionsForUser

public javax.ws.rs.core.Response addPermissionsForUser(String projectKey,
                                                       String username,
                                                       @RequestBody
                                                       List<String> permissionsToAdd)

Grants project plan permissions to a given user.

Specified by:

addPermissionsForUser in interface PermissionsResource

Parameters:

projectKey - project entity key

username - username of the affected user

permissionsToAdd - permission names to grant

removePermissionsForUser

public javax.ws.rs.core.Response removePermissionsForUser(String projectKey,
                                                          String username,
                                                          @RequestBody
                                                          List<String> permissionsToRemove)

Revokes project plan permissions from a given user.

Specified by:

removePermissionsForUser in interface PermissionsResource

Parameters:

projectKey - project entity key

username - username of the affected user

permissionsToRemove - permission names to be revoked

getAvailableUsers

public RestPageModel<RestUser> getAvailableUsers(String projectKey,
                                                 String nameFilter,
                                                 @Context
                                                 PageRequest pageRequest,
                                                 @Context
                                                 Expansion expansion,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)

Returns list of users which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources.

Specified by:

getAvailableUsers in interface PermissionsResource

Parameters:

projectKey - project entity key

nameFilter - user filter, filter is case insensitive matches: username, user's full name, user's email

pageRequest - represents the params that define which page the request is after

expansion - ignored

uriInfo - ignored

listGroupPermissions

public RestPageModel<RestGroupPermission> listGroupPermissions(String projectKey,
                                                               String nameFilter,
                                                               @Context
                                                               PageRequest pageRequest,
                                                               @Context
                                                               Expansion expansion,
                                                               @Context
                                                               javax.ws.rs.core.UriInfo uriInfo)

Retrieve a list of groups with their project plan permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.

Specified by:

listGroupPermissions in interface PermissionsResource

Parameters:

projectKey - project entity key

nameFilter - group name filter, filter is case insensitive matches group name

pageRequest - represents the params that define which page the request is after

expansion - ignored

uriInfo - ignored

Returns:

a list of groups's permissions

addPermissionsForGroup

public javax.ws.rs.core.Response addPermissionsForGroup(String projectKey,
                                                        String group,
                                                        @RequestBody
                                                        List<String> permissionsToAdd)

Grants project plan permissions to a given group.

Specified by:

addPermissionsForGroup in interface PermissionsResource

Parameters:

projectKey - project entity key

group - affected group

permissionsToAdd - permission names to grant

removePermissionsForGroup

public javax.ws.rs.core.Response removePermissionsForGroup(String projectKey,
                                                           String group,
                                                           @RequestBody
                                                           List<String> permissionsToRemove)

Revokes project plan permissions from a given group.

Specified by:

removePermissionsForGroup in interface PermissionsResource

Parameters:

projectKey - project entity key

group - affected group

permissionsToRemove - permission names to be revoked

getAvailableGroups

public RestPageModel<RestGroup> getAvailableGroups(String projectKey,
                                                   String nameFilter,
                                                   @Context
                                                   PageRequest pageRequest,
                                                   @Context
                                                   Expansion expansion,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)

Returns list of groups which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources.

Specified by:

getAvailableGroups in interface PermissionsResource

Parameters:

projectKey - project entity key

nameFilter - group name filter, filter is case insensitive matches group name

pageRequest - represents the params that define which page the request is after

expansion - ignored

uriInfo - ignored

listRolePermissions

public RestPageModel<RestRolePermission> listRolePermissions(String projectKey,
                                                             @Context
                                                             PageRequest pageRequest,
                                                             @Context
                                                             Expansion expansion,
                                                             @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve a list of roles with their project plan permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users

Specified by:

listRolePermissions in interface PermissionsResource

Parameters:

projectKey - project entity key

pageRequest - represents the params that define which page the request is after

expansion - ignored

uriInfo - ignored

Returns:

a list of roles's permissions

addPermissionsForRole

public javax.ws.rs.core.Response addPermissionsForRole(String projectKey,
                                                       String role,
                                                       @RequestBody
                                                       List<String> permissionsToAdd)

Grants project plan permissions to a given role.

Specified by:

addPermissionsForRole in interface PermissionsResource

Parameters:

projectKey - project entity key

role - affected role

permissionsToAdd - permission names to grant

removePermissionsForRole

public javax.ws.rs.core.Response removePermissionsForRole(String projectKey,
                                                          String role,
                                                          @RequestBody
                                                          List<String> permissionsToRemove)

Revokes project plan permissions from a given role.

Specified by:

removePermissionsForRole in interface PermissionsResource

Parameters:

projectKey - project entity key

role - affected role

permissionsToRemove - permission names to be revoked

supportedRoles

public Set<String> supportedRoles()

supportedPermissions

public Collection<BambooPermission> supportedPermissions()

listUsersWithPermissions

public Iterable<String> listUsersWithPermissions(String projectKey)

getUserPermissions

public List<BambooPermission> getUserPermissions(String projectKey,
                                                 String username)

addUserPermissions

public boolean addUserPermissions(String projectKey,
                                  String username,
                                  List<BambooPermission> permissionsToAdd)

removeUserPermissions

public boolean removeUserPermissions(String projectKey,
                                     String username,
                                     List<BambooPermission> permissionsToRemove)

listGroupsWithPermissions

public Iterable<String> listGroupsWithPermissions(String projectKey)

getGroupPermissions

public List<BambooPermission> getGroupPermissions(String projectKey,
                                                  String group)

addGroupPermissions

public boolean addGroupPermissions(String projectKey,
                                   String group,
                                   List<BambooPermission> permissionsToAdd)

removeGroupPermissions

public boolean removeGroupPermissions(String projectKey,
                                      String group,
                                      List<BambooPermission> permissionsToRemove)

getLoggedInPermissions

public List<BambooPermission> getLoggedInPermissions(String projectKey)

addLoggedInPermissions

public boolean addLoggedInPermissions(String projectKey,
                                      List<BambooPermission> permissionsToAdd)

removeLoggedInPermissions

public boolean removeLoggedInPermissions(String projectKey,
                                         List<BambooPermission> permissionsToRemove)

getAnonymousPermissions

public List<BambooPermission> getAnonymousPermissions(String projectKey)

addAnonymousPermissions

public boolean addAnonymousPermissions(String key)

removeAnonymousPermissions

public boolean removeAnonymousPermissions(String key)