com.google.gerrit.server.permissions

Class PermissionBackend.ForChange

java.lang.Object

com.google.gerrit.server.permissions.PermissionBackend.AcceptsReviewDb<PermissionBackend.ForChange>

com.google.gerrit.server.permissions.PermissionBackend.ForChange

Enclosing class:

PermissionBackend

public abstract static class PermissionBackend.ForChange
extends PermissionBackend.AcceptsReviewDb<PermissionBackend.ForChange>

PermissionBackend scoped to a user, project, reference and change.

Field Summary

Fields inherited from class com.google.gerrit.server.permissions.PermissionBackend.AcceptsReviewDb

db

Constructor Summary

Constructors

Constructor and Description
ForChange()

Method Summary

Modifier and Type	Method and Description
abstract void	check(ChangePermissionOrLabel perm) Verify scoped user can perm, throwing if denied.
short	squashByTest(LabelType label, short val) Squash a label value to the nearest allowed value using only test methods.
short	squashThenCheck(LabelType label, short val) Squash a label value to the nearest allowed value.
boolean	test(ChangePermissionOrLabel perm)
abstract <T extends ChangePermissionOrLabel> Set<T>	test(Collection<T> permSet) Filter permSet to permissions scoped user might be able to perform.
Set<LabelPermission.WithValue>	test(LabelType label) Test which values of a label the user may be able to set.
BooleanCondition	testCond(ChangePermissionOrLabel perm)
Set<LabelPermission.WithValue>	testLabels(Collection<LabelType> types) Test which values of a group of labels the user may be able to set.
boolean	testOrFalse(ChangePermissionOrLabel perm) Test if user may be able to perform the permission.
abstract CurrentUser	user()
abstract PermissionBackend.ForChange	user(CurrentUser user)

Methods inherited from class com.google.gerrit.server.permissions.PermissionBackend.AcceptsReviewDb

database, database

Methods inherited from class java.lang.Object

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

Constructor Detail

ForChange

public ForChange()

Method Detail

user

public abstract CurrentUser user()

Returns:

user this instance is scoped to.

user

public abstract PermissionBackend.ForChange user(CurrentUser user)

Returns:

new instance rescoped to same change, but different user.

check

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

Verify scoped user can perm, throwing if denied.

Throws:

AuthException

PermissionBackendException

test

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

Throws:

PermissionBackendException

testOrFalse

public boolean testOrFalse(ChangePermissionOrLabel perm)

Test if user may be able to perform the permission.

Similar to test(ChangePermissionOrLabel) 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 BooleanCondition testCond(ChangePermissionOrLabel perm)

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.

testLabels

public Set<LabelPermission.WithValue> testLabels(Collection<LabelType> types)
                                          throws PermissionBackendException

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

Parameters:

types - definition of the labels 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.

squashThenCheck

public short squashThenCheck(LabelType label,
                             short val)
                      throws PermissionBackendException

Squash a label value to the nearest allowed value.

For multi-valued labels like Code-Review with values -2..+2 a user may try to use +2, but only have permission for the -1..+1 range. The caller should have already tried:

 check(new LabelPermission.WithValue("Code-Review", 2));
 

and caught AuthException. squashThenCheck will use test(LabelType) to determine potential values of Code-Review the user can use, and select the nearest value along the same sign, e.g. -1 for -2 and +1 for +2.

Parameters:

label - definition of the label to test values of.

val - previously denied value the user attempted.

Returns:

nearest allowed value, or 0 if no value was allowed.

Throws:

PermissionBackendException - backend cannot run test or check.

squashByTest

public short squashByTest(LabelType label,
                          short val)
                   throws PermissionBackendException

Squash a label value to the nearest allowed value using only test methods.

Tests all possible values and selects the closet available to val while matching the sign of val. Unlike #squashThenCheck(LabelType, short) this method only uses test methods and should not be used in contexts like a review handler without checking the resulting score.

Parameters:

label - definition of the label to test values of.

val - previously denied value the user attempted.

Returns:

nearest likely allowed value, or 0 if no value was identified.

Throws:

PermissionBackendException - backend cannot run test.