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

Class AbstractBitbucketWebhookConfigurationBuilderImpl

java.lang.Object

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

All Implemented Interfaces:

BitbucketWebhookConfigurationBuilder, NativeBitbucketWebhookConfigurationBuilder, ExtensionPoint

Direct Known Subclasses:

CloudWebhookConfigurationBuilderImpl, ServerWebhookConfigurationBuilderImpl

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

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected String	callbackRootURL
protected String	credentialsId
protected String	signatureId

Constructor Summary

Constructors

Constructor	Description
AbstractBitbucketWebhookConfigurationBuilderImpl()

Method Summary

Modifier and Type	Method	Description
NativeBitbucketWebhookConfigurationBuilder	autoManaged(String credentialsId)	Enable the auto manage of webhook for each repository in a Jenkins project.
BitbucketWebhookConfigurationBuilder	callbackRootURL(String callbackRootURL)	Set the Jenkins root URL used to send event payload.
NativeBitbucketWebhookConfigurationBuilder	signature(String credentialsId)	Enable the payload signature verification using the given StringCredentials.

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

build, getId

Field Details

credentialsId

protected String credentialsId

signatureId

protected String signatureId

callbackRootURL

protected String callbackRootURL

Constructor Details

AbstractBitbucketWebhookConfigurationBuilderImpl

public AbstractBitbucketWebhookConfigurationBuilderImpl()

Method Details

autoManaged

public NativeBitbucketWebhookConfigurationBuilder autoManaged(@NonNull
 String credentialsId)

Description copied from interface: BitbucketWebhookConfigurationBuilder

Enable the auto manage of webhook for each repository in a Jenkins project.

Specified by:

autoManaged in interface BitbucketWebhookConfigurationBuilder

Parameters:

credentialsId - with admin right to add, update or delete webhook of a bitbucket repository

Returns:

builder itself

signature

public NativeBitbucketWebhookConfigurationBuilder signature(@NonNull
 String credentialsId)

Description copied from interface: NativeBitbucketWebhookConfigurationBuilder

Enable the payload signature verification using the given StringCredentials.

Specified by:

signature in interface NativeBitbucketWebhookConfigurationBuilder

Parameters:

credentialsId - used to verify the signature sent with in payload

Returns:

the builder that can be used to customise a new instance of BitbucketWebhookConfiguration.

callbackRootURL

@NonNull
public BitbucketWebhookConfigurationBuilder callbackRootURL(String callbackRootURL)

Description copied from interface: BitbucketWebhookConfigurationBuilder

Set the Jenkins root URL used to send event payload.

Specified by:

callbackRootURL in interface BitbucketWebhookConfigurationBuilder

Parameters:

callbackRootURL - URL of Jenkins accessible from the Bitbucket server instance.

Returns:

builder itself