Class BitBucketPPRPluginConfig

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.bitbucketpushandpullrequest.config.BitBucketPPRPluginConfig

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
public class BitBucketPPRPluginConfig
extends GlobalConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BITBUCKET_PPR_PLUGIN_CONFIGURATION_ID
String	credentialsId
String	hookUrl
boolean	notifyBitBucket
String	propagationUrl
boolean	setBitbucketPayload
boolean	setBitbucketPrDescription
String	singleJob
boolean	useJobNameAsBuildKey
String	webhookSecretCredentialsId

Fields inherited from class Descriptor

clazz

Fields inherited from interface Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
BitBucketPPRPluginConfig()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
FormValidation	doCheckPropagationUrl(String value)
ListBoxModel	doFillCredentialsIdItems(Item context, String remote, String credentialsId)
ListBoxModel	doFillWebhookSecretCredentialsIdItems(String webhookSecretCredentialsId)
String	getCredentialsId()
String	getDisplayName()
String	getHookUrl()
static BitBucketPPRPluginConfig	getInstance()
boolean	getNotifyBitBucket()
String	getPropagationUrl()
boolean	getSetBitbucketPayload()
boolean	getSetBitbucketPrDescription()
String	getSingleJob()
boolean	getUseJobNameAsBuildKey()
String	getWebhookSecret()	Resolves the configured webhook secret credential to its plain text, or returns null when no credential is configured or the configured id cannot be resolved.
String	getWebhookSecretCredentialsId()
boolean	isHookUrlSet()
boolean	isPropagationUrlSet()
boolean	isSingleJobSet()
boolean	isWebhookSecretSet()
void	setCredentialsId(String credentialsId)
void	setHookUrl(String hookUrl)
void	setNotifyBitBucket(boolean notifyBitBucket)
void	setPropagationUrl(String propagationUrl)
void	setSetBitbucketPayload(boolean setBitbucketPayload)
void	setSetBitbucketPrDescription(boolean setBitbucketPrDescription)
void	setSingleJob(String singleJob)
void	setUseJobNameAsBuildKey(boolean useJobNameAsBuildKey)
void	setWebhookSecretCredentialsId(String webhookSecretCredentialsId)

Methods inherited from class GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class Object

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

Field Details

BITBUCKET_PPR_PLUGIN_CONFIGURATION_ID

public static final String BITBUCKET_PPR_PLUGIN_CONFIGURATION_ID

See Also:

• Constant Field Values

hookUrl

public String hookUrl

notifyBitBucket

public boolean notifyBitBucket

useJobNameAsBuildKey

public boolean useJobNameAsBuildKey

credentialsId

public String credentialsId

webhookSecretCredentialsId

public String webhookSecretCredentialsId

singleJob

public String singleJob

propagationUrl

public String propagationUrl

setBitbucketPayload

public boolean setBitbucketPayload

setBitbucketPrDescription

public boolean setBitbucketPrDescription

Constructor Details

BitBucketPPRPluginConfig

public BitBucketPPRPluginConfig()

Method Details

getInstance

public static BitBucketPPRPluginConfig getInstance()

setHookUrl

@DataBoundSetter
public void setHookUrl(String hookUrl)

setPropagationUrl

@DataBoundSetter
public void setPropagationUrl(String propagationUrl)

doCheckPropagationUrl

@POST
public FormValidation doCheckPropagationUrl(@QueryParameter
 String value)

isHookUrlSet

public boolean isHookUrlSet()

getHookUrl

public String getHookUrl()

getNotifyBitBucket

public boolean getNotifyBitBucket()

getPropagationUrl

public String getPropagationUrl()

isPropagationUrlSet

public boolean isPropagationUrlSet()

setNotifyBitBucket

@DataBoundSetter
public void setNotifyBitBucket(boolean notifyBitBucket)

getSetBitbucketPayload

public boolean getSetBitbucketPayload()

setSetBitbucketPayload

@DataBoundSetter
public void setSetBitbucketPayload(boolean setBitbucketPayload)

getSetBitbucketPrDescription

public boolean getSetBitbucketPrDescription()

setSetBitbucketPrDescription

@DataBoundSetter
public void setSetBitbucketPrDescription(boolean setBitbucketPrDescription)

getUseJobNameAsBuildKey

public boolean getUseJobNameAsBuildKey()

setUseJobNameAsBuildKey

@DataBoundSetter
public void setUseJobNameAsBuildKey(boolean useJobNameAsBuildKey)

setCredentialsId

@DataBoundSetter
public void setCredentialsId(@CheckForNull
 String credentialsId)

getCredentialsId

public String getCredentialsId()

setWebhookSecretCredentialsId

@DataBoundSetter
public void setWebhookSecretCredentialsId(@CheckForNull
 String webhookSecretCredentialsId)

getWebhookSecretCredentialsId

public String getWebhookSecretCredentialsId()

isWebhookSecretSet

public boolean isWebhookSecretSet()

getWebhookSecret

@CheckForNull
public String getWebhookSecret()

Resolves the configured webhook secret credential to its plain text, or returns null when no credential is configured or the configured id cannot be resolved. The credential is looked up on every call so that rotating the secret takes effect without a restart.

setSingleJob

@DataBoundSetter
public void setSingleJob(String singleJob)

isSingleJobSet

public boolean isSingleJobSet()

getSingleJob

public String getSingleJob()

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
 net.sf.json.JSONObject formData)

Overrides:

configure in class GlobalConfiguration

doFillCredentialsIdItems

@POST
public ListBoxModel doFillCredentialsIdItems(@AncestorInPath
 Item context,
 @QueryParameter
 String remote,
 @QueryParameter
 String credentialsId)

doFillWebhookSecretCredentialsIdItems

@POST
public ListBoxModel doFillWebhookSecretCredentialsIdItems(@QueryParameter
 String webhookSecretCredentialsId)