Package com.cloudbees.jenkins.plugins.bitbucket.impl.webhook

Class AbstractWebhookProcessor

java.lang.Object

com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.AbstractWebhookProcessor

All Implemented Interfaces:

BitbucketWebhookProcessor, ExtensionPoint

Direct Known Subclasses:

CloudPullRequestWebhookProcessor, CloudPushWebhookProcessor, PluginPullRequestWebhookProcessor, PluginPushWebhookProcessor, ServerPingWebhookProcessor, ServerPullRequestWebhookProcessor, ServerPushWebhookProcessor

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public abstract class AbstractWebhookProcessor
extends Object
implements BitbucketWebhookProcessor

Abstract hook processor. Add new hook processors by extending this class and implement BitbucketWebhookProcessor.process(String, String, Map, BitbucketEndpoint), extract details from the hook payload and then fire an SCMEvent to dispatch it to the SCM API.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EVENT_TYPE_HEADER
protected final Logger	logger
protected static final String	REQUEST_ID_CLOUD_HEADER
protected static final String	REQUEST_ID_SERVER_HEADER
protected static final String	SERVER_URL_PARAMETER
protected static final String	SIGNATURE_HEADER

Fields inherited from interface com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookProcessor

SCAN_ON_EMPTY_CHANGES_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractWebhookProcessor()

Method Summary

Modifier and Type	Method	Description
String	getEventType(Map<String,String> headers, org.apache.commons.collections4.MultiValuedMap<String,String> parameters)	Extracts the event type that represent the payload in the request.
protected String	getOrigin(Map<String,Object> context)
String	getServerURL(Map<String,String> headers, org.apache.commons.collections4.MultiValuedMap<String,String> parameters)	Extracts the server URL from where this request coming from, the URL must match one of the configured BitbucketEndpoints.
protected void	scmSourceReIndex(String owner, String repository, String mirrorId)	To be called by implementations once the owner and the repository have been extracted from the payload.
void	verifyPayload(Map<String,String> headers, String body, BitbucketEndpoint endpoint)	The implementation must verify if the incoming request is secured or not eventually gather some settings from the given BitbucketEndpoint configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookProcessor

buildHookContext, canHandle, notifyEvent, process, reindexOnEmptyChanges

Field Details

logger

protected final Logger logger

REQUEST_ID_CLOUD_HEADER

protected static final String REQUEST_ID_CLOUD_HEADER

See Also:

• Constant Field Values

REQUEST_ID_SERVER_HEADER

protected static final String REQUEST_ID_SERVER_HEADER

See Also:

• Constant Field Values

SIGNATURE_HEADER

protected static final String SIGNATURE_HEADER

See Also:

• Constant Field Values

EVENT_TYPE_HEADER

protected static final String EVENT_TYPE_HEADER

See Also:

• Constant Field Values

SERVER_URL_PARAMETER

protected static final String SERVER_URL_PARAMETER

See Also:

• Constant Field Values

Constructor Details

AbstractWebhookProcessor

public AbstractWebhookProcessor()

Method Details

scmSourceReIndex

protected void scmSourceReIndex(String owner,
 String repository,
 String mirrorId)

To be called by implementations once the owner and the repository have been extracted from the payload.

Parameters:

owner - the repository owner as configured in the SCMSource

repository - the repository name as configured in the SCMSource

mirrorId - the mirror id if applicable, may be null

getServerURL

@NonNull
public String getServerURL(@NonNull
 Map<String,String> headers,
 @NonNull
 org.apache.commons.collections4.MultiValuedMap<String,String> parameters)

Description copied from interface: BitbucketWebhookProcessor

Extracts the server URL from where this request coming from, the URL must match one of the configured BitbucketEndpoints.

Specified by:

getServerURL in interface BitbucketWebhookProcessor

Parameters:

headers - request

parameters - request

Returns:

the URL of the server from where this request has been sent.

getEventType

@NonNull
public String getEventType(@NonNull
 Map<String,String> headers,
 @NonNull
 org.apache.commons.collections4.MultiValuedMap<String,String> parameters)

Description copied from interface: BitbucketWebhookProcessor

Extracts the event type that represent the payload in the request.

Specified by:

getEventType in interface BitbucketWebhookProcessor

Parameters:

headers - request

parameters - request

Returns:

the event type key.

verifyPayload

public void verifyPayload(@NonNull
 Map<String,String> headers,
 @NonNull
 String body,
 @NonNull
 BitbucketEndpoint endpoint)
                   throws BitbucketWebhookProcessorException

Description copied from interface: BitbucketWebhookProcessor

The implementation must verify if the incoming request is secured or not eventually gather some settings from the given BitbucketEndpoint configuration.

Specified by:

verifyPayload in interface BitbucketWebhookProcessor

Parameters:

headers - request

body - request

endpoint - configured for the given BitbucketWebhookProcessor.getServerURL(Map, MultiValuedMap)

Throws:

BitbucketWebhookProcessorException - when signature verification fails

getOrigin

protected String getOrigin(Map<String,Object> context)