public interface

PreRepositoryHook

com.atlassian.bitbucket.hook.repository.PreRepositoryHook<T extends com.atlassian.bitbucket.hook.repository.RepositoryHookRequest>
Known Indirect Subclasses

Class Overview

Hook that is called for all veto-able changes to 1 or more Refs. Examples are: pushes, pull request merges, branch creation/deletion through the REST API, file-edit, etc.

Summary

Public Methods
void onEnd(PreRepositoryHookContext context, T request, RepositoryHookResult result)
Callback method that is called after all registered and enabled hooks have been called
@Nonnull RepositoryHookResult preUpdate(PreRepositoryHookContext context, T request)
Callback method that is called just before a request to update one or more refs is completed.

Public Methods

public void onEnd (PreRepositoryHookContext context, T request, RepositoryHookResult result)

Callback method that is called after all registered and enabled hooks have been called

Parameters
context provides hook settings and a way to obtain the commits added/removed
request the change request
result the combined outcome of all hooks that have been called, containing all vetoes returned by any of the hooks

@Nonnull public RepositoryHookResult preUpdate (PreRepositoryHookContext context, T request)

Callback method that is called just before a request to update one or more refs is completed.

Parameters
context provides hook settings and provides a way to obtain the commits added/removed
request provides the refs that are about to be updated.
Returns
  • the outcome of the repository hook