[JENKINS-75857] Add method to set web hook credentials to BitbucketEndpoints (#1080)

nfalco79 · web-flow · commit d7299a84015e · 2025-07-05T22:47:28.000+02:00
Add method to enable or disable hook management when register a new bitbucket endpoint.
Set hook signature verification as Beta since they could be moved to different interface or provider with the develop of JENKINS-74913
diff --git a/pom.xml b/pom.xml
@@ -218,6 +218,19 @@
                         </dependency>
                     </dependencies>
                 </plugin>
+                <plugin>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>${maven-javadoc-plugin.version}</version>
+                    <configuration>
+                        <tags>
+                            <tag>
+                                <name>apiNote</name>
+                                <placement>a</placement>
+                                <head>API Note:</head>
+                            </tag>
+                        </tags>
+                    </configuration>
+                </plugin>
             </plugins>
         </pluginManagement>
         <plugins>
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/endpoint/BitbucketEndpoint.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/endpoint/BitbucketEndpoint.java
@@ -34,6 +34,8 @@
 import jenkins.model.Jenkins;
 import org.apache.commons.lang3.StringUtils;
 import org.jenkinsci.plugins.plaincredentials.StringCredentials;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.Beta;
 
 /**
  * The implementation represents an endpoint configuration to be used in
@@ -86,6 +88,15 @@ public interface BitbucketEndpoint extends Describable<BitbucketEndpoint> {
      */
     boolean isManageHooks();
 
+    /**
+     * Sets if Jenkins is supposed to auto-manage hooks for this end-point.
+     *
+     * @param manageHooks   if Jenkins must auto-manage hooks registration.
+     * @param credentialsId credentialsId to use with rights to create or update web
+     *                      hook for Bitbucket repositories.
+     */
+    void setManageHooks(boolean manageHooks, @CheckForNull String credentialsId);
+
     /**
      * Returns the {@link StandardUsernamePasswordCredentials#getId()} of the
      * credentials to use for auto-management of hooks.
@@ -106,14 +117,30 @@ public interface BitbucketEndpoint extends Describable<BitbucketEndpoint> {
     @CheckForNull
     String getEndpointJenkinsRootURL();
 
+    /**
+     * Returns if the should or not verify incoming web hook payload from this
+     * endpoint.
+     *
+     * @apiNote This method is under development so could be moved to an interface
+     *          dedicated to webhooks implementation
+     *
+     * @return the {@code true} if the web hook implementation configured for this
+     *         endpoint should or not verify web hook payload that could be signed
+     *         or crypted.
+     */
+    @Restricted(Beta.class)
     boolean isEnableHookSignature();
 
     /**
-     * The {@link StringCredentials#getId()} of the credentials to use to verify
-     * the signature of hooks.
+     * The {@link StringCredentials#getId()} of the credentials to use to verify the
+     * signature of hooks.
+     *
+     * @apiNote This method is under development so could be moved to an interface
+     *          dedicated to webhooks implementation
      *
      * @return the configured credentials identifier to use
      */
+    @Restricted(Beta.class)
     @CheckForNull
     String getHookSignatureCredentialsId();
 
@@ -133,10 +160,15 @@ default StandardCredentials credentials() {
     }
 
     /**
-     * Looks up the {@link StringCredentials} to use to verify the signature of hooks.
+     * Looks up the {@link StringCredentials} to use to verify the signature of
+     * hooks.
+     *
+     * @apiNote This method is under development so could be moved to an interface
+     *          dedicated to webhook provider
      *
      * @return the credentials or {@code null}.
      */
+    @Restricted(Beta.class)
     @CheckForNull
     default StringCredentials hookSignatureCredentials() {
         String credentialsId = Util.fixEmptyAndTrim(getHookSignatureCredentialsId());
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/AbstractBitbucketEndpoint.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/AbstractBitbucketEndpoint.java
@@ -53,13 +53,13 @@ public abstract class AbstractBitbucketEndpoint implements BitbucketEndpoint {
     /**
      * {@code true} if and only if Jenkins is supposed to auto-manage hooks for this end-point.
      */
-    private final boolean manageHooks;
+    private boolean manageHooks;
 
     /**
      * The {@link StandardCredentials#getId()} of the credentials to use for auto-management of hooks.
      */
     @CheckForNull
-    private final String credentialsId;
+    private String credentialsId;
 
     /**
      * {@code true} if and only if Jenkins have to verify the signature of all incoming hooks.
@@ -96,6 +96,12 @@ public abstract class AbstractBitbucketEndpoint implements BitbucketEndpoint {
         this.hookSignatureCredentialsId = enableHookSignature ? fixEmptyAndTrim(hookSignatureCredentialsId) : null;
     }
 
+    @Override
+    public void setManageHooks(boolean manageHooks, String credentialsId) {
+        this.manageHooks = manageHooks && StringUtils.isNotBlank(credentialsId);
+        this.credentialsId = manageHooks ? fixEmptyAndTrim(credentialsId) : null;
+    }
+
     /**
      * The URL of this endpoint.
      *
@@ -259,7 +265,7 @@ public final String getCredentialsId() {
     @Override
     @CheckForNull
     public StandardCredentials credentials() {
-        return BitbucketCredentialsUtils.lookupCredentials(Jenkins.get(), getServerUrl(), credentialsId, StandardCredentials.class);
+        return BitbucketCredentialsUtils.lookupCredentials(Jenkins.get(), getServerURL(), credentialsId, StandardCredentials.class);
     }
 
     /**
@@ -270,7 +276,7 @@ public StandardCredentials credentials() {
     @Override
     @CheckForNull
     public StringCredentials hookSignatureCredentials() {
-        return BitbucketCredentialsUtils.lookupCredentials(Jenkins.get(), getServerUrl(), hookSignatureCredentialsId, StringCredentials.class);
+        return BitbucketCredentialsUtils.lookupCredentials(Jenkins.get(), getServerURL(), hookSignatureCredentialsId, StringCredentials.class);
     }
 
     /**
