public abstract class


extends Object
implements RepositoryHookRequest
   ↳ com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class for the various RepositoryHookRequests. Plugins that want to invoke pre-hooks or post-hooks with a custom request type can use this class as a base class to provide the common request attributes.


Nested Classes
class AbstractRepositoryHookRequest.AbstractBuilder<B extends AbstractBuilder<B>>  
Protected Constructors
AbstractRepositoryHookRequest(AbstractBuilder<?> builder)
Public Methods
@Nonnull Map<StringObject> getContext()
Retrieves any additional context that was supplied to the request.
@Nonnull Collection<RefChange> getRefChanges()
@Nonnull Repository getRepository()
@Nonnull Optional<ScmHookDetails> getScmHookDetails()
@Nonnull RepositoryHookTrigger getTrigger()
boolean isDryRun()
Inherited Methods
From class java.lang.Object
From interface com.atlassian.bitbucket.hook.repository.RepositoryHookRequest

Protected Constructors

protected AbstractRepositoryHookRequest (AbstractBuilder<?> builder)

Public Methods

@Nonnull public Map<StringObject> getContext ()

Retrieves any additional context that was supplied to the request. This context is intended to allow plugin developers to implement their own behavior around ref-changes. As a result, its contents are unspecified; they depend on the installed plugins.

On dry runs, the context will always be empty.

  • additional context provided when the ref-change was requested, if any

@Nonnull public Collection<RefChange> getRefChanges ()

@Nonnull public Repository getRepository ()

@Nonnull public Optional<ScmHookDetails> getScmHookDetails ()

@Nonnull public RepositoryHookTrigger getTrigger ()

public boolean isDryRun ()