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

Class AbstractBitbucketWebhookConfiguration

java.lang.Object

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

All Implemented Interfaces:

BitbucketWebhookConfiguration, Describable<BitbucketWebhookConfiguration>

Direct Known Subclasses:

CloudWebhookConfiguration, ServerWebhookConfiguration

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractBitbucketWebhookConfiguration.AbstractBitbucketWebhookDescriptorImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBitbucketWebhookConfiguration(boolean manageHooks, String credentialsId, boolean enableHookSignature, String hookSignatureCredentialsId)

Method Summary

Modifier and Type	Method	Description
final String	getCredentialsId()	Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.
String	getDisplayName()	Name to use to describe the hook implementation.
String	getEndpointJenkinsRootURL()	A custom Jenkins root URL to be used by the webhook implementation as part of the receiver callback endpoint.
String	getHookSignatureCredentialsId()
boolean	isEnableHookSignature()
final boolean	isManageHooks()	Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.
void	setEndpointJenkinsRootURL(String endpointJenkinsRootURL)

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

getDescriptor, getId, getManager

Constructor Details

AbstractBitbucketWebhookConfiguration

protected AbstractBitbucketWebhookConfiguration(boolean manageHooks,
 @CheckForNull
 String credentialsId,
 boolean enableHookSignature,
 @CheckForNull
 String hookSignatureCredentialsId)

Method Details

isManageHooks

public final boolean isManageHooks()

Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

Specified by:

isManageHooks in interface BitbucketWebhookConfiguration

Returns:

true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

getCredentialsId

@CheckForNull
public final String getCredentialsId()

Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.

Specified by:

getCredentialsId in interface BitbucketWebhookConfiguration

Returns:

the IdCredentials.getId() of the credentials to use for auto-management of hooks.

getHookSignatureCredentialsId

@CheckForNull
public String getHookSignatureCredentialsId()

isEnableHookSignature

public boolean isEnableHookSignature()

getEndpointJenkinsRootURL

@CheckForNull
public String getEndpointJenkinsRootURL()

Description copied from interface: BitbucketWebhookConfiguration

A custom Jenkins root URL to be used by the webhook implementation as part of the receiver callback endpoint.

The returned value must ensure that ends with a slash /

Specified by:

getEndpointJenkinsRootURL in interface BitbucketWebhookConfiguration

Returns:

the verbatim setting provided by endpoint configuration

setEndpointJenkinsRootURL

@DataBoundSetter
public void setEndpointJenkinsRootURL(@CheckForNull
 String endpointJenkinsRootURL)

getDisplayName

@NonNull
public String getDisplayName()

Description copied from interface: BitbucketWebhookConfiguration

Name to use to describe the hook implementation.

Specified by:

getDisplayName in interface BitbucketWebhookConfiguration

Returns:

the name to use for the implementation