Package com.google.gerrit.server.permissions

Class PermissionBackend.ForRef

java.lang.Object

com.google.gerrit.server.permissions.PermissionBackend.ForRef

Enclosing class:

PermissionBackend

public abstract static class PermissionBackend.ForRef
extends Object

PermissionBackend scoped to a user, project and reference.

Constructor Summary

Constructors

Constructor	Description
ForRef()

Method Summary

Modifier and Type	Method	Description
abstract PermissionBackend.ForChange	change(ChangeNotes notes)	Returns an instance scoped to change.
abstract PermissionBackend.ForChange	change(ChangeData cd)	Returns an instance scoped to change.
abstract void	check(RefPermissionOrLabel perm)	Verify scoped user can perm, throwing if denied.
abstract String	resourcePath()	Returns a fully qualified resource path that this instance is scoped to.
Set<LabelPermission.WithValue>	test(LabelType label)	Test which values of a label the user may be able to set.
boolean	test(RefPermissionOrLabel perm)
abstract <T extends RefPermissionOrLabel> Set<T>	test(Collection<T> permSet)	Filter permSet to permissions scoped user might be able to perform.
abstract BooleanCondition	testCond(RefPermissionOrLabel perm)
boolean	testOrFalse(RefPermissionOrLabel perm)	Test if user may be able to perform the permission.

Methods inherited from class java.lang.Object

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

Constructor Details

ForRef

public ForRef()

Method Details

resourcePath

public abstract String resourcePath()

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

change

public abstract PermissionBackend.ForChange change(ChangeData cd)

Returns an instance scoped to change.

change

public abstract PermissionBackend.ForChange change(ChangeNotes notes)

Returns an instance scoped to change.

check

public abstract void check(RefPermissionOrLabel 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(RefPermissionOrLabel).

Throws:

AuthException

PermissionBackendException

test

public abstract <T extends RefPermissionOrLabel>
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(RefPermissionOrLabel perm)
             throws PermissionBackendException

Throws:

PermissionBackendException

test

public Set<LabelPermission.WithValue> test(LabelType label)
                                    throws PermissionBackendException

Test which values of a label the user may be able to set.

Parameters:

label - definition of the label to test values of.

Returns:

set containing values the user may be able to use; may be empty if none.

Throws:

PermissionBackendException - if failure consulting backend configuration.

testOrFalse

public boolean testOrFalse(RefPermissionOrLabel perm)

Test if user may be able to perform the permission.

Similar to test(RefPermission) except this method returns false instead of throwing an exception.

Parameters:

perm - the permission to test.

Returns:

true if the user might be able to perform the permission; false if the user may be missing the necessary grants or state, or if the backend threw an exception.

testCond

public abstract BooleanCondition testCond(RefPermissionOrLabel perm)