Package com.google.gerrit.server.permissions

Class PermissionBackend.ForChange

java.lang.Object

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

Enclosing class:

PermissionBackend

public abstract static class PermissionBackend.ForChange
extends Object

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

Constructor Summary

Constructors

Constructor	Description
ForChange()

Method Summary

Modifier and Type	Method	Description
abstract void	check(ChangePermissionOrLabel perm)	Verify scoped user can perm, throwing if denied.
abstract String	resourcePath()	Returns the 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(ChangePermissionOrLabel perm)
abstract <T extends ChangePermissionOrLabel> Set<T>	test(Collection<T> permSet)	Filter permSet to permissions scoped user might be able to perform.
abstract BooleanCondition	testCond(ChangePermissionOrLabel perm)
Set<LabelRemovalPermission.WithValue>	testLabelRemovals(Collection<LabelType> types)	Test which values of a group of labels the user may be able to remove.
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.
Set<LabelRemovalPermission.WithValue>	testRemoval(LabelType label)	Test which values of a label the user may be able to remove.

Methods inherited from class java.lang.Object

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

Constructor Details

ForChange

public ForChange()

Method Details

resourcePath

public abstract String resourcePath()

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

check

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

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 abstract 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.

testRemoval

public Set<LabelRemovalPermission.WithValue> testRemoval(LabelType label)
                                                  throws PermissionBackendException

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

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.

testLabelRemovals

public Set<LabelRemovalPermission.WithValue> testLabelRemovals(Collection<LabelType> types)
                                                        throws PermissionBackendException

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

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.