com.atlassian.bitbucket.hook.repository

Class SimpleRepositoryHookRequest

java.lang.Object

com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

com.atlassian.bitbucket.hook.repository.SimpleRepositoryHookRequest

All Implemented Interfaces:

RepositoryHookRequest

Direct Known Subclasses:

RepositoryPushHookRequest

public class SimpleRepositoryHookRequest
extends AbstractRepositoryHookRequest

Basic implementation of RepositoryHookRequest

Since:

5.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Collection<RefChange>	getRefChanges()
Optional<ScmHookDetails>	getScmHookDetails()

Methods inherited from class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

getContext, getRepository, getTrigger, isDryRun

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRepositoryHookRequest

protected SimpleRepositoryHookRequest(SimpleRepositoryHookRequest.AbstractBuilder<?> builder)

Method Detail

getRefChanges

@Nonnull
public Collection<RefChange> getRefChanges()

Specified by:

getRefChanges in interface RepositoryHookRequest

Overrides:

getRefChanges in class AbstractRepositoryHookRequest

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().

getScmHookDetails

@Nonnull
public Optional<ScmHookDetails> getScmHookDetails()

Specified by:

getScmHookDetails in interface RepositoryHookRequest

Overrides:

getScmHookDetails in class AbstractRepositoryHookRequest

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