com.google.gerrit.server.project

Class RefControl

java.lang.Object

com.google.gerrit.server.project.RefControl

public class RefControl
extends Object

Manages access control for Git references (aka branches, tags).

Method Summary

Modifier and Type	Method and Description
boolean	canAbandon()
boolean	canAddPatchSet()
boolean	canCreate(ReviewDb db, org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevObject object) Determines whether the user can create a new Git ref.
boolean	canDelete() Determines whether the user can delete the Git ref controlled by this object.
boolean	canDeleteDrafts()
boolean	canDeleteOwnChanges()
boolean	canEditAssignee()
boolean	canEditHashtags()
boolean	canEditTopicName()
boolean	canForceEditTopicName()
boolean	canForceUpdate()
boolean	canForgeAuthor()
boolean	canForgeCommitter()
boolean	canForgeGerritServerIdentity()
boolean	canPublishDrafts()
boolean	canRead()
boolean	canRebase()
boolean	canSubmit(boolean isChangeOwner)
boolean	canSubmitAs()
boolean	canUpdate()
boolean	canUpload() Determines whether the user can upload a change to the ref controlled by this object.
boolean	canUploadMerges()
boolean	canViewDrafts()
boolean	canWrite()
RefControl	forUser(CurrentUser who)
List<PermissionRange>	getLabelRanges(boolean isChangeOwner) All value ranges of any allowed label permission.
ProjectControl	getProjectControl()
PermissionRange	getRange(String permission) The range of permitted values associated with a label permission.
PermissionRange	getRange(String permission, boolean isChangeOwner) The range of permitted values associated with a label permission.
String	getRefName()
CurrentUser	getUser()
boolean	isBlocked(String permissionName) True if the user is blocked from using this permission.
boolean	isOwner() Is this user a ref owner?
boolean	isVisible() Can this user see this reference exists?
boolean	isVisibleByRegisteredUsers() True if this reference is visible by all REGISTERED_USERS

Methods inherited from class java.lang.Object

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

Method Detail

getRefName

public String getRefName()

getProjectControl

public ProjectControl getProjectControl()

getUser

public CurrentUser getUser()

forUser

public RefControl forUser(CurrentUser who)

isOwner

public boolean isOwner()

Is this user a ref owner?

isVisible

public boolean isVisible()

Can this user see this reference exists?

isVisibleByRegisteredUsers

public boolean isVisibleByRegisteredUsers()

True if this reference is visible by all REGISTERED_USERS

canUpload

public boolean canUpload()

Determines whether the user can upload a change to the ref controlled by this object.

Returns:

true if the user specified can upload a change to the Git ref

canAddPatchSet

public boolean canAddPatchSet()

Returns:

true if this user can add a new patch set to this ref

canUploadMerges

public boolean canUploadMerges()

Returns:

true if this user can submit merge patch sets to this ref

canRebase

public boolean canRebase()

Returns:

true if this user can rebase changes on this ref

canSubmit

public boolean canSubmit(boolean isChangeOwner)

Returns:

true if this user can submit patch sets to this ref

canSubmitAs

public boolean canSubmitAs()

Returns:

true if this user was granted submitAs to this ref

canUpdate

public boolean canUpdate()

Returns:

true if the user can update the reference as a fast-forward.

canForceUpdate

public boolean canForceUpdate()

Returns:

true if the user can rewind (force push) the reference.

canWrite

public boolean canWrite()

canRead

public boolean canRead()

canCreate

public boolean canCreate(ReviewDb db,
                         org.eclipse.jgit.lib.Repository repo,
                         org.eclipse.jgit.revwalk.RevObject object)

Determines whether the user can create a new Git ref.

Parameters:

db - db for checking change visibility.

repo - repository on which user want to create

object - the object the user will start the reference with.

Returns:

true if the user specified can create a new Git ref

canDelete

public boolean canDelete()

Determines whether the user can delete the Git ref controlled by this object.

Returns:

true if the user specified can delete a Git ref.

canForgeAuthor

public boolean canForgeAuthor()

Returns:

true if this user can forge the author line in a commit.

canForgeCommitter

public boolean canForgeCommitter()

Returns:

true if this user can forge the committer line in a commit.

canForgeGerritServerIdentity

public boolean canForgeGerritServerIdentity()

Returns:

true if this user can forge the server on the committer line.

canAbandon

public boolean canAbandon()

Returns:

true if this user can abandon a change for this ref

canViewDrafts

public boolean canViewDrafts()

Returns:

true if this user can view draft changes.

canPublishDrafts

public boolean canPublishDrafts()

Returns:

true if this user can publish draft changes.

canDeleteDrafts

public boolean canDeleteDrafts()

Returns:

true if this user can delete draft changes.

canDeleteOwnChanges

public boolean canDeleteOwnChanges()

Returns:

true if this user can delete their own changes.

canEditTopicName

public boolean canEditTopicName()

Returns:

true if this user can edit topic names.

canEditHashtags

public boolean canEditHashtags()

Returns:

true if this user can edit hashtag names.

canEditAssignee

public boolean canEditAssignee()

canForceEditTopicName

public boolean canForceEditTopicName()

Returns:

true if this user can force edit topic names.

getLabelRanges

public List<PermissionRange> getLabelRanges(boolean isChangeOwner)

All value ranges of any allowed label permission.

getRange

public PermissionRange getRange(String permission)

The range of permitted values associated with a label permission.

getRange

public PermissionRange getRange(String permission,
                                boolean isChangeOwner)

The range of permitted values associated with a label permission.

isBlocked

public boolean isBlocked(String permissionName)

True if the user is blocked from using this permission.