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 Summary

Modifier and Type	Method and Description
boolean	addAnonymousPermissionsToEnvironment(long environmentId)
boolean	addGroupPermissionsToEnvironment(long environmentId, String groupName, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissionsToEnvironment(long environmentId, List<BambooPermission> permissionsToAdd)
boolean	addUserPermissionsToEnvironment(long environmentId, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissionsForEnvironment(long environmentId)
List<BambooPermission>	getGroupPermissionsForEnvironment(long environmentId, String groupName)
List<BambooPermission>	getLoggedInPermissionsForEnvironment(long environmentId)
List<BambooPermission>	getUserPermissionsForEnvironment(long environmentId, String username)
Iterable<String>	listGroupsWithPermissionsForEnvironment(long environmentId)
Iterable<String>	listUsersWithPermissionsForEnvironment(long environmentId)
Collection<BambooPermission>	permissionDependencies(BambooPermission permission) Obtain a collection of Bamboo permissions dependent on the passed permission.
boolean	removeAnonymousPermissionsFromEnvironment(long environmentId)
boolean	removeGroupPermissionsFromEnvironment(long environmentId, String groupName, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissionsFromEnvironment(long environmentId, List<BambooPermission> permissionsToRemove)
boolean	removeUserPermissionsFromEnvironment(long environmentId, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions() Collection of permissions configurable for environments.

Method Detail

listUsersWithPermissionsForEnvironment

@NotNull
Iterable<String> listUsersWithPermissionsForEnvironment(long environmentId)

getUserPermissionsForEnvironment

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

addUserPermissionsToEnvironment

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

removeUserPermissionsFromEnvironment

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

listGroupsWithPermissionsForEnvironment

@NotNull
Iterable<String> listGroupsWithPermissionsForEnvironment(long environmentId)

getGroupPermissionsForEnvironment

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

addGroupPermissionsToEnvironment

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

removeGroupPermissionsFromEnvironment

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

getLoggedInPermissionsForEnvironment

@NotNull
List<BambooPermission> getLoggedInPermissionsForEnvironment(long environmentId)

addLoggedInPermissionsToEnvironment

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

removeLoggedInPermissionsFromEnvironment

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

getAnonymousPermissionsForEnvironment

@NotNull
List<BambooPermission> getAnonymousPermissionsForEnvironment(long environmentId)

addAnonymousPermissionsToEnvironment

boolean addAnonymousPermissionsToEnvironment(long environmentId)

removeAnonymousPermissionsFromEnvironment

boolean removeAnonymousPermissionsFromEnvironment(long environmentId)

supportedPermissions

@NotNull
Collection<BambooPermission> supportedPermissions()

Collection of permissions configurable for environments.

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.