com.google.gerrit.common

Interface ChangeHooks

All Known Implementing Classes:

ChangeHookRunner, DisabledChangeHooks

public interface ChangeHooks

Invokes hooks on server actions.

Method Summary

Modifier and Type	Method and Description
void	doChangeAbandonedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, java.lang.String reason, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Change Abandoned Hook.
void	doChangeMergedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, com.google.gerrit.reviewdb.server.ReviewDb db, java.lang.String mergeResultRev) Fire the Change Merged Hook.
void	doChangeRestoredHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, java.lang.String reason, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Change Restored Hook.
void	doClaSignupHook(com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.common.data.ContributorAgreement cla)
void	doCommentAddedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, java.lang.String comment, java.util.Map<java.lang.String,java.lang.Short> approvals, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Comment Added Hook.
void	doDraftPublishedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.PatchSet patchSet, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Draft Published Hook.
void	doHashtagsChangedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, java.util.Set<java.lang.String> added, java.util.Set<java.lang.String> removed, java.util.Set<java.lang.String> hashtags, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the hashtags changed Hook.
void	doMergeFailedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, java.lang.String reason, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Merge Failed Hook.
void	doPatchsetCreatedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.PatchSet patchSet, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Patchset Created Hook.
void	doRefUpdatedHook(com.google.gerrit.reviewdb.client.Branch.NameKey refName, org.eclipse.jgit.lib.ObjectId oldId, org.eclipse.jgit.lib.ObjectId newId, com.google.gerrit.reviewdb.client.Account account) Fire the Ref Updated Hook
void	doRefUpdatedHook(com.google.gerrit.reviewdb.client.Branch.NameKey refName, org.eclipse.jgit.lib.RefUpdate refUpdate, com.google.gerrit.reviewdb.client.Account account) Fire the Ref Updated Hook
ChangeHookRunner.HookResult	doRefUpdateHook(com.google.gerrit.reviewdb.client.Project project, java.lang.String refName, com.google.gerrit.reviewdb.client.Account uploader, org.eclipse.jgit.lib.ObjectId oldId, org.eclipse.jgit.lib.ObjectId newId) Fire the Ref update Hook
void	doReviewerAddedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Reviewer Added Hook
void	doTopicChangedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, java.lang.String oldTopic, com.google.gerrit.reviewdb.server.ReviewDb db) Fire the Topic Changed Hook

Method Detail

doPatchsetCreatedHook

void doPatchsetCreatedHook(com.google.gerrit.reviewdb.client.Change change,
                           com.google.gerrit.reviewdb.client.PatchSet patchSet,
                           com.google.gerrit.reviewdb.server.ReviewDb db)
                    throws com.google.gwtorm.server.OrmException

Fire the Patchset Created Hook.

Parameters:

change - The change itself.

patchSet - The Patchset that was created.

Throws:

com.google.gwtorm.server.OrmException

doDraftPublishedHook

void doDraftPublishedHook(com.google.gerrit.reviewdb.client.Change change,
                          com.google.gerrit.reviewdb.client.PatchSet patchSet,
                          com.google.gerrit.reviewdb.server.ReviewDb db)
                   throws com.google.gwtorm.server.OrmException

Fire the Draft Published Hook.

Parameters:

change - The change itself.

patchSet - The Patchset that was published.

Throws:

com.google.gwtorm.server.OrmException

doCommentAddedHook

void doCommentAddedHook(com.google.gerrit.reviewdb.client.Change change,
                        com.google.gerrit.reviewdb.client.Account account,
                        com.google.gerrit.reviewdb.client.PatchSet patchSet,
                        java.lang.String comment,
                        java.util.Map<java.lang.String,java.lang.Short> approvals,
                        com.google.gerrit.reviewdb.server.ReviewDb db)
                 throws com.google.gwtorm.server.OrmException

Fire the Comment Added Hook.

Parameters:

change - The change itself.

patchSet - The patchset this comment is related to.

account - The gerrit user who added the comment.

comment - The comment given.

approvals - Map of label IDs to scores

Throws:

com.google.gwtorm.server.OrmException

doChangeMergedHook

void doChangeMergedHook(com.google.gerrit.reviewdb.client.Change change,
                        com.google.gerrit.reviewdb.client.Account account,
                        com.google.gerrit.reviewdb.client.PatchSet patchSet,
                        com.google.gerrit.reviewdb.server.ReviewDb db,
                        java.lang.String mergeResultRev)
                 throws com.google.gwtorm.server.OrmException

Fire the Change Merged Hook.

Parameters:

change - The change itself.

account - The gerrit user who submitted the change.

patchSet - The patchset that was merged.

mergeResultRev - The SHA-1 of the merge result revision.

Throws:

com.google.gwtorm.server.OrmException

doMergeFailedHook

void doMergeFailedHook(com.google.gerrit.reviewdb.client.Change change,
                       com.google.gerrit.reviewdb.client.Account account,
                       com.google.gerrit.reviewdb.client.PatchSet patchSet,
                       java.lang.String reason,
                       com.google.gerrit.reviewdb.server.ReviewDb db)
                throws com.google.gwtorm.server.OrmException

Fire the Merge Failed Hook.

Parameters:

change - The change itself.

account - The gerrit user who attempted to submit the change.

patchSet - The patchset that failed to merge.

reason - The reason that the change failed to merge.

Throws:

com.google.gwtorm.server.OrmException

doChangeAbandonedHook

void doChangeAbandonedHook(com.google.gerrit.reviewdb.client.Change change,
                           com.google.gerrit.reviewdb.client.Account account,
                           com.google.gerrit.reviewdb.client.PatchSet patchSet,
                           java.lang.String reason,
                           com.google.gerrit.reviewdb.server.ReviewDb db)
                    throws com.google.gwtorm.server.OrmException

Fire the Change Abandoned Hook.

Parameters:

change - The change itself.

account - The gerrit user who abandoned the change.

reason - Reason for abandoning the change.

Throws:

com.google.gwtorm.server.OrmException

doChangeRestoredHook

void doChangeRestoredHook(com.google.gerrit.reviewdb.client.Change change,
                          com.google.gerrit.reviewdb.client.Account account,
                          com.google.gerrit.reviewdb.client.PatchSet patchSet,
                          java.lang.String reason,
                          com.google.gerrit.reviewdb.server.ReviewDb db)
                   throws com.google.gwtorm.server.OrmException

Fire the Change Restored Hook.

Parameters:

change - The change itself.

account - The gerrit user who restored the change.

reason - Reason for restoring the change.

Throws:

com.google.gwtorm.server.OrmException

doRefUpdatedHook

void doRefUpdatedHook(com.google.gerrit.reviewdb.client.Branch.NameKey refName,
                      org.eclipse.jgit.lib.RefUpdate refUpdate,
                      com.google.gerrit.reviewdb.client.Account account)

Fire the Ref Updated Hook

Parameters:

refName - The updated project and branch.

refUpdate - An actual RefUpdate object

account - The gerrit user who moved the ref

doRefUpdatedHook

void doRefUpdatedHook(com.google.gerrit.reviewdb.client.Branch.NameKey refName,
                      org.eclipse.jgit.lib.ObjectId oldId,
                      org.eclipse.jgit.lib.ObjectId newId,
                      com.google.gerrit.reviewdb.client.Account account)

Fire the Ref Updated Hook

Parameters:

refName - The Branch.NameKey of the ref that was updated

oldId - The ref's old id

newId - The ref's new id

account - The gerrit user who moved the ref

doReviewerAddedHook

void doReviewerAddedHook(com.google.gerrit.reviewdb.client.Change change,
                         com.google.gerrit.reviewdb.client.Account account,
                         com.google.gerrit.reviewdb.client.PatchSet patchSet,
                         com.google.gerrit.reviewdb.server.ReviewDb db)
                  throws com.google.gwtorm.server.OrmException

Fire the Reviewer Added Hook

Parameters:

change - The change itself.

patchSet - The patchset that the reviewer was added on.

account - The gerrit user who was added as reviewer.

Throws:

com.google.gwtorm.server.OrmException

doTopicChangedHook

void doTopicChangedHook(com.google.gerrit.reviewdb.client.Change change,
                        com.google.gerrit.reviewdb.client.Account account,
                        java.lang.String oldTopic,
                        com.google.gerrit.reviewdb.server.ReviewDb db)
                 throws com.google.gwtorm.server.OrmException

Fire the Topic Changed Hook

Parameters:

change - The change itself.

account - The gerrit user who changed the topic.

oldTopic - The old topic name.

Throws:

com.google.gwtorm.server.OrmException

doClaSignupHook

void doClaSignupHook(com.google.gerrit.reviewdb.client.Account account,
                     com.google.gerrit.common.data.ContributorAgreement cla)

doRefUpdateHook

ChangeHookRunner.HookResult doRefUpdateHook(com.google.gerrit.reviewdb.client.Project project,
                                            java.lang.String refName,
                                            com.google.gerrit.reviewdb.client.Account uploader,
                                            org.eclipse.jgit.lib.ObjectId oldId,
                                            org.eclipse.jgit.lib.ObjectId newId)

Fire the Ref update Hook

Parameters:

project - The target project

refName - The Branch.NameKey of the ref provided by client

uploader - The gerrit user running the command

oldId - The ref's old id

newId - The ref's new id

doHashtagsChangedHook

void doHashtagsChangedHook(com.google.gerrit.reviewdb.client.Change change,
                           com.google.gerrit.reviewdb.client.Account account,
                           java.util.Set<java.lang.String> added,
                           java.util.Set<java.lang.String> removed,
                           java.util.Set<java.lang.String> hashtags,
                           com.google.gerrit.reviewdb.server.ReviewDb db)
                    throws com.google.gwtorm.server.OrmException

Fire the hashtags changed Hook.

Parameters:

change - The change

account - The gerrit user changing the hashtags

added - List of hashtags that were added to the change

removed - List of hashtags that were removed from the change

hashtags - List of hashtags on the change after adding or removing

db - The database

Throws:

com.google.gwtorm.server.OrmException