com.atlassian.bamboo.plan

Interface PlanPermissionsService

All Known Implementing Classes:

DefaultPlanPermissionsService

@ExperimentalApi
public interface PlanPermissionsService

Service to manage plan permissions.

Since:

6.2.0

Method Summary

Modifier and Type	Method and Description
boolean	addAnonymousPermissionsToPlan(String planKey)
boolean	addGroupPermissionsToPlan(String planKey, String groupName, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissionsToPlan(String planKey, List<BambooPermission> permissionsToAdd)
boolean	addUserPermissionsToPlan(String planKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissionsForPlan(String planKey)
List<BambooPermission>	getGroupPermissionsForPlan(String planKey, String groupName)
List<BambooPermission>	getLoggedInPermissionsForPlan(String planKey)
List<BambooPermission>	getUserPermissionsForPlan(String planKey, String username)
Iterable<String>	listGroupsWithPermissionsForPlan(String planKey)
Iterable<String>	listUsersWithPermissionsForPlan(String planKey)
Collection<BambooPermission>	permissionDependencies(BambooPermission permission) Obtain a collection of Bamboo permissions dependent on the passed permission.
boolean	removeAnonymousPermissionsFromPlan(String planKey)
boolean	removeGroupPermissionsFromPlan(String planKey, String groupName, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissionsFromPlan(String planKey, List<BambooPermission> permissionsToRemove)
boolean	removeUserPermissionsFromPlan(String planKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions() Collection of permissions configurable for plans.

Method Detail

listUsersWithPermissionsForPlan

@NotNull
Iterable<String> listUsersWithPermissionsForPlan(@NotNull
                                                          String planKey)

getUserPermissionsForPlan

@NotNull
List<BambooPermission> getUserPermissionsForPlan(@NotNull
                                                          String planKey,
                                                          @NotNull
                                                          String username)

addUserPermissionsToPlan

boolean addUserPermissionsToPlan(@NotNull
                                 String planKey,
                                 @NotNull
                                 String username,
                                 @NotNull
                                 List<BambooPermission> permissionsToAdd)

removeUserPermissionsFromPlan

boolean removeUserPermissionsFromPlan(@NotNull
                                      String planKey,
                                      @NotNull
                                      String username,
                                      @NotNull
                                      List<BambooPermission> permissionsToRemove)

listGroupsWithPermissionsForPlan

@NotNull
Iterable<String> listGroupsWithPermissionsForPlan(@NotNull
                                                           String planKey)

getGroupPermissionsForPlan

@NotNull
List<BambooPermission> getGroupPermissionsForPlan(@NotNull
                                                           String planKey,
                                                           @NotNull
                                                           String groupName)

addGroupPermissionsToPlan

boolean addGroupPermissionsToPlan(@NotNull
                                  String planKey,
                                  @NotNull
                                  String groupName,
                                  @NotNull
                                  List<BambooPermission> permissionsToAdd)

removeGroupPermissionsFromPlan

boolean removeGroupPermissionsFromPlan(@NotNull
                                       String planKey,
                                       @NotNull
                                       String groupName,
                                       @NotNull
                                       List<BambooPermission> permissionsToRemove)

getLoggedInPermissionsForPlan

@NotNull
List<BambooPermission> getLoggedInPermissionsForPlan(@NotNull
                                                              String planKey)

addLoggedInPermissionsToPlan

boolean addLoggedInPermissionsToPlan(@NotNull
                                     String planKey,
                                     @NotNull
                                     List<BambooPermission> permissionsToAdd)

removeLoggedInPermissionsFromPlan

boolean removeLoggedInPermissionsFromPlan(@NotNull
                                          String planKey,
                                          @NotNull
                                          List<BambooPermission> permissionsToRemove)

getAnonymousPermissionsForPlan

@NotNull
List<BambooPermission> getAnonymousPermissionsForPlan(@NotNull
                                                               String planKey)

addAnonymousPermissionsToPlan

boolean addAnonymousPermissionsToPlan(@NotNull
                                      String planKey)

removeAnonymousPermissionsFromPlan

boolean removeAnonymousPermissionsFromPlan(@NotNull
                                           String planKey)

supportedPermissions

@NotNull
Collection<BambooPermission> supportedPermissions()

Collection of permissions configurable for 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.