Package com.google.gerrit.server.git.validators

Class CommitValidators

java.lang.Object

com.google.gerrit.server.git.validators.CommitValidators

public class CommitValidators
extends Object

Represents a list of CommitValidationListeners to run for a push to one branch of one project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommitValidators.AmendedGerritMergeCommitValidationListener	Don't allow the user to amend a merge created by Gerrit Code Review.
static class	CommitValidators.AuthorUploaderValidator	Require that author matches the uploader.
static class	CommitValidators.BannedCommitsValidator	Reject banned commits.
static class	CommitValidators.ChangeIdValidator
static class	CommitValidators.CommitterUploaderValidator	Require that committer matches the uploader.
static class	CommitValidators.ConfigValidator	If this is the special project configuration branch, validate the config.
static class	CommitValidators.Factory
static class	CommitValidators.GroupCommitValidator	Rejects updates to group branches.
static class	CommitValidators.ProjectStateValidationListener	Rejects updates to projects that don't allow writes.
static class	CommitValidators.SignedOffByValidator
static class	CommitValidators.UploadMergesPermissionValidator	Require permission to upload merge commits.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	NEW_PATCHSET_PATTERN

Method Summary

Modifier and Type	Method	Description
static CommitValidationMessage	invalidEmail(String type, org.eclipse.jgit.lib.PersonIdent who, IdentifiedUser currentUser, UrlFormatter urlFormatter)
CommitValidators	invokeCommitValidationInfoListeners(boolean invokeCommitValidationInfoListeners)	Whether the CommitValidationInfoListeners should be invoked after the validation is done.
CommitValidators	patchSet(PatchSet.Id patchSetId)	Sets the patch set for which the validation is done.
com.google.common.collect.ImmutableMap<String,CommitValidationInfo>	validate(CommitReceivedEvent receiveEvent)

Methods inherited from class java.lang.Object

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

Field Details

NEW_PATCHSET_PATTERN

public static final Pattern NEW_PATCHSET_PATTERN

Method Details

patchSet

@CanIgnoreReturnValue
public CommitValidators patchSet(PatchSet.Id patchSetId)

Sets the patch set for which the validation is done.

If the validation is done for a commit that is not associated with a patch set (e.g. when commits are pushed directly, bypassing code-review) this method doesn't need to be called.

Parameters:

patchSetId - the patch set for which the validation is done

Returns:

the CommitValidators instance to allow chaining calls

invokeCommitValidationInfoListeners

@CanIgnoreReturnValue
public CommitValidators invokeCommitValidationInfoListeners(boolean invokeCommitValidationInfoListeners)

Whether the CommitValidationInfoListeners should be invoked after the validation is done.

If invoking the CommitValidationInfoListeners is skipped, it's the responsibility of the caller to invoke them later. For example, this makes sense when commits are validated and the information about the change/patch-set (see patchSet(com.google.gerrit.entities.PatchSet.Id) is not available yet.

Parameters:

invokeCommitValidationInfoListeners - Whether the CommitValidationInfoListeners should be invoked after the validation is done.

Returns:

the CommitValidators instance to allow chaining calls

validate

@CanIgnoreReturnValue
public com.google.common.collect.ImmutableMap<String,CommitValidationInfo> validate(CommitReceivedEvent receiveEvent)
                                                                             throws CommitValidationException

Throws:

CommitValidationException

invalidEmail

public static CommitValidationMessage invalidEmail(String type,
 org.eclipse.jgit.lib.PersonIdent who,
 IdentifiedUser currentUser,
 UrlFormatter urlFormatter)