@Deprecated public interface

PreReceiveHook

com.atlassian.bitbucket.hook.PreReceiveHook

This interface is deprecated.
in 5.0 for removal in 6.0. Use a repository-hook module and implement PreRepositoryHook instead. Set configurable="false" on the module to create a hook that is enabled for all repositories and check the hook trigger to only respond to pushes

Class Overview

Hook that is called just before a push request is completed.

Summary

Public Methods
boolean onReceive(Repository repository, Collection<RefChange> refChanges, HookResponse hookResponse)
Callback method that is called just before a push request is completed.

Public Methods

public boolean onReceive (Repository repository, Collection<RefChange> refChanges, HookResponse hookResponse)

Callback method that is called just before a push request is completed. This hook executes during the processing of a push and the client will have to wait during the execution of the onReceive method.

Parameters
repository the repository that was pushed to
refChanges the refs that are about to be updated
hookResponse used to write to the client's stdout and/or stderr
Returns
  • true if the push request is to be accepted, false if it should be rejected. Note that returning true does not guarantee that the push will be accepted as there may be other PreReceiveHooks that reject the push.