Package com.atlassian.bamboo.plugins.rest.permission

Class PlanPermissionsResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.permission.PlanPermissionsResource

All Implemented Interfaces:

PermissionsResource

@Path("permissions/plan")
@Produces("application/json")
@Consumes("application/json")
public class PlanPermissionsResource
extends Object
implements PermissionsResource

REST endpoint to manage user/group plan 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	Description
boolean	addAnonymousPermissions(String key)
boolean	addGroupPermissions(String planKey, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissions(String planKey, List<BambooPermission> permissionsToAdd)
javax.ws.rs.core.Response	addPermissionsForGroup(String planKey, String group, List<String> permissionsToAdd)	Adds given permissions to group Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added
javax.ws.rs.core.Response	addPermissionsForRole(String planKey, String role, List<String> permissionsToAdd)	Adds given permissions to role Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if all permissions were already added
javax.ws.rs.core.Response	addPermissionsForUser(String planKey, String username, List<String> permissionsToAdd)	Adds given permissions to user Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added
boolean	addUserPermissions(String planKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissions(String planKey)
RestPageModel<RestGroup>	getAvailableGroups(String planKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns a paged list of groups RestGroup for which no permissions was defined.
RestPageModel<RestUser>	getAvailableUsers(String planKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns a paged list of users RestUser for which no permissions was defined.
List<BambooPermission>	getGroupPermissions(String planKey, String group)
List<BambooPermission>	getLoggedInPermissions(String planKey)
List<BambooPermission>	getUserPermissions(String planKey, String username)
default boolean	isPermissionVisible(@NotNull BambooPermission permission)
RestPageModel<RestGroupPermission>	listGroupPermissions(String planKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns a paged list of groups RestGroupPermission with non empty permissions
Iterable<String>	listGroupsWithPermissions(String planKey)
RestPageModel<RestRolePermission>	listRolePermissions(String planKey, PageRequest pageRequest, ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns a paged list of roles RestRolePermission with non empty permissions
RestPageModel<RestUserPermission>	listUserPermissions(String planKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns a paged list of users RestUserPermission with non empty permissions
Iterable<String>	listUsersWithPermissions(String planKey)
Collection<BambooPermission>	permissionDependencies(@NotNull BambooPermission permission)
boolean	removeAnonymousPermissions(String key)
boolean	removeGroupPermissions(String planKey, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissions(String planKey, List<BambooPermission> permissionsToRemove)
javax.ws.rs.core.Response	removePermissionsForGroup(String planKey, String group, List<String> permissionsToRemove)	Removes given permissions from group Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
javax.ws.rs.core.Response	removePermissionsForRole(String planKey, String role, List<String> permissionsToRemove)	Removes given permissions from role Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
javax.ws.rs.core.Response	removePermissionsForUser(String planKey, String username, List<String> permissionsToRemove)	Removes given permissions from user Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
boolean	removeUserPermissions(String planKey, 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 Details

listUserPermissions

@GET
@Path("{key}/users")
public RestPageModel<RestUserPermission> listUserPermissions(@PathParam("key")
 String planKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of users RestUserPermission with non empty permissions

Specified by:

listUserPermissions in interface PermissionsResource

addPermissionsForUser

@PUT
@Path("{key}/users/{name : (.+)?}")
public javax.ws.rs.core.Response addPermissionsForUser(@PathParam("key")
 String planKey,
 @PathParam("name")
 String username,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to user Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added

Specified by:

addPermissionsForUser in interface PermissionsResource

removePermissionsForUser

@DELETE
@Path("{key}/users/{name : (.+)?}")
public javax.ws.rs.core.Response removePermissionsForUser(@PathParam("key")
 String planKey,
 @PathParam("name")
 String username,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from user Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForUser in interface PermissionsResource

getAvailableUsers

@GET
@Path("{key}/available-users")
public RestPageModel<RestUser> getAvailableUsers(@PathParam("key")
 String planKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of users RestUser for which no permissions was defined. Allows to filter by user name

Specified by:

getAvailableUsers in interface PermissionsResource

listGroupPermissions

@GET
@Path("{key}/groups")
public RestPageModel<RestGroupPermission> listGroupPermissions(@PathParam("key")
 String planKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of groups RestGroupPermission with non empty permissions

Specified by:

listGroupPermissions in interface PermissionsResource

addPermissionsForGroup

@PUT
@Path("{key}/groups/{name : (.+)?}")
public javax.ws.rs.core.Response addPermissionsForGroup(@PathParam("key")
 String planKey,
 @PathParam("name")
 String group,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to group Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added

Specified by:

addPermissionsForGroup in interface PermissionsResource

removePermissionsForGroup

@DELETE
@Path("{key}/groups/{name : (.+)?}")
public javax.ws.rs.core.Response removePermissionsForGroup(@PathParam("key")
 String planKey,
 @PathParam("name")
 String group,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from group Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForGroup in interface PermissionsResource

getAvailableGroups

@GET
@Path("{key}/available-groups")
public RestPageModel<RestGroup> getAvailableGroups(@PathParam("key")
 String planKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of groups RestGroup for which no permissions was defined. Allows to filter by group name

Specified by:

getAvailableGroups in interface PermissionsResource

listRolePermissions

@GET
@Path("{key}/roles")
public RestPageModel<RestRolePermission> listRolePermissions(@PathParam("key")
 String planKey,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of roles RestRolePermission with non empty permissions

Specified by:

listRolePermissions in interface PermissionsResource

addPermissionsForRole

@PUT
@Path("{key}/roles/{name : (.+)?}")
public javax.ws.rs.core.Response addPermissionsForRole(@PathParam("key")
 String planKey,
 @PathParam("name")
 String role,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to role Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if all permissions were already added

Specified by:

addPermissionsForRole in interface PermissionsResource

removePermissionsForRole

@DELETE
@Path("{key}/roles/{name : (.+)?}")
public javax.ws.rs.core.Response removePermissionsForRole(@PathParam("key")
 String planKey,
 @PathParam("name")
 String role,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from role Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForRole in interface PermissionsResource

supportedRoles

public Set<String> supportedRoles()

supportedPermissions

public Collection<BambooPermission> supportedPermissions()

permissionDependencies

public Collection<BambooPermission> permissionDependencies(@NotNull
 @NotNull BambooPermission permission)

listUsersWithPermissions

public Iterable<String> listUsersWithPermissions(String planKey)

getUserPermissions

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

addUserPermissions

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

removeUserPermissions

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

listGroupsWithPermissions

public Iterable<String> listGroupsWithPermissions(String planKey)

getGroupPermissions

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

addGroupPermissions

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

removeGroupPermissions

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

getLoggedInPermissions

public List<BambooPermission> getLoggedInPermissions(String planKey)

addLoggedInPermissions

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

removeLoggedInPermissions

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

getAnonymousPermissions

public List<BambooPermission> getAnonymousPermissions(String planKey)

addAnonymousPermissions

public boolean addAnonymousPermissions(String key)

removeAnonymousPermissions

public boolean removeAnonymousPermissions(String key)

isPermissionVisible

default boolean isPermissionVisible(@NotNull
 @NotNull BambooPermission permission)