com.atlassian.bamboo.plugins.rest.permission

Class GlobalPermissionsResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.permission.GlobalPermissionsResource

All Implemented Interfaces:

PermissionsResource

public class GlobalPermissionsResource
extends Object
implements PermissionsResource

REST endpoint to manage user/group global permissions in Bamboo.

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 ignore, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissions(String ignore, List<BambooPermission> permissionsToAdd)
javax.ws.rs.core.Response	addPermissionsForGroup(String ignore, String group, List<String> permissionsToAdd) Grants global permissions to a given group.
javax.ws.rs.core.Response	addPermissionsForRole(String ignore, String role, List<String> permissionsToAdd) Grants global permissions to a given role.
javax.ws.rs.core.Response	addPermissionsForUser(String ignore, String username, List<String> permissionsToAdd) Grants global permissions to a given user.
boolean	addUserPermissions(String ignore, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissions(String key)
RestPageModel<RestGroup>	getAvailableGroups(String ignore, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Returns list of groups which weren't granted explicitly any permissions.
RestPageModel<RestUser>	getAvailableUsers(String ignore, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Returns list of users which weren't granted explicitly any permissions.
List<BambooPermission>	getGroupPermissions(String ignore, String group)
List<BambooPermission>	getLoggedInPermissions(String ignore)
List<BambooPermission>	getUserPermissions(String ignore, String username)
RestPageModel<RestGroupPermission>	listGroupPermissions(String ignore, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of groups with their global permissions.
Iterable<String>	listGroupsWithPermissions(String ignore)
RestPageModel<RestRolePermission>	listRolePermissions(String ignore, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of roles with their global permissions.
RestPageModel<RestUserPermission>	listUserPermissions(String ignore, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a list of users with their global permissions.
Iterable<String>	listUsersWithPermissions(String ignore)
boolean	removeAnonymousPermissions(String key)
boolean	removeGroupPermissions(String ignore, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissions(String ignore, List<BambooPermission> permissionsToRemove)
javax.ws.rs.core.Response	removePermissionsForGroup(String ignore, String group, List<String> permissionsToRemove) Revokes global permissions from a given group.
javax.ws.rs.core.Response	removePermissionsForRole(String ignore, String role, List<String> permissionsToRemove) Revokes global permissions from a given role.
javax.ws.rs.core.Response	removePermissionsForUser(String ignore, String username, List<String> permissionsToRemove) Revokes global permissions from a given user.
boolean	removeUserPermissions(String ignore, 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 ignore,
                                                             String nameFilter,
                                                             @Context
                                                             PageRequest pageRequest,
                                                             @Context
                                                             Expansion expansion,
                                                             @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve a list of users with their global permissions. 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:

ignore - parameter not used, can be ignored

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 ignore,
                                                       String username,
                                                       @RequestBody
                                                       List<String> permissionsToAdd)

Grants global permissions to a given user.

Specified by:

addPermissionsForUser in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

username - username of the affected user

permissionsToAdd - permission names to grant

removePermissionsForUser

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

Revokes global permissions from a given user.

Specified by:

removePermissionsForUser in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

username - username of the affected user

permissionsToRemove - permission names to be revoked

getAvailableUsers

public RestPageModel<RestUser> getAvailableUsers(String ignore,
                                                 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 permissions. Resource is paged, returns single page of resources.

Specified by:

getAvailableUsers in interface PermissionsResource

Parameters:

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

ignore - parameter not used, can be ignored

listGroupPermissions

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

Retrieve a list of groups with their global 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:

ignore - parameter not used, can be ignored

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 ignore,
                                                        String group,
                                                        @RequestBody
                                                        List<String> permissionsToAdd)

Grants global permissions to a given group.

Specified by:

addPermissionsForGroup in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

group - affected group

permissionsToAdd - permission names to grant

removePermissionsForGroup

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

Revokes global permissions from a given group.

Specified by:

removePermissionsForGroup in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

group - affected group

permissionsToRemove - permission names to be revoked

getAvailableGroups

public RestPageModel<RestGroup> getAvailableGroups(String ignore,
                                                   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 permissions. Resource is paged, returns single page of resources.

Specified by:

getAvailableGroups in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

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 ignore,
                                                             @Context
                                                             PageRequest pageRequest,
                                                             @Context
                                                             Expansion expansion,
                                                             @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve a list of roles with their global 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:

ignore - parameter not used, can be ignored

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 ignore,
                                                       String role,
                                                       @RequestBody
                                                       List<String> permissionsToAdd)

Grants global permissions to a given role.

Specified by:

addPermissionsForRole in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

role - affected role

permissionsToAdd - permission names to grant

removePermissionsForRole

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

Revokes global permissions from a given role.

Specified by:

removePermissionsForRole in interface PermissionsResource

Parameters:

ignore - parameter not used, can be ignored

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 ignore)

getUserPermissions

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

addUserPermissions

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

removeUserPermissions

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

listGroupsWithPermissions

public Iterable<String> listGroupsWithPermissions(String ignore)

getGroupPermissions

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

addGroupPermissions

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

removeGroupPermissions

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

getLoggedInPermissions

public List<BambooPermission> getLoggedInPermissions(String ignore)

addLoggedInPermissions

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

removeLoggedInPermissions

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

getAnonymousPermissions

public List<BambooPermission> getAnonymousPermissions(String key)

addAnonymousPermissions

public boolean addAnonymousPermissions(String key)

removeAnonymousPermissions

public boolean removeAnonymousPermissions(String key)