Package com.google.gerrit.server.permissions

Class PermissionBackend.ForProject

java.lang.Object

com.google.gerrit.server.permissions.PermissionBackend.ForProject

Enclosing class:

PermissionBackend

public abstract static class PermissionBackend.ForProject
extends Object

PermissionBackend scoped to a user and project.

Constructor Summary

Constructors

Constructor	Description
ForProject()

Method Summary

Modifier and Type	Method	Description
PermissionBackend.ForChange	change(ChangeNotes notes)	Returns an instance scoped for the change, and its destination ref and project.
PermissionBackend.ForChange	change(ChangeData cd)	Returns an instance scoped for the change, and its destination ref and project.
abstract void	check(CoreOrPluginProjectPermission perm)	Verify scoped user can perm, throwing if denied.
abstract Collection<org.eclipse.jgit.lib.Ref>	filter(Collection<org.eclipse.jgit.lib.Ref> refs, org.eclipse.jgit.lib.Repository repo, PermissionBackend.RefFilterOptions opts)	Filter a list of references by visibility.
abstract PermissionBackend.ForRef	ref(String ref)	Returns an instance scoped for ref in this project.
abstract String	resourcePath()	Returns the fully qualified resource path that this instance is scoped to.
boolean	test(CoreOrPluginProjectPermission perm)
abstract <T extends CoreOrPluginProjectPermission> Set<T>	test(Collection<T> permSet)	Filter permSet to permissions scoped user might be able to perform.
abstract BooleanCondition	testCond(CoreOrPluginProjectPermission perm)
boolean	testOrFalse(CoreOrPluginProjectPermission perm)

Methods inherited from class java.lang.Object

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

Constructor Details

ForProject

public ForProject()

Method Details

resourcePath

public abstract String resourcePath()

Returns the fully qualified resource path that this instance is scoped to.

ref

public abstract PermissionBackend.ForRef ref(String ref)

Returns an instance scoped for ref in this project.

change

public PermissionBackend.ForChange change(ChangeData cd)

Returns an instance scoped for the change, and its destination ref and project.

change

public PermissionBackend.ForChange change(ChangeNotes notes)

Returns an instance scoped for the change, and its destination ref and project.

check

public abstract void check(CoreOrPluginProjectPermission perm)
                    throws AuthException,
PermissionBackendException

Verify scoped user can perm, throwing if denied.

Should be used in REST API handlers where the thrown AuthException can be propagated. In business logic, where the exception would have to be caught, prefer using test(CoreOrPluginProjectPermission).

Throws:

AuthException

PermissionBackendException

test

public abstract <T extends CoreOrPluginProjectPermission>
Set<T> test(Collection<T> permSet)
     throws PermissionBackendException

Filter permSet to permissions scoped user might be able to perform.

Throws:

PermissionBackendException

test

public boolean test(CoreOrPluginProjectPermission perm)
             throws PermissionBackendException

Throws:

PermissionBackendException

testOrFalse

public boolean testOrFalse(CoreOrPluginProjectPermission perm)

testCond

public abstract BooleanCondition testCond(CoreOrPluginProjectPermission perm)

filter

public abstract Collection<org.eclipse.jgit.lib.Ref> filter(Collection<org.eclipse.jgit.lib.Ref> refs,
 org.eclipse.jgit.lib.Repository repo,
 PermissionBackend.RefFilterOptions opts)
                                                     throws PermissionBackendException

Filter a list of references by visibility.

Parameters:

refs - a collection of references to filter.

repo - an open Repository handle for this instance's project

opts - further options for filtering.

Returns:

a partition of the provided refs that are visible to the user that this instance is scoped to.

Throws:

PermissionBackendException - if failure consulting backend configuration.