com.atlassian.bamboo.project

Interface ProjectPlanPermissionsService

All Known Implementing Classes:

DefaultProjectPlanPermissionsService

@ExperimentalApi
public interface ProjectPlanPermissionsService

Service to manage project plan permissions.

Since:

6.2.0

Method Summary

Modifier and Type	Method and Description
boolean	addAnonymousPermissionsToPlan(String planKey)
boolean	addGroupPermissionsToProjectPlan(String projectKey, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissionsToProjectPlan(String projectKey, List<BambooPermission> permissionsToAdd)
boolean	addUserPermissionsToProjectPlan(String projectKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissionsForProjectPlan(String projectKey)
List<BambooPermission>	getGroupPermissionsForProjectPlan(String projectKey, String group)
List<BambooPermission>	getLoggedInPermissionsForProjectPlan(String projectKey)
List<BambooPermission>	getUserPermissionsForProjectPlan(String projectKey, String username)
Iterable<String>	listGroupsWithPermissionsForProjectPlan(String projectKey)
Iterable<String>	listUsersWithPermissionsForProjectPlan(String projectKey)
Collection<BambooPermission>	permissionDependencies(BambooPermission permission) Obtain a collection of Bamboo permissions dependent on the passed permission.
boolean	removeAnonymousPermissionsFromPlan(String planKey)
boolean	removeGroupPermissionsFromProjectPlan(String projectKey, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissionsFromProjectPlan(String projectKey, List<BambooPermission> permissionsToRemove)
boolean	removeUserPermissionsFromProjectPlan(String projectKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions() Collection of permissions configurable on projects to apply to all contained plans.

Method Detail

listUsersWithPermissionsForProjectPlan

@NotNull
Iterable<String> listUsersWithPermissionsForProjectPlan(@NotNull
                                                                 String projectKey)

getUserPermissionsForProjectPlan

@NotNull
List<BambooPermission> getUserPermissionsForProjectPlan(@NotNull
                                                                 String projectKey,
                                                                 @NotNull
                                                                 String username)

addUserPermissionsToProjectPlan

boolean addUserPermissionsToProjectPlan(@NotNull
                                        String projectKey,
                                        @NotNull
                                        String username,
                                        @NotNull
                                        List<BambooPermission> permissionsToAdd)

removeUserPermissionsFromProjectPlan

boolean removeUserPermissionsFromProjectPlan(@NotNull
                                             String projectKey,
                                             @NotNull
                                             String username,
                                             @NotNull
                                             List<BambooPermission> permissionsToRemove)

listGroupsWithPermissionsForProjectPlan

@NotNull
Iterable<String> listGroupsWithPermissionsForProjectPlan(@NotNull
                                                                  String projectKey)

getGroupPermissionsForProjectPlan

@NotNull
List<BambooPermission> getGroupPermissionsForProjectPlan(@NotNull
                                                                  String projectKey,
                                                                  @NotNull
                                                                  String group)

addGroupPermissionsToProjectPlan

boolean addGroupPermissionsToProjectPlan(@NotNull
                                         String projectKey,
                                         @NotNull
                                         String group,
                                         @NotNull
                                         List<BambooPermission> permissionsToAdd)

removeGroupPermissionsFromProjectPlan

boolean removeGroupPermissionsFromProjectPlan(@NotNull
                                              String projectKey,
                                              @NotNull
                                              String group,
                                              @NotNull
                                              List<BambooPermission> permissionsToRemove)

getLoggedInPermissionsForProjectPlan

@NotNull
List<BambooPermission> getLoggedInPermissionsForProjectPlan(@NotNull
                                                                     String projectKey)

addLoggedInPermissionsToProjectPlan

boolean addLoggedInPermissionsToProjectPlan(@NotNull
                                            String projectKey,
                                            @NotNull
                                            List<BambooPermission> permissionsToAdd)

removeLoggedInPermissionsFromProjectPlan

boolean removeLoggedInPermissionsFromProjectPlan(@NotNull
                                                 String projectKey,
                                                 @NotNull
                                                 List<BambooPermission> permissionsToRemove)

getAnonymousPermissionsForProjectPlan

@NotNull
List<BambooPermission> getAnonymousPermissionsForProjectPlan(@NotNull
                                                                      String projectKey)

addAnonymousPermissionsToPlan

boolean addAnonymousPermissionsToPlan(@NotNull
                                      String planKey)

removeAnonymousPermissionsFromPlan

boolean removeAnonymousPermissionsFromPlan(@NotNull
                                           String planKey)

supportedPermissions

@NotNull
Collection<BambooPermission> supportedPermissions()

Collection of permissions configurable on projects to apply to all contained plans.

Ordered by permission importance. Least granting permissions come first.

permissionDependencies

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

Obtain a collection of Bamboo permissions dependent on the passed permission. A dependent permission is expected to always be granted whenever the parent permission is granted too.

The result is an effective collection of dependencies, meaning there's no need to recursively traverse the dependency graph.