Package com.atlassian.jira.permission

Class DefaultPermissionSchemeService

java.lang.Object

com.atlassian.jira.permission.DefaultPermissionSchemeService

All Implemented Interfaces:

PermissionSchemeService

@ParametersAreNonnullByDefault
public final class DefaultPermissionSchemeService
extends Object
implements PermissionSchemeService

Constructor Summary

Constructors

Constructor	Description
DefaultPermissionSchemeService(PermissionSchemeManager permissionSchemeManager, GlobalPermissionManager globalPermissions, PermissionGrantValidator permissionGrantValidator, PermissionSchemeRepresentationConverter representationConverter, ProjectService projectService, I18nHelper i18n, UserKeyService userKeyService, UserManager userManager)

Method Summary

Modifier and Type	Method	Description
ServiceResult	assignPermissionSchemeToProject(ApplicationUser user, Long schemeId, Long projectId)	Sets the specified permission scheme in the given project.
ServiceOutcome<PermissionScheme>	createPermissionScheme(ApplicationUser user, PermissionSchemeInput permissionScheme)	Creates a new permission scheme.
ServiceResult	deletePermissionScheme(ApplicationUser user, Long id)	Deletes a permission scheme.
ServiceOutcome<PermissionScheme>	getPermissionScheme(ApplicationUser user, Long id)	Returns a permission scheme with the specified id.
ServiceOutcome<com.google.common.collect.ImmutableList<PermissionScheme>>	getPermissionSchemes(ApplicationUser user)	Returns all permission schemes sorted alphabetically by name.
ServiceOutcome<PermissionScheme>	getSchemeAssignedToProject(ApplicationUser user, Long projectId)	Returns a permission scheme assigned to the specified project.
ServiceOutcome<PermissionScheme>	updatePermissionScheme(ApplicationUser user, Long id, PermissionSchemeInput permissionScheme)	Updates a permission scheme identified by the given id.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPermissionSchemeService

public DefaultPermissionSchemeService(PermissionSchemeManager permissionSchemeManager,
 GlobalPermissionManager globalPermissions,
 PermissionGrantValidator permissionGrantValidator,
 PermissionSchemeRepresentationConverter representationConverter,
 ProjectService projectService,
 I18nHelper i18n,
 UserKeyService userKeyService,
 UserManager userManager)

Method Details

getPermissionSchemes

public ServiceOutcome<com.google.common.collect.ImmutableList<PermissionScheme>> getPermissionSchemes(ApplicationUser user)

Description copied from interface: PermissionSchemeService

Returns all permission schemes sorted alphabetically by name.

Only schemes the user has access to will be returned. That means all the schemes if the user is a JIRA administrator, or the schemes assigned to projects the user administers.

Specified by:

getPermissionSchemes in interface PermissionSchemeService

Parameters:

user - user that performs the operation

Returns:

A service outcome containing an immutable list of permission schemes or an error collection if something went wrong.

getPermissionScheme

public ServiceOutcome<PermissionScheme> getPermissionScheme(@Nullable
 ApplicationUser user,
 Long id)

Description copied from interface: PermissionSchemeService

Returns a permission scheme with the specified id.

The user needs to have access to the permission scheme. That means the user needs to be a JIRA administrator or administer a project which has the scheme assigned.

Specified by:

getPermissionScheme in interface PermissionSchemeService

Parameters:

user - user that performs the operation

id - identifier of the permission scheme

Returns:

A service outcome containing the permission scheme or an error collection if something went wrong.

createPermissionScheme

public ServiceOutcome<PermissionScheme> createPermissionScheme(@Nullable
 ApplicationUser user,
 PermissionSchemeInput permissionScheme)

Description copied from interface: PermissionSchemeService

Creates a new permission scheme. Permission scheme entities will also be created if provided.

The permission scheme is validated thoroughly, e.g. if there is a permission for a group, then the group must exist, ditto for project roles, users, custom fields etc. Custom fields must be of proper types.

Note that permission scheme names must be unique.

Specified by:

createPermissionScheme in interface PermissionSchemeService

Parameters:

user - user that performs the operation. The user needs to be a JIRA administrator.

permissionScheme - permission scheme to create

Returns:

A service outcome containing the created permission scheme or an error collection if something went wrong.

updatePermissionScheme

public ServiceOutcome<PermissionScheme> updatePermissionScheme(@Nullable
 ApplicationUser user,
 Long id,
 PermissionSchemeInput permissionScheme)

Description copied from interface: PermissionSchemeService

Updates a permission scheme identified by the given id. Simple fields like name and description will be updated as well as permission scheme entities. After the update, the stored permission scheme will be exactly the same as the argument.

Validation is the same as in the PermissionSchemeService.createPermissionScheme(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.permission.PermissionSchemeInput) method.

Specified by:

updatePermissionScheme in interface PermissionSchemeService

Parameters:

user - user that performs the operation. The user needs to be a JIRA administrator.

id - id of the scheme to be updated

permissionScheme - new data of the permission scheme

Returns:

A service outcome containing the updated permission scheme or an error collection if something went wrong.

deletePermissionScheme

public ServiceResult deletePermissionScheme(@Nullable
 ApplicationUser user,
 Long id)

Description copied from interface: PermissionSchemeService

Deletes a permission scheme.

Specified by:

deletePermissionScheme in interface PermissionSchemeService

Parameters:

user - user that performs the operation. The user needs to be a JIRA administrator.

id - identifier of the permission scheme to be deleted

Returns:

A service result marked as valid if successful, error collection otherwise

assignPermissionSchemeToProject

public ServiceResult assignPermissionSchemeToProject(@Nullable
 ApplicationUser user,
 Long schemeId,
 Long projectId)

Description copied from interface: PermissionSchemeService

Sets the specified permission scheme in the given project.

Specified by:

assignPermissionSchemeToProject in interface PermissionSchemeService

Parameters:

user - user that performs the operation. The user needs to be a JIRA administrator.

schemeId - scheme to assign to the project

projectId - project to assign the scheme to

Returns:

service result marked as valid if successful, error collection otherwise

getSchemeAssignedToProject

public ServiceOutcome<PermissionScheme> getSchemeAssignedToProject(@Nullable
 ApplicationUser user,
 Long projectId)

Description copied from interface: PermissionSchemeService

Returns a permission scheme assigned to the specified project.

If there is no scheme explicitly assigned, the default scheme is returned.

Specified by:

getSchemeAssignedToProject in interface PermissionSchemeService

Parameters:

user - user that performs the operation. The user needs a permission to administer the project.

projectId - identifier of the project

Returns:

A service outcome containing the permission scheme or an error collection if something went wrong.