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
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method 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)
Adds given permissions to group Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if given permissions were already addedjavax.ws.rs.core.Response
addPermissionsForRole(String projectKey, String role, List<String> permissionsToAdd)
Adds given permissions to role Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if all permissions were already addedjavax.ws.rs.core.Response
addPermissionsForUser(String projectKey, String username, List<String> permissionsToAdd)
Adds given permissions to user Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if given permissions were already addedboolean
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 a paged list of groupsRestGroup
for which no permissions was defined.RestPageModel<RestUser>
getAvailableUsers(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
Returns a paged list of usersRestUser
for which no permissions was defined.List<BambooPermission>
getGroupPermissions(String projectKey, String group)
List<BambooPermission>
getLoggedInPermissions(String projectKey)
List<BambooPermission>
getUserPermissions(String projectKey, String username)
default boolean
isPermissionVisible(@NotNull BambooPermission permission)
RestPageModel<RestGroupPermission>
listGroupPermissions(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
Returns a paged list of groupsRestGroupPermission
with non empty permissionsIterable<String>
listGroupsWithPermissions(String projectKey)
RestPageModel<RestRolePermission>
listRolePermissions(String projectKey, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
Returns a paged list of rolesRestRolePermission
with non empty permissionsRestPageModel<RestUserPermission>
listUserPermissions(String projectKey, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)
Returns a paged list of usersRestUserPermission
with non empty permissionsIterable<String>
listUsersWithPermissions(String projectKey)
Collection<BambooPermission>
permissionDependencies(@NotNull BambooPermission permission)
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)
Removes given permissions from group Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not presentjavax.ws.rs.core.Response
removePermissionsForRole(String projectKey, String role, List<String> permissionsToRemove)
Removes given permissions from role Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not presentjavax.ws.rs.core.Response
removePermissionsForUser(String projectKey, String username, List<String> permissionsToRemove)
Removes given permissions from user Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not presentboolean
removeUserPermissions(String projectKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>
supportedPermissions()
Set<String>
supportedRoles()
-
-
-
Method Detail
-
listUserPermissions
public RestPageModel<RestUserPermission> listUserPermissions(String projectKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
Description copied from interface:PermissionsResource
Returns a paged list of usersRestUserPermission
with non empty permissions- Specified by:
listUserPermissions
in interfacePermissionsResource
-
addPermissionsForUser
public javax.ws.rs.core.Response addPermissionsForUser(String projectKey, String username, List<String> permissionsToAdd)
Description copied from interface:PermissionsResource
Adds given permissions to user Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if given permissions were already added- Specified by:
addPermissionsForUser
in interfacePermissionsResource
-
removePermissionsForUser
public javax.ws.rs.core.Response removePermissionsForUser(String projectKey, String username, List<String> permissionsToRemove)
Description copied from interface:PermissionsResource
Removes given permissions from user Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not present- Specified by:
removePermissionsForUser
in interfacePermissionsResource
-
getAvailableUsers
public RestPageModel<RestUser> getAvailableUsers(String projectKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
Description copied from interface:PermissionsResource
Returns a paged list of usersRestUser
for which no permissions was defined. Allows to filter by user name- Specified by:
getAvailableUsers
in interfacePermissionsResource
-
listGroupPermissions
public RestPageModel<RestGroupPermission> listGroupPermissions(String projectKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
Description copied from interface:PermissionsResource
Returns a paged list of groupsRestGroupPermission
with non empty permissions- Specified by:
listGroupPermissions
in interfacePermissionsResource
-
addPermissionsForGroup
public javax.ws.rs.core.Response addPermissionsForGroup(String projectKey, String group, List<String> permissionsToAdd)
Description copied from interface:PermissionsResource
Adds given permissions to group Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if given permissions were already added- Specified by:
addPermissionsForGroup
in interfacePermissionsResource
-
removePermissionsForGroup
public javax.ws.rs.core.Response removePermissionsForGroup(String projectKey, String group, List<String> permissionsToRemove)
Description copied from interface:PermissionsResource
Removes given permissions from group Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not present- Specified by:
removePermissionsForGroup
in interfacePermissionsResource
-
getAvailableGroups
public RestPageModel<RestGroup> getAvailableGroups(String projectKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
Description copied from interface:PermissionsResource
Returns a paged list of groupsRestGroup
for which no permissions was defined. Allows to filter by group name- Specified by:
getAvailableGroups
in interfacePermissionsResource
-
listRolePermissions
public RestPageModel<RestRolePermission> listRolePermissions(String projectKey, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
Description copied from interface:PermissionsResource
Returns a paged list of rolesRestRolePermission
with non empty permissions- Specified by:
listRolePermissions
in interfacePermissionsResource
-
addPermissionsForRole
public javax.ws.rs.core.Response addPermissionsForRole(String projectKey, String role, List<String> permissionsToAdd)
Description copied from interface:PermissionsResource
Adds given permissions to role Returns status code 204Response.Status.NO_CONTENT
if any permission was added or status code 304Response.Status.NOT_MODIFIED
if all permissions were already added- Specified by:
addPermissionsForRole
in interfacePermissionsResource
-
removePermissionsForRole
public javax.ws.rs.core.Response removePermissionsForRole(String projectKey, String role, List<String> permissionsToRemove)
Description copied from interface:PermissionsResource
Removes given permissions from role Returns status code 204Response.Status.NO_CONTENT
if any permission was removed or status code 304Response.Status.NOT_MODIFIED
if given permissions were not present- Specified by:
removePermissionsForRole
in interfacePermissionsResource
-
supportedPermissions
public Collection<BambooPermission> supportedPermissions()
-
permissionDependencies
public Collection<BambooPermission> permissionDependencies(@NotNull @NotNull BambooPermission permission)
-
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)
-
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)
-
isPermissionVisible
public default boolean isPermissionVisible(@NotNull @NotNull BambooPermission permission)
-
-