com.atlassian.bitbucket.permission

Interface PermissionValidationService

public interface PermissionValidationService

A utility service for plugin developer to validate that the current user has a specific permission. This service uses the PermissionService to check for a permission and will throw AuthorisationException for any failed permission check.

Method Summary

Modifier and Type	Method and Description
void	validateAuthenticated() Validate that the user is logged in
void	validateForGlobal(Permission permission) Validate that the current user has the specified global permission
void	validateForProject(int projectId, Permission permission) Validate that the current user has the specified permission for the project
void	validateForProject(Project project, Permission permission) Validate that the current user has the specified permission for the project
void	validateForRepository(int repositoryId, Permission permission) Validate that the current user has the specified permission for the repository
void	validateForRepository(Repository repository, Permission permission) Validate that the current user has the specified permission for the repository
void	validateForUser(ApplicationUser targetUser, Permission permission) Validate that the current user has the specified permission for the target user.
void	validateForUser(int targetUserId, Permission permission) Validate that the current user has the specified permission for the target user.
void	validateForUser(Permission permission) Validate that the current user has the specified permission for itself
void	validateRepositoryAccessible(int repositoryId) Validate that the current user (authenticated or not) has access to the given repository.
void	validateRepositoryAccessible(Repository repository) Validate that the current user (authenticated or not) has access to the given repository.

Method Detail

validateAuthenticated

void validateAuthenticated()
                    throws AuthorisationException

Validate that the user is logged in

Throws:

AuthorisationException - if anonymous

See Also:

AuthenticationContext.isAuthenticated()

validateForGlobal

void validateForGlobal(@Nonnull
                       Permission permission)
                throws AuthorisationException

Validate that the current user has the specified global permission

Parameters:

permission - the requested permission. Must not be null and Permission.isGlobal() must be true

Throws:

AuthorisationException - if the current user is unauthorized

See Also:

PermissionService.hasGlobalPermission(Permission)

validateForProject

void validateForProject(@Nonnull
                        Project project,
                        @Nonnull
                        Permission permission)
                 throws AuthorisationException

Validate that the current user has the specified permission for the project

Parameters:

project - the target project. Must not be null

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

See Also:

PermissionService.hasProjectPermission(Project, Permission)

validateForProject

void validateForProject(int projectId,
                        @Nonnull
                        Permission permission)

Validate that the current user has the specified permission for the project

Parameters:

projectId - the ID of the target project

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

Since:

4.1

See Also:

PermissionService.hasProjectPermission(Project, Permission)

validateForRepository

void validateForRepository(@Nonnull
                           Repository repository,
                           @Nonnull
                           Permission permission)
                    throws AuthorisationException

Validate that the current user has the specified permission for the repository

Note that anonymous users accessing a public repository do not have the Permission.REPO_READ permission. To perform read access validation that includes public repository access by anonymous users see validateRepositoryAccessible(Repository).

Parameters:

repository - the target repository. Must not be null

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

See Also:

PermissionService.hasRepositoryPermission(Repository, Permission)

validateForRepository

void validateForRepository(int repositoryId,
                           @Nonnull
                           Permission permission)

Validate that the current user has the specified permission for the repository

Note that anonymous users accessing a public repository do not have the Permission.REPO_READ permission. To perform read access validation that includes public repository access by anonymous users see validateRepositoryAccessible(int).

Parameters:

repositoryId - the ID of the target repository

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

Since:

4.1

See Also:

PermissionService.hasRepositoryPermission(Repository, Permission)

validateForUser

void validateForUser(@Nonnull
                     ApplicationUser targetUser,
                     @Nonnull
                     Permission permission)

Validate that the current user has the specified permission for the target user.

Parameters:

targetUser - the target user. Must not be null

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

Since:

5.5

See Also:

PermissionService.hasUserPermission(ApplicationUser, Permission)

validateForUser

void validateForUser(int targetUserId,
                     @Nonnull
                     Permission permission)

Validate that the current user has the specified permission for the target user.

Parameters:

targetUserId - the ID of the target user

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

Since:

5.5

See Also:

PermissionService.hasUserPermission(ApplicationUser, Permission)

validateForUser

void validateForUser(@Nonnull
                     Permission permission)

Validate that the current user has the specified permission for itself

Parameters:

permission - the requested permission. Must not be null and Permission.isGlobal() must be false

Throws:

AuthorisationException - if the current user is unauthorized

Since:

5.5

See Also:

PermissionService.hasUserPermission(Permission)

validateRepositoryAccessible

void validateRepositoryAccessible(@Nonnull
                                  Repository repository)

Validate that the current user (authenticated or not) has access to the given repository. See PermissionService.isRepositoryAccessible(Repository) for a description of what constitutes "access".

Parameters:

repository - the target repository. Must not be null

Throws:

AuthorisationException - if the current user is unauthorized

Since:

4.3

See Also:

PermissionService.isRepositoryAccessible(Repository)

validateRepositoryAccessible

void validateRepositoryAccessible(int repositoryId)

Validate that the current user (authenticated or not) has access to the given repository. See PermissionService.isRepositoryAccessible(int) for a description of what constitutes "access".

Parameters:

repositoryId - the ID of the target repository

Throws:

AuthorisationException - if the current user is unauthorized

Since:

4.3

See Also:

PermissionService.isRepositoryAccessible(int)