com.atlassian.bamboo.plugins.rest.admin.permission

Class GlobalPermissionResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.permission.GlobalPermissionResource

Deprecated.

since 6.2

@Deprecated
public class GlobalPermissionResource
extends Object

REST endpoint to manage user/group permissions in bamboo. Currently only support group permissions.

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static RestGlobalPermission	REST_USER_GROUP_PERMISSION Deprecated.
static List<RestGlobalPermission>	REST_USER_GROUP_PERMISSIONS Deprecated.

Constructor Summary

Constructors

Constructor and Description

GlobalPermissionResource(BambooPermissionManager bambooPermissionManager, HibernateMutableAclService aclService, GlobalPermissionConversionFunction function, com.atlassian.sal.api.message.I18nResolver i18nResolver, BambooUserManager userManager, AdministrationConfigurationAccessor administrationConfigurationAccessor, AdministrationConfigurationPersister administrationConfigurationPersister, GlobalPermissionsService globalPermissionsService) Deprecated.

Method Summary

Modifier and Type	Method and Description
List<RestGlobalPermission>	getGroupPermission(String groupName, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Retrieve a list of groups with their permissions.
List<RestGlobalPermission>	getRolePermission(String roleName, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Retrieve a list of roles with their permissions.
List<RestGlobalPermission>	getUserPermission(String userName, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Retrieve a list of users with their permissions.
RestGlobalPermission	updateGroupPermission(RestGlobalPermission restGlobalPermission, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Update global permissions of a group.
RestGlobalPermission	updateRolePermission(RestGlobalPermission restGlobalPermission, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Update global permissions of a role.
RestGlobalPermission	updateUserPermission(RestGlobalPermission restGlobalPermission, javax.ws.rs.core.UriInfo uriInfo) Deprecated. Update global permissions of a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REST_USER_GROUP_PERMISSION

public static final RestGlobalPermission REST_USER_GROUP_PERMISSION

Deprecated.

REST_USER_GROUP_PERMISSIONS

public static final List<RestGlobalPermission> REST_USER_GROUP_PERMISSIONS

Deprecated.

Constructor Detail

GlobalPermissionResource

public GlobalPermissionResource(BambooPermissionManager bambooPermissionManager,
                                HibernateMutableAclService aclService,
                                GlobalPermissionConversionFunction function,
                                com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                BambooUserManager userManager,
                                AdministrationConfigurationAccessor administrationConfigurationAccessor,
                                AdministrationConfigurationPersister administrationConfigurationPersister,
                                GlobalPermissionsService globalPermissionsService)

Deprecated.

Method Detail

getUserPermission

@NotNull
public List<RestGlobalPermission> getUserPermission(@Nullable
                                                             String userName,
                                                             @NotNull @Context
                                                             Expansion expansion,
                                                             @NotNull @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)
                                                      throws WebValidationException

Deprecated.

Retrieve a list of users with their permissions. The list can be filtered by some attributes. Currently only user name (query parameter "name") is supported and is mandatory. Only one user will be included in the result.

Parameters:

userName - user name

Returns:

a list of user's permissions

Throws:

WebValidationException

getGroupPermission

@NotNull
public List<RestGlobalPermission> getGroupPermission(@Nullable
                                                              String groupName,
                                                              @NotNull @Context
                                                              Expansion expansion,
                                                              @NotNull @Context
                                                              javax.ws.rs.core.UriInfo uriInfo)
                                                       throws WebValidationException

Deprecated.

Retrieve a list of groups with their permissions. The list can be filtered by some attributes. Currently Only group name is supported and is mandatory. Only one group will be included in the result. Group name is provided as a query parameter, e.g. http://bamboo/rest/admin/latest/permissions/roles?name=bamboo-admin

Parameters:

groupName - Group name

Returns:

A list of group permissions

Throws:

WebValidationException

getRolePermission

@NotNull
public List<RestGlobalPermission> getRolePermission(@Nullable
                                                             String roleName,
                                                             @NotNull @Context
                                                             Expansion expansion,
                                                             @NotNull @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)
                                                      throws WebValidationException

Deprecated.

Retrieve a list of roles with their permissions. The list can be filtered by some attributes. Currently Only role name is supported and is mandatory. Only one role will be included in the result. Only two roles are supported: ROLE_USER, the logged in user, and ROLE_ANONYMOUS, anonymous user. Role name is provided as a query parameter, e.g. http://bamboo/rest/admin/latest/permissions/roles?name=ROLE_USER

Parameters:

roleName - name of the role

expansion -

uriInfo -

Returns:

List of permissions

Throws:

WebValidationException

updateUserPermission

@NotNull
public RestGlobalPermission updateUserPermission(@Nullable
                                                          RestGlobalPermission restGlobalPermission,
                                                          @NotNull @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws WebValidationException

Deprecated.

Update global permissions of a user. Only Restricted/System Admins are allowed to invoke this REST endpoint. Restricted Admins cannot update any System Admin permissions. It also guarantees there's at lease one group or user has System Admin permission.

Parameters:

restGlobalPermission - Permission model of the user

Returns:

Updated permission model of the user

Throws:

WebValidationException

updateGroupPermission

@NotNull
public RestGlobalPermission updateGroupPermission(@Nullable
                                                           RestGlobalPermission restGlobalPermission,
                                                           @NotNull @Context
                                                           javax.ws.rs.core.UriInfo uriInfo)
                                                    throws WebValidationException

Deprecated.

Update global permissions of a group. Only Restricted/System Admins are allowed to invoke this REST endpoint. Restricted Admins cannot update any System Admin permissions. It also guarantees there's at lease one group or user has System Admin permission.

Parameters:

restGlobalPermission - Permission model of the group

Returns:

Updated permission model of the group

Throws:

WebValidationException

updateRolePermission

public RestGlobalPermission updateRolePermission(@Nullable
                                                 RestGlobalPermission restGlobalPermission,
                                                 @NotNull @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)
                                          throws WebValidationException

Deprecated.

Update global permissions of a role. Only Restricted/System Admins are allowed to invoke this REST endpoint. Only two roles are allowed to be updated: ROLE_USER, the logged in user, and ROLE_ANONYMOUS, anonymous user. Logged in users can only be granted READ, CREATE permission, anonymous users can only be granted READ permission.

Parameters:

restGlobalPermission -

uriInfo -

Returns:

Updated permission model of the role

Throws:

WebValidationException