Package io.jenkins.plugins.bitbucketpushandpullrequest.processor

Class BitBucketPPRPayloadProcessor

java.lang.Object

io.jenkins.plugins.bitbucketpushandpullrequest.processor.BitBucketPPRPayloadProcessor

Direct Known Subclasses:

BitBucketPPRPullRequestCloudPayloadProcessor, BitBucketPPRPullRequestServerPayloadProcessor, BitBucketPPRRepositoryCloudPayloadProcessor, BitBucketPPRRepositoryServerPayloadProcessor

public abstract class BitBucketPPRPayloadProcessor
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final BitBucketPPRHookEvent	bitbucketEvent
protected final BitBucketPPRJobProbe	jobProbe

Constructor Summary

Constructors

Constructor	Description
BitBucketPPRPayloadProcessor(BitBucketPPRJobProbe jobProbe, BitBucketPPRHookEvent bitbucketEvent)

Method Summary

Modifier and Type	Method	Description
abstract BitBucketPPRAction	buildActionForJobs(BitBucketPPRPayload payload)	Builds the action for the given payload.
void	processPayload(BitBucketPPRPayload payload, BitBucketPPRObservable observable)	Builds the action and triggers matching jobs in a single step.
void	triggerMatchingJobs(BitBucketPPRAction action, BitBucketPPRObservable observable)	Triggers the jobs matching an already-built action.

Methods inherited from class java.lang.Object

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

Field Details

jobProbe

protected final BitBucketPPRJobProbe jobProbe

bitbucketEvent

protected final BitBucketPPRHookEvent bitbucketEvent

Constructor Details

BitBucketPPRPayloadProcessor

public BitBucketPPRPayloadProcessor(@Nonnull
 BitBucketPPRJobProbe jobProbe,
 @Nonnull
 BitBucketPPRHookEvent bitbucketEvent)

Method Details

buildActionForJobs

public abstract BitBucketPPRAction buildActionForJobs(@Nonnull
 BitBucketPPRPayload payload)
                                               throws BitBucketPPRPayloadPropertyNotFoundException

Builds the action for the given payload. Constructing the action validates that the payload carries the properties the event requires, so this is the point at which a malformed payload is rejected (with BitBucketPPRPayloadPropertyNotFoundException). Callers can invoke it before acknowledging the webhook, so a malformed request maps to a 4xx instead of a silent 200.

Throws:

BitBucketPPRPayloadPropertyNotFoundException

triggerMatchingJobs

public void triggerMatchingJobs(@Nonnull
 BitBucketPPRAction action,
 BitBucketPPRObservable observable)

Triggers the jobs matching an already-built action.

processPayload

public void processPayload(@Nonnull
 BitBucketPPRPayload payload,
 BitBucketPPRObservable observable)
                    throws BitBucketPPRPayloadPropertyNotFoundException

Builds the action and triggers matching jobs in a single step.

Throws:

BitBucketPPRPayloadPropertyNotFoundException