com.atlassian.bamboo.project

Interface ProjectPermissionsService

All Known Implementing Classes:

DefaultProjectPermissionsService

@Experimental
public interface ProjectPermissionsService

Service for managing project permissions.

Since:

6.2

Method Summary

Modifier and Type	Method and Description
boolean	addAnonymousPermission(String projectKey) Grants READ permission for anonymous user to project.
boolean	addGroupPermissionsToProject(String projectKey, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissionsToProject(String projectKey, List<BambooPermission> permissionsToAdd)
boolean	addUserPermissionsToProject(String projectKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissions(String projectKey)
List<BambooPermission>	getGroupPermissionsForProject(String projectKey, String group)
List<BambooPermission>	getLoggedInPermissionsForProject(String projectKey)
List<BambooPermission>	getUserPermissionsForProject(String projectKey, String username)
Iterable<String>	listGroupsWithPermissionsForProject(String projectKey)
Iterable<String>	listUsersWithPermissionsForProject(String projectKey)
Collection<BambooPermission>	permissionDependencies(BambooPermission permission) Obtain a collection of Bamboo permissions dependent on the passed permission.
boolean	removeAnonymousPermission(String projectKey) Revoke READ permission from project for anonymous user.
boolean	removeGroupPermissionsFromProject(String projectKey, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissionsFromProject(String projectKey, List<BambooPermission> permissionsToRemove)
boolean	removeUserPermissionsFromProject(String projectKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions() Collection of permissions configurable for projects.

Method Detail

listUsersWithPermissionsForProject

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

getUserPermissionsForProject

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

addUserPermissionsToProject

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

removeUserPermissionsFromProject

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

listGroupsWithPermissionsForProject

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

getGroupPermissionsForProject

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

addGroupPermissionsToProject

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

removeGroupPermissionsFromProject

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

getLoggedInPermissionsForProject

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

addLoggedInPermissionsToProject

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

removeLoggedInPermissionsFromProject

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

supportedPermissions

@NotNull
Collection<BambooPermission> supportedPermissions()

Collection of permissions configurable for projects.

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.

getAnonymousPermissions

List<BambooPermission> getAnonymousPermissions(@NotNull
                                               String projectKey)

Returns:

permissions of anonymous user for project

addAnonymousPermission

boolean addAnonymousPermission(@NotNull
                               String projectKey)

Grants READ permission for anonymous user to project.

Returns:

true if permission was granted

removeAnonymousPermission

boolean removeAnonymousPermission(@NotNull
                                  String projectKey)

Revoke READ permission from project for anonymous user.

Returns:

true if permission was revoked.