ProjectConfig (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.VersionedMetaData
- - com.google.gerrit.server.git.ProjectConfig

public class ProjectConfig
extends VersionedMetaData

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData
  VersionedMetaData.BatchMetaDataUpdate

Field Summary

Fields
Modifier and Type Field and Description

static String COMMENTLINK

static String PROJECT_CONFIG
- Fields inherited from class com.google.gerrit.server.git.VersionedMetaData
  inserter, newTree, reader

Fields
Modifier and Type	Field and Description
`static String`	`COMMENTLINK`
`static String`	`PROJECT_CONFIG`

Constructor Summary

Constructors
Constructor and Description

ProjectConfig(com.google.gerrit.reviewdb.client.Project.NameKey projectName)

Constructors
Constructor and Description
`ProjectConfig(com.google.gerrit.reviewdb.client.Project.NameKey projectName)`

Method Summary

Methods
Modifier and Type	Method and Description
`static CommentLinkInfo`	`buildCommentLink(org.eclipse.jgit.lib.Config cfg, String name, boolean allowRaw)`
`com.google.gerrit.common.data.AccessSection`	`getAccessSection(String name)`
`com.google.gerrit.common.data.AccessSection`	`getAccessSection(String name, boolean create)`
`Collection<com.google.gerrit.common.data.AccessSection>`	`getAccessSections()`
`AccountsSection`	`getAccountsSection()`
`Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID>`	`getAllGroupUUIDs()`
`BranchOrderSection`	`getBranchOrderSection()`
`boolean`	`getCheckReceivedObjects()`
`Collection<CommentLinkInfo>`	`getCommentLinkSections()`
`com.google.gerrit.common.data.ContributorAgreement`	`getContributorAgreement(String name)`
`com.google.gerrit.common.data.ContributorAgreement`	`getContributorAgreement(String name, boolean create)`
`Collection<com.google.gerrit.common.data.ContributorAgreement>`	`getContributorAgreements()`
`com.google.gerrit.common.data.GroupReference`	`getGroup(com.google.gerrit.reviewdb.client.AccountGroup.UUID uuid)`
`Map<String,com.google.gerrit.common.data.LabelType>`	`getLabelSections()`
`long`	`getMaxObjectSizeLimit()`
`ConfiguredMimeTypes`	`getMimeTypes()`
`Collection<NotifyConfig>`	`getNotifyConfigs()`
`PluginConfig`	`getPluginConfig(String pluginName)`
`com.google.gerrit.reviewdb.client.Project`	`getProject()`
`protected String`	`getRefName()`
`org.eclipse.jgit.lib.ObjectId`	`getRulesId()`
`List<ValidationError>`	`getValidationErrors()` Get the validation errors, if any were discovered during load.
`protected void`	`onLoad()` Set up the metadata, parsing any state from the loaded revision.
`protected boolean`	`onSave(org.eclipse.jgit.lib.CommitBuilder commit)` Save any changes to the metadata in a commit.
`static ProjectConfig`	`read(MetaDataUpdate update)`
`static ProjectConfig`	`read(MetaDataUpdate update, org.eclipse.jgit.lib.ObjectId id)`
`void`	`remove(com.google.gerrit.common.data.AccessSection section)`
`void`	`remove(com.google.gerrit.common.data.ContributorAgreement section)`
`void`	`replace(com.google.gerrit.common.data.AccessSection section)`
`void`	`replace(com.google.gerrit.common.data.ContributorAgreement section)`
`com.google.gerrit.common.data.GroupReference`	`resolve(com.google.gerrit.reviewdb.client.AccountGroup group)`
`com.google.gerrit.common.data.GroupReference`	`resolve(com.google.gerrit.common.data.GroupReference group)`
`boolean`	`updateGroupNames(GroupBackend groupBackend)` Check all GroupReferences use current group name, repairing stale ones.
`static String`	`validMaxObjectSizeLimit(String value)`

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData
commit, commitToNewRef, getObjectId, getRevision, load, load, load, load, openUpdate, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- COMMENTLINK
```
public static final String COMMENTLINK
```
  See Also:
  Constant Field Values
- PROJECT_CONFIG
```
public static final String PROJECT_CONFIG
```
  See Also:
  Constant Field Values

Constructor Detail

ProjectConfig

public ProjectConfig(com.google.gerrit.reviewdb.client.Project.NameKey projectName)

Method Detail

read

public static ProjectConfig read(MetaDataUpdate update)
                          throws IOException,
                                 org.eclipse.jgit.errors.ConfigInvalidException

Throws:: IOException; org.eclipse.jgit.errors.ConfigInvalidException

read

public static ProjectConfig read(MetaDataUpdate update,
                 org.eclipse.jgit.lib.ObjectId id)
                          throws IOException,
                                 org.eclipse.jgit.errors.ConfigInvalidException

Throws:: IOException; org.eclipse.jgit.errors.ConfigInvalidException

buildCommentLink

public static CommentLinkInfo buildCommentLink(org.eclipse.jgit.lib.Config cfg,
                               String name,
                               boolean allowRaw)
                                        throws IllegalArgumentException

Throws:: IllegalArgumentException

getProject

public com.google.gerrit.reviewdb.client.Project getProject()

getAccountsSection

public AccountsSection getAccountsSection()

getAccessSection

public com.google.gerrit.common.data.AccessSection getAccessSection(String name)

getAccessSection

public com.google.gerrit.common.data.AccessSection getAccessSection(String name,
                                                           boolean create)

getAccessSections

public Collection<com.google.gerrit.common.data.AccessSection> getAccessSections()

getBranchOrderSection

public BranchOrderSection getBranchOrderSection()

remove

public void remove(com.google.gerrit.common.data.AccessSection section)

replace

public void replace(com.google.gerrit.common.data.AccessSection section)

getContributorAgreement

public com.google.gerrit.common.data.ContributorAgreement getContributorAgreement(String name)

getContributorAgreement

public com.google.gerrit.common.data.ContributorAgreement getContributorAgreement(String name,
                                                                         boolean create)

getContributorAgreements

public Collection<com.google.gerrit.common.data.ContributorAgreement> getContributorAgreements()

remove

public void remove(com.google.gerrit.common.data.ContributorAgreement section)

replace

public void replace(com.google.gerrit.common.data.ContributorAgreement section)

getNotifyConfigs

public Collection<NotifyConfig> getNotifyConfigs()

getLabelSections

public Map<String,com.google.gerrit.common.data.LabelType> getLabelSections()

getCommentLinkSections

public Collection<CommentLinkInfo> getCommentLinkSections()

getMimeTypes

public ConfiguredMimeTypes getMimeTypes()

resolve

public com.google.gerrit.common.data.GroupReference resolve(com.google.gerrit.reviewdb.client.AccountGroup group)

resolve

public com.google.gerrit.common.data.GroupReference resolve(com.google.gerrit.common.data.GroupReference group)

getGroup

public com.google.gerrit.common.data.GroupReference getGroup(com.google.gerrit.reviewdb.client.AccountGroup.UUID uuid)

Returns:: the group reference, if the group is used by at least one rule.

getAllGroupUUIDs

public Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID> getAllGroupUUIDs()

Returns:: set of all groups used by this configuration.

getRulesId
```
public org.eclipse.jgit.lib.ObjectId getRulesId()
```
Returns:
the project's rules.pl ObjectId, if present in the branch. Null if it doesn't exist.

getMaxObjectSizeLimit
```
public long getMaxObjectSizeLimit()
```
Returns:
the maxObjectSizeLimit for this project, if set. Zero if this project doesn't define own maxObjectSizeLimit.

getCheckReceivedObjects
```
public boolean getCheckReceivedObjects()
```
Returns:
the checkReceivedObjects for this project, default is true.

updateGroupNames
```
public boolean updateGroupNames(GroupBackend groupBackend)
```
Check all GroupReferences use current group name, repairing stale ones.

Parameters:
groupBackend - cache to use when looking up group information by UUID.

Returns:
true if one or more group names was stale.

getValidationErrors
```
public List<ValidationError> getValidationErrors()
```
Get the validation errors, if any were discovered during load.

Returns:
list of errors; empty list if there are no errors.

getRefName
```
protected String getRefName()
```
Specified by:

getRefName in class VersionedMetaData

Returns:
name of the reference storing this configuration.

onLoad
```
protected void onLoad()
               throws IOException,
                      org.eclipse.jgit.errors.ConfigInvalidException
```
Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException

getPluginConfig

public PluginConfig getPluginConfig(String pluginName)

onSave
```
protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)
                  throws IOException,
                         org.eclipse.jgit.errors.ConfigInvalidException
```
Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:
true if the commit should proceed, false to abort.

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException

validMaxObjectSizeLimit

public static final String validMaxObjectSizeLimit(String value)
                                            throws org.eclipse.jgit.errors.ConfigInvalidException

Throws:: org.eclipse.jgit.errors.ConfigInvalidException

Class ProjectConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData

Field Summary

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData

Methods inherited from class java.lang.Object

Field Detail

COMMENTLINK

PROJECT_CONFIG

Constructor Detail

ProjectConfig

Method Detail

read

read

buildCommentLink

getProject

getAccountsSection

getAccessSection

getAccessSection

getAccessSections

getBranchOrderSection

remove

replace

getContributorAgreement

getContributorAgreement

getContributorAgreements

remove

replace

getNotifyConfigs

getLabelSections

getCommentLinkSections

getMimeTypes

resolve

resolve

getGroup

getAllGroupUUIDs

getRulesId

getMaxObjectSizeLimit

getCheckReceivedObjects

updateGroupNames

getValidationErrors

getRefName

onLoad

getPluginConfig

onSave

validMaxObjectSizeLimit