com.atlassian.bitbucket.hook.repository

Class AbstractRepositoryHookRequest

java.lang.Object

com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

All Implemented Interfaces:

RepositoryHookRequest

Direct Known Subclasses:

BranchHookRequest, FileEditHookRequest, SimpleMergeHookRequest, SimplePullRequestMergeHookRequest, SimpleRepositoryHookRequest, TagHookRequest

public abstract class AbstractRepositoryHookRequest
extends Object
implements RepositoryHookRequest

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.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractRepositoryHookRequest.AbstractBuilder<B extends AbstractRepositoryHookRequest.AbstractBuilder<B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRepositoryHookRequest(AbstractRepositoryHookRequest.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContext() Retrieves any additional context that was supplied to the request.
Collection<RefChange>	getRefChanges()
Repository	getRepository()
Optional<ScmHookDetails>	getScmHookDetails()
RepositoryHookTrigger	getTrigger()
boolean	isDryRun()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRepositoryHookRequest

protected AbstractRepositoryHookRequest(AbstractRepositoryHookRequest.AbstractBuilder<?> builder)

Method Detail

getContext

@Nonnull
public Map<String,Object> getContext()

Description copied from interface: RepositoryHookRequest

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.

Specified by:

getContext in interface RepositoryHookRequest

Returns:

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

getRefChanges

@Nonnull
public Collection<RefChange> getRefChanges()

Specified by:

getRefChanges in interface RepositoryHookRequest

Returns:

the proposed ref changes. Can be empty for some dry-run requests where the target hash is not yet known because the relevant commit hasn't been created yet. As an example, this is the case for merge requests. In these cases, the specialized request type should provide sufficient information about the proposed change. For MergeHookRequest, this would be MergeHookRequest.getFromRef() and MergeHookRequest.getToRef().

getRepository

@Nonnull
public Repository getRepository()

Specified by:

getRepository in interface RepositoryHookRequest

Returns:

the repository that's being updated

getScmHookDetails

@Nonnull
public Optional<ScmHookDetails> getScmHookDetails()

Specified by:

getScmHookDetails in interface RepositoryHookRequest

Returns:

SCM level hook details, if available. This will only be available when the hook is called synchronously as part of an SCM hook (such as pre-receive).

getTrigger

@Nonnull
public RepositoryHookTrigger getTrigger()

Specified by:

getTrigger in interface RepositoryHookRequest

Returns:

the trigger of the request. This allows hook to adapt their logic based on the trigger.

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface RepositoryHookRequest

Returns:

true if this hook is a dry-run request, otherwise false