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

Interface BitbucketWebhookConfiguration

All Superinterfaces:
Describable<BitbucketWebhookConfiguration>
All Known Implementing Classes:
AbstractBitbucketWebhookConfiguration, CloudWebhookConfiguration, PluginWebhookConfiguration, ServerWebhookConfiguration
public interface BitbucketWebhookConfiguration extends Describable<BitbucketWebhookConfiguration>
The implementation represents an a webhook configuration that can be used in a BitbucketEndpoint.
Since:
937.0.0

  • Method Details

    • getDisplayName

      @CheckForNull String getDisplayName()
      Name to use to describe the hook implementation.
      Returns:
      the name to use for the implementation

    • getId

      @NonNull String getId()
      The hook implementation identifier.
      Returns:
      the unique identifier for this implementation

    • isManageHooks

      boolean isManageHooks()
      Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.
      Returns:
      true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

    • getCredentialsId

      @CheckForNull String getCredentialsId()
      Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.
      Returns:
      the IdCredentials.getId() of the credentials to use for auto-management of hooks.

    • getEndpointJenkinsRootURL

      @CheckForNull String getEndpointJenkinsRootURL()
      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 /

      Returns:
      the verbatim setting provided by endpoint configuration

    • getDefaultJenkinsRootURL

      @NonNull static String getDefaultJenkinsRootURL()
      Returns the global setting from Jenkins.get().getRootUrl().
      Returns:
      Jenkins URL defined in the global configuration page.

    • getManager

      Class<? extends BitbucketWebhookManager> getManager()
      Returns the implementation that is in charge to apply this configuration to the Bitbucket.
      Returns:
      a manager class specific for this configuration.

    • getDescriptor

      default BitbucketWebhookDescriptor getDescriptor()
      Specified by:
      getDescriptor in interface Describable<BitbucketWebhookConfiguration>
      See Also: