Package com.atlassian.bamboo.deployments.environments

Interface EnvironmentPermissionsService

  • All Known Implementing Classes:
    DefaultEnvironmentPermissionsService
    @ExperimentalApi
public interface EnvironmentPermissionsService
    Service to manage environment permissions.
    Since:
    6.2.0

    • Method Detail

      • listUsersWithPermissionsForEnvironment

        @NotNull
@NotNull Iterable<String> listUsersWithPermissionsForEnvironment​(long environmentId)

      • getUserPermissionsForEnvironment

        @NotNull
@NotNull List<BambooPermission> getUserPermissionsForEnvironment​(long environmentId,
                                                                 @NotNull
                                                                 @NotNull String username)

      • addUserPermissionsToEnvironment

        boolean addUserPermissionsToEnvironment​(long environmentId,
                                        @NotNull
                                        @NotNull String username,
                                        @NotNull
                                        @NotNull List<BambooPermission> permissionsToAdd)

      • removeUserPermissionsFromEnvironment

        boolean removeUserPermissionsFromEnvironment​(long environmentId,
                                             @NotNull
                                             @NotNull String username,
                                             @NotNull
                                             @NotNull List<BambooPermission> permissionsToRemove)

      • listGroupsWithPermissionsForEnvironment

        @NotNull
@NotNull Iterable<String> listGroupsWithPermissionsForEnvironment​(long environmentId)

      • getGroupPermissionsForEnvironment

        @NotNull
@NotNull List<BambooPermission> getGroupPermissionsForEnvironment​(long environmentId,
                                                                  @NotNull
                                                                  @NotNull String groupName)

      • addGroupPermissionsToEnvironment

        boolean addGroupPermissionsToEnvironment​(long environmentId,
                                         @NotNull
                                         @NotNull String groupName,
                                         @NotNull
                                         @NotNull List<BambooPermission> permissionsToAdd)

      • removeGroupPermissionsFromEnvironment

        boolean removeGroupPermissionsFromEnvironment​(long environmentId,
                                              @NotNull
                                              @NotNull String groupName,
                                              @NotNull
                                              @NotNull List<BambooPermission> permissionsToRemove)

      • getLoggedInPermissionsForEnvironment

        @NotNull
@NotNull List<BambooPermission> getLoggedInPermissionsForEnvironment​(long environmentId)

      • addLoggedInPermissionsToEnvironment

        boolean addLoggedInPermissionsToEnvironment​(long environmentId,
                                            @NotNull
                                            @NotNull List<BambooPermission> permissionsToAdd)

      • removeLoggedInPermissionsFromEnvironment

        boolean removeLoggedInPermissionsFromEnvironment​(long environmentId,
                                                 @NotNull
                                                 @NotNull List<BambooPermission> permissionsToRemove)

      • getAnonymousPermissionsForEnvironment

        @NotNull
@NotNull List<BambooPermission> getAnonymousPermissionsForEnvironment​(long environmentId)

      • addAnonymousPermissionsToEnvironment

        boolean addAnonymousPermissionsToEnvironment​(long environmentId)

      • removeAnonymousPermissionsFromEnvironment

        boolean removeAnonymousPermissionsFromEnvironment​(long environmentId)

      • supportedPermissions

        @NotNull
@NotNull Collection<BambooPermission> supportedPermissions()
        Collection of permissions configurable for environments.

        Ordered by permission importance. Least granting permissions come first.

      • permissionDependencies

        @NotNull
@NotNull Collection<BambooPermission> permissionDependencies​(@NotNull
                                                             @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.