ChangeHookRunner (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.common.ChangeHookRunner

All Implemented Interfaces:

ChangeHooks, EventDispatcher, EventSource, com.google.gerrit.extensions.events.LifecycleListener, com.google.gerrit.extensions.events.NewProjectCreatedListener, EventListener
```
public class ChangeHookRunner
extends Object
implements ChangeHooks, EventDispatcher, EventSource, com.google.gerrit.extensions.events.LifecycleListener, com.google.gerrit.extensions.events.NewProjectCreatedListener
```
Spawns local executables when a hook action occurs.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeHookRunner.HookResult` Container class used to hold the return code and output of script hook execution
`static class`	`ChangeHookRunner.Module`

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.events.NewProjectCreatedListener
com.google.gerrit.extensions.events.NewProjectCreatedListener.Event

Constructor Summary

Constructors
Constructor and Description
`ChangeHookRunner(WorkQueue queue, GitRepositoryManager repoManager, org.eclipse.jgit.lib.Config config, String anonymousCowardName, SitePaths sitePath, ProjectCache projectCache, AccountCache accountCache, EventFactory eventFactory, com.google.gerrit.extensions.registration.DynamicSet<EventListener> unrestrictedListeners)` Create a new ChangeHookRunner.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addEventListener(EventListener listener, CurrentUser user)`
`void`	`doChangeAbandonedHook(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.Account account, com.google.gerrit.reviewdb.client.PatchSet patchSet, 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, 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, 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, String comment, Map<String,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, Set<String> added, Set<String> removed, Set<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, 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`	`doProjectCreatedHook(com.google.gerrit.reviewdb.client.Project.NameKey project, String headName)` Fire the project 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, String refname, com.google.gerrit.reviewdb.client.Account uploader, org.eclipse.jgit.lib.ObjectId oldId, org.eclipse.jgit.lib.ObjectId newId)` Fire the 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, String oldTopic, com.google.gerrit.reviewdb.server.ReviewDb db)` Fire the Topic Changed Hook
`void`	`onNewProjectCreated(com.google.gerrit.extensions.events.NewProjectCreatedListener.Event event)`
`void`	`postEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName, Event event)` Post a stream event that is related to a branch
`void`	`postEvent(com.google.gerrit.reviewdb.client.Change change, Event event, com.google.gerrit.reviewdb.server.ReviewDb db)` Post a stream event that is related to a change
`void`	`removeEventListener(EventListener listener)`
`void`	`start()`
`void`	`stop()`

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

Constructor Detail

ChangeHookRunner

@Inject
public ChangeHookRunner(WorkQueue queue,
                       GitRepositoryManager repoManager,
                       org.eclipse.jgit.lib.Config config,
                       String anonymousCowardName,
                       SitePaths sitePath,
                       ProjectCache projectCache,
                       AccountCache accountCache,
                       EventFactory eventFactory,
                       com.google.gerrit.extensions.registration.DynamicSet<EventListener> unrestrictedListeners)

Create a new ChangeHookRunner.

Parameters:: queue - Queue to use when processing hooks.; repoManager - The repository manager.; config - Config file to use.; sitePath - The sitepath of this gerrit install.; projectCache - the project cache instance for the server.

Method Detail

addEventListener

public void addEventListener(EventListener listener,
                    CurrentUser user)

Specified by:: addEventListener in interface EventSource

removeEventListener
```
public void removeEventListener(EventListener listener)
```
Specified by:

removeEventListener in interface EventSource

doRefUpdateHook

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

Fire the update hook

Specified by:: doRefUpdateHook in interface ChangeHooks
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

doProjectCreatedHook
```
public void doProjectCreatedHook(com.google.gerrit.reviewdb.client.Project.NameKey project,
                        String headName)
```
Description copied from interface: ChangeHooks

Fire the project created hook

Specified by:

doProjectCreatedHook in interface ChangeHooks

Parameters:
project - The project that was created
headName - The head name of the created project

doPatchsetCreatedHook

public 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.

Specified by:: doPatchsetCreatedHook in interface ChangeHooks
Parameters:: change - The change itself.; patchSet - The Patchset that was created.
Throws:: com.google.gwtorm.server.OrmException

doDraftPublishedHook

public 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

Description copied from interface: ChangeHooks

Fire the Draft Published Hook.

Specified by:: doDraftPublishedHook in interface ChangeHooks
Parameters:: change - The change itself.; patchSet - The Patchset that was published.
Throws:: com.google.gwtorm.server.OrmException

doCommentAddedHook

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

Description copied from interface: ChangeHooks

Fire the Comment Added Hook.

Specified by:: doCommentAddedHook in interface ChangeHooks
Parameters:: change - The change itself.; account - The gerrit user who added the comment.; patchSet - The patchset this comment is related to.; comment - The comment given.; approvals - Map of label IDs to scores
Throws:: com.google.gwtorm.server.OrmException

doChangeMergedHook

public 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,
                      String mergeResultRev)
                        throws com.google.gwtorm.server.OrmException

Description copied from interface: ChangeHooks

Fire the Change Merged Hook.

Specified by:: doChangeMergedHook in interface ChangeHooks
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

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

Description copied from interface: ChangeHooks

Fire the Merge Failed Hook.

Specified by:: doMergeFailedHook in interface ChangeHooks
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

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

Description copied from interface: ChangeHooks

Fire the Change Abandoned Hook.

Specified by:: doChangeAbandonedHook in interface ChangeHooks
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

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

Description copied from interface: ChangeHooks

Fire the Change Restored Hook.

Specified by:: doChangeRestoredHook in interface ChangeHooks
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
```
public void doRefUpdatedHook(com.google.gerrit.reviewdb.client.Branch.NameKey refName,
                    org.eclipse.jgit.lib.RefUpdate refUpdate,
                    com.google.gerrit.reviewdb.client.Account account)
```
Description copied from interface: ChangeHooks

Fire the Ref Updated Hook

Specified by:

doRefUpdatedHook in interface ChangeHooks

Parameters:
refName - The updated project and branch.
refUpdate - An actual RefUpdate object
account - The gerrit user who moved the ref

doRefUpdatedHook
```
public 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)
```
Description copied from interface: ChangeHooks

Fire the Ref Updated Hook

Specified by:

doRefUpdatedHook in interface ChangeHooks

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

public 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

Description copied from interface: ChangeHooks

Fire the Reviewer Added Hook

Specified by:: doReviewerAddedHook in interface ChangeHooks
Parameters:: change - The change itself.; account - The gerrit user who was added as reviewer.; patchSet - The patchset that the reviewer was added on.
Throws:: com.google.gwtorm.server.OrmException

doTopicChangedHook

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

Description copied from interface: ChangeHooks

Fire the Topic Changed Hook

Specified by:: doTopicChangedHook in interface ChangeHooks
Parameters:: change - The change itself.; account - The gerrit user who changed the topic.; oldTopic - The old topic name.
Throws:: com.google.gwtorm.server.OrmException

doHashtagsChangedHook

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

Description copied from interface: ChangeHooks

Fire the hashtags changed Hook.

Specified by:: doHashtagsChangedHook in interface ChangeHooks
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

doClaSignupHook

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

Specified by:: doClaSignupHook in interface ChangeHooks

postEvent
```
public void postEvent(com.google.gerrit.reviewdb.client.Change change,
             Event event,
             com.google.gerrit.reviewdb.server.ReviewDb db)
               throws com.google.gwtorm.server.OrmException
```
Description copied from interface: EventDispatcher

Post a stream event that is related to a change

Specified by:

postEvent in interface EventDispatcher

Parameters:
change - The change that the event is related to
event - The event to post
db - The database

Throws:

com.google.gwtorm.server.OrmException

postEvent
```
public void postEvent(com.google.gerrit.reviewdb.client.Branch.NameKey branchName,
             Event event)
```
Description copied from interface: EventDispatcher

Post a stream event that is related to a branch

Specified by:

postEvent in interface EventDispatcher

Parameters:
branchName - The branch that the event is related to
event - The event to post

start
```
public void start()
```
Specified by:

start in interface com.google.gerrit.extensions.events.LifecycleListener

stop
```
public void stop()
```
Specified by:

stop in interface com.google.gerrit.extensions.events.LifecycleListener

onNewProjectCreated
```
public void onNewProjectCreated(com.google.gerrit.extensions.events.NewProjectCreatedListener.Event event)
```
Specified by:

onNewProjectCreated in interface com.google.gerrit.extensions.events.NewProjectCreatedListener

Class ChangeHookRunner

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.events.NewProjectCreatedListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChangeHookRunner

Method Detail

addEventListener

removeEventListener

doRefUpdateHook

doProjectCreatedHook

doPatchsetCreatedHook

doDraftPublishedHook

doCommentAddedHook

doChangeMergedHook

doMergeFailedHook

doChangeAbandonedHook

doChangeRestoredHook

doRefUpdatedHook

doRefUpdatedHook

doReviewerAddedHook

doTopicChangedHook

doHashtagsChangedHook

doClaSignupHook

postEvent

postEvent

start

stop

onNewProjectCreated