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

Interface BitbucketEndpoint

All Superinterfaces:
Describable<BitbucketEndpoint>
All Known Implementing Classes:
AbstractBitbucketEndpoint, BitbucketCloudEndpoint, BitbucketServerEndpoint
public interface BitbucketEndpoint extends Describable<BitbucketEndpoint>
The implementation represents an endpoint configuration to be used in BitbucketSCMSource.
Since:
936.4.0

  • Method Details

    • getDisplayName

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

    • getRepositoryURL

      @NonNull String getRepositoryURL(@NonNull String repoOwner, @NonNull String repoSlug)
      The user facing URL of the specified repository.
      Parameters:
      repoOwner - the repository owner.
      repoSlug - the repository name
      Returns:
      the user facing URL of the specified repository.

    • getType

      @NonNull EndpointType getType()
      Returns the type of this endpoint.
      Returns:
      endpoint type.

    • getServerURL

      @NonNull String getServerURL()
      The URL of this endpoint.
      Returns:
      the URL of the endpoint.

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

    • setManageHooks

      void setManageHooks(boolean manageHooks, @CheckForNull String credentialsId)
      Sets if Jenkins is supposed to auto-manage hooks for this end-point.
      Parameters:
      manageHooks - if Jenkins must auto-manage hooks registration.
      credentialsId - credentialsId to use with rights to create or update web hook for Bitbucket repositories.

    • 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()
      Jenkins Server Root URL to be used by this Bitbucket endpoint. The global setting from Jenkins.get().getRootUrl() will be used if this field is null or equals an empty string.
      Returns:
      the verbatim setting provided by endpoint configuration

    • isEnableHookSignature

      @Restricted(org.kohsuke.accmod.restrictions.Beta.class) boolean isEnableHookSignature()
      Returns if the should or not verify incoming web hook payload from this endpoint.
      Returns:
      the true if the web hook implementation configured for this endpoint should or not verify web hook payload that could be signed or crypted.
      API Note:
      This method is under development so could be moved to an interface dedicated to webhooks implementation

    • getHookSignatureCredentialsId

      @Restricted(org.kohsuke.accmod.restrictions.Beta.class) @CheckForNull String getHookSignatureCredentialsId()
      The IdCredentials.getId() of the credentials to use to verify the signature of hooks.
      Returns:
      the configured credentials identifier to use
      API Note:
      This method is under development so could be moved to an interface dedicated to webhooks implementation

    • credentials

      @CheckForNull default com.cloudbees.plugins.credentials.common.StandardCredentials credentials()
      Looks up the StandardCredentials to use for auto-management of hooks.
      Returns:
      the credentials or null.

    • hookSignatureCredentials

      @Restricted(org.kohsuke.accmod.restrictions.Beta.class) @CheckForNull default org.jenkinsci.plugins.plaincredentials.StringCredentials hookSignatureCredentials()
      Looks up the StringCredentials to use to verify the signature of hooks.
      Returns:
      the credentials or null.
      API Note:
      This method is under development so could be moved to an interface dedicated to webhook provider

    • isEquals

      default boolean isEquals(BitbucketEndpoint endpoint)
      Returns if two endpoint are the equals.
      Parameters:
      endpoint - to compare
      Returns:
      true if endpoint are the same, false otherwise

    • getDescriptor

      BitbucketEndpointDescriptor getDescriptor()
      Specified by:
      getDescriptor in interface Describable<BitbucketEndpoint>
      See Also: