com.google.gerrit.server.project

Class ProjectControl

java.lang.Object

com.google.gerrit.server.project.ProjectControl

public class ProjectControl
extends Object

Access control management for a user accessing a project's data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProjectControl.AssistedFactory
static class	ProjectControl.Factory
static class	ProjectControl.GenericFactory
protected static class	ProjectControl.Metrics

Field Summary

Fields

Modifier and Type	Field and Description
static int	OWNER
static int	VISIBLE

Method Summary

Modifier and Type	Method and Description
boolean	allRefsAreVisible() Can this user see all the refs in this projects?
boolean	allRefsAreVisible(Set<String> ignore)
boolean	canAddRefs()
Capable	canPushToAtLeastOneRef()
boolean	canReadCommit(ReviewDb db, org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevCommit commit)
boolean	canRunReceivePack()
boolean	canRunUploadPack()
boolean	canUpload()
ChangeControl	controlFor(ChangeNotes notes)
ChangeControl	controlFor(ReviewDb db, Change change)
ChangeControl	controlForIndexedChange(Change change) Create a change control for a change that was loaded from index.
RefControl	controlForRef(Branch.NameKey ref)
RefControl	controlForRef(String refName)
ProjectControl	forUser(CurrentUser who)
Set<GroupReference>	getAllGroups()
LabelTypes	getLabelTypes()
Set<GroupReference>	getLocalGroups()
Project	getProject()
ProjectState	getProjectState()
CurrentUser	getUser()
boolean	isHidden() Returns whether the project is hidden.
boolean	isOwner() Is this user a project owner? Ownership does not imply isVisible()
boolean	isOwnerAnyRef() Does this user have ownership on at least one reference name?
boolean	isReadable() Returns whether the project is readable to the current user.
boolean	isVisible() Returns whether the project is accessible to the current user, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

VISIBLE

public static final int VISIBLE

See Also:

Constant Field Values

OWNER

public static final int OWNER

See Also:

Constant Field Values

Method Detail

forUser

public ProjectControl forUser(CurrentUser who)

controlFor

public ChangeControl controlFor(ReviewDb db,
                                Change change)
                         throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

controlForIndexedChange

public ChangeControl controlForIndexedChange(Change change)

Create a change control for a change that was loaded from index. This method should only be used when database access is harmful and potentially stale data from the index is acceptable.

Parameters:

change - change loaded from secondary index

Returns:

change control

controlFor

public ChangeControl controlFor(ChangeNotes notes)

controlForRef

public RefControl controlForRef(Branch.NameKey ref)

controlForRef

public RefControl controlForRef(String refName)

getUser

public CurrentUser getUser()

getProjectState

public ProjectState getProjectState()

getProject

public Project getProject()

getLabelTypes

public LabelTypes getLabelTypes()

isHidden

public boolean isHidden()

Returns whether the project is hidden.

isReadable

public boolean isReadable()

Returns whether the project is readable to the current user. Note that the project could still be hidden.

isVisible

public boolean isVisible()

Returns whether the project is accessible to the current user, i.e. readable and not hidden.

canAddRefs

public boolean canAddRefs()

canUpload

public boolean canUpload()

allRefsAreVisible

public boolean allRefsAreVisible()

Can this user see all the refs in this projects?

allRefsAreVisible

public boolean allRefsAreVisible(Set<String> ignore)

isOwner

public boolean isOwner()

Is this user a project owner? Ownership does not imply isVisible()

isOwnerAnyRef

public boolean isOwnerAnyRef()

Does this user have ownership on at least one reference name?

canPushToAtLeastOneRef

public Capable canPushToAtLeastOneRef()

Returns:

true if the user can upload to at least one reference

getAllGroups

public Set<GroupReference> getAllGroups()

getLocalGroups

public Set<GroupReference> getLocalGroups()

canRunUploadPack

public boolean canRunUploadPack()

canRunReceivePack

public boolean canRunReceivePack()

canReadCommit

public boolean canReadCommit(ReviewDb db,
                             org.eclipse.jgit.lib.Repository repo,
                             org.eclipse.jgit.revwalk.RevCommit commit)

Returns:

whether a commit is visible to user.