Mark all BitbucketAuthenticator implementations as non API classes (#935)

Author: nfalco79

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

@@ -36,9 +36,9 @@
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketRepository;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketRequestException;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketTeam;
-import com.cloudbees.jenkins.plugins.bitbucket.api.credentials.BitbucketUsernamePasswordAuthenticator;
 import com.cloudbees.jenkins.plugins.bitbucket.client.BitbucketCloudApiClient;
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.UserRoleInRepository;
+import com.cloudbees.jenkins.plugins.bitbucket.credentials.BitbucketUsernamePasswordAuthenticator;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.AbstractBitbucketEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketCloudEndpoint;
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/BitbucketApiFactory.java

@@ -1,6 +1,6 @@
 package com.cloudbees.jenkins.plugins.bitbucket.api;
 
-import com.cloudbees.jenkins.plugins.bitbucket.api.credentials.BitbucketUsernamePasswordAuthenticator;
+import com.cloudbees.jenkins.plugins.bitbucket.credentials.BitbucketUsernamePasswordAuthenticator;
 import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/BitbucketAuthenticator.java

@@ -25,8 +25,8 @@
 package com.cloudbees.jenkins.plugins.bitbucket.api;
 
 import com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketCloudEndpoint;
-import com.cloudbees.plugins.credentials.common.StandardCredentials;
 import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
+import hudson.plugins.git.GitSCM;
 import jenkins.authentication.tokens.api.AuthenticationTokenContext;
 import org.apache.http.HttpHost;
 import org.apache.http.HttpRequest;
@@ -36,66 +36,51 @@
 /**
  * Support for various different methods of authenticating with Bitbucket
  */
-public abstract class BitbucketAuthenticator {
-
-    private final String id;
+public interface BitbucketAuthenticator {
 
     /**
      * The key for bitbucket URL as reported in an {@link AuthenticationTokenContext}
      */
-    public static final String SERVER_URL = "bitbucket.server.uri";
+    static final String SERVER_URL = "bitbucket.server.uri";
 
     /**
      * The key for URL scheme as reported in an {@link AuthenticationTokenContext}
      */
-    public static final String SCHEME = "bitbucket.server.uri.scheme";
+    static final String SCHEME = "bitbucket.server.uri.scheme";
 
     /**
      * The key for Bitbucket instance type as reported in an {@link AuthenticationTokenContext}
      */
-    public static final String BITBUCKET_INSTANCE_TYPE = "bitbucket.server.type";
+    static final String BITBUCKET_INSTANCE_TYPE = "bitbucket.server.type";
 
     /**
      * Purpose value for bitbucket cloud (i.e. bitbucket.org)
      */
-    public static final String BITBUCKET_INSTANCE_TYPE_CLOUD = "BITBUCKET_CLOUD";
+    static final String BITBUCKET_INSTANCE_TYPE_CLOUD = "BITBUCKET_CLOUD";
 
     /**
      * Purpose value for bitbucket server
      */
-    public static final String BITBUCKET_INSTANCE_TYPE_SERVER = "BITBUCKET_SERVER";
-
-    /**
-     * Constructor
-     *
-     * @param credentials credentials instance this authenticator will use
-     */
-    protected BitbucketAuthenticator(StandardCredentials credentials) {
-        id = credentials.getId();
-    }
+    static final String BITBUCKET_INSTANCE_TYPE_SERVER = "BITBUCKET_SERVER";
 
     /**
      * @return id of the credentials used.
      */
-    public String getId() {
-        return id;
-    }
+    String getId();
 
     /**
      * Configures an {@link HttpClientBuilder}. Override if you need to adjust connection setup.
      * @param builder The client builder.
      */
-    public void configureBuilder(HttpClientBuilder builder) {
-        // override to configure HttpClientBuilder
+    default void configureBuilder(HttpClientBuilder builder) {
     }
 
     /**
      * Configures an {@link HttpClientContext}. Override
      * @param context The connection context
      * @param host host being connected to
      */
-    public void configureContext(HttpClientContext context, HttpHost host) {
-        // override to configure HttpClientContext
+    default void configureContext(HttpClientContext context, HttpHost host) {
     }
 
     /**
@@ -104,17 +89,20 @@ public void configureContext(HttpClientContext context, HttpHost host) {
      *
      * @param request the request.
      */
-    public void configureRequest(HttpRequest request) {
-        // override to configure HttpRequest
+    default void configureRequest(HttpRequest request) {
     }
 
-
     /**
-     * Provides credentials that can be used for authenticated interactions with SCM.
+     * Provides credentials that can be used for authenticated interactions with
+     * SCM.
      *
-     * @return credentials to be passed to {@link org.jenkinsci.plugins.gitclient.GitClient#setCredentials(StandardUsernameCredentials)}
+     * @return credentials to be passed to
+     *         {@link org.jenkinsci.plugins.gitclient.GitClient#setCredentials(StandardUsernameCredentials)}.
+     *         If {@code null} force {@link GitSCM} to obtain credentials in the
+     *         standard way, from the credential provider, using the credential
+     *         identifier provided by {@link #getId()}.
      */
-    public StandardUsernameCredentials getCredentialsForSCM() {
+    default StandardUsernameCredentials getCredentialsForSCM() {
         return null;
     }
 

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/client/BitbucketCloudApiClient.java

@@ -36,7 +36,6 @@
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketRequestException;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketTeam;
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketWebHook;
-import com.cloudbees.jenkins.plugins.bitbucket.api.credentials.BitbucketUsernamePasswordAuthenticator;
 import com.cloudbees.jenkins.plugins.bitbucket.avatars.AvatarCacheSource.AvatarImage;
 import com.cloudbees.jenkins.plugins.bitbucket.client.branch.BitbucketCloudBranch;
 import com.cloudbees.jenkins.plugins.bitbucket.client.branch.BitbucketCloudCommit;
@@ -49,6 +48,7 @@
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.BitbucketRepositorySource;
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.PaginatedBitbucketRepository;
 import com.cloudbees.jenkins.plugins.bitbucket.client.repository.UserRoleInRepository;
+import com.cloudbees.jenkins.plugins.bitbucket.credentials.BitbucketUsernamePasswordAuthenticator;
 import com.cloudbees.jenkins.plugins.bitbucket.filesystem.BitbucketSCMFile;
 import com.cloudbees.jenkins.plugins.bitbucket.internal.api.AbstractBitbucketApi;
 import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketAccessTokenAuthenticator.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketAccessTokenAuthenticator.java

@@ -1,4 +1,4 @@
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import com.cloudbees.plugins.credentials.CredentialsScope;
@@ -14,8 +14,9 @@
 /**
  * Authenticator that uses an access token.
  */
-public class BitbucketAccessTokenAuthenticator extends BitbucketAuthenticator {
+public class BitbucketAccessTokenAuthenticator implements BitbucketAuthenticator {
 
+    private final String credentialsId;
     private final Secret token;
 
     /**
@@ -24,7 +25,7 @@ public class BitbucketAccessTokenAuthenticator extends BitbucketAuthenticator {
      * @param credentials the access token that will be used
      */
     public BitbucketAccessTokenAuthenticator(StringCredentials credentials) {
-        super(credentials);
+        this.credentialsId = credentials.getId();
         token = credentials.getSecret();
     }
 
@@ -46,4 +47,9 @@ public StandardUsernameCredentials getCredentialsForSCM() {
             throw new RuntimeException(e);
         }
     }
+
+    @Override
+    public String getId() {
+        return credentialsId;
+    }
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketAccessTokenAuthenticatorSource.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketAccessTokenAuthenticatorSource.java

@@ -1,4 +1,4 @@
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import edu.umd.cs.findbugs.annotations.NonNull;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketClientCertificateAuthenticator.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketClientCertificateAuthenticator.java

@@ -22,7 +22,7 @@
  * THE SOFTWARE.
  */
 
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import com.cloudbees.plugins.credentials.common.StandardCertificateCredentials;
@@ -42,8 +42,9 @@
 /**
  * Authenticates against Bitbucket using a TLS client certificate
  */
-public class BitbucketClientCertificateAuthenticator extends BitbucketAuthenticator {
+public class BitbucketClientCertificateAuthenticator implements BitbucketAuthenticator {
 
+    private final String credentialsId;
     private final KeyStore keyStore;
     private final Secret password;
 
@@ -53,7 +54,7 @@ public class BitbucketClientCertificateAuthenticator extends BitbucketAuthentica
      * {@inheritDoc}
      */
     public BitbucketClientCertificateAuthenticator(StandardCertificateCredentials credentials) {
-        super(credentials);
+        this.credentialsId = credentials.getId();
         keyStore = credentials.getKeyStore();
         password = credentials.getPassword();
     }
@@ -77,4 +78,9 @@ private SSLContext buildSSLContext() throws NoSuchAlgorithmException, KeyStoreEx
         contextBuilder.loadKeyMaterial(keyStore, password.getPlainText().toCharArray());
         return contextBuilder.build();
     }
+
+    @Override
+    public String getId() {
+        return credentialsId;
+    }
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketClientCertificateAuthenticatorSource.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketClientCertificateAuthenticatorSource.java

@@ -22,7 +22,7 @@
  * THE SOFTWARE.
  */
 
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import com.cloudbees.plugins.credentials.common.StandardCertificateCredentials;

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketOAuth.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketOAuth.java

@@ -1,4 +1,4 @@
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
 

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/credentials/BitbucketOAuthAuthenticator.java renamed to src/main/java/com/cloudbees/jenkins/plugins/bitbucket/credentials/BitbucketOAuthAuthenticator.java

@@ -1,4 +1,4 @@
-package com.cloudbees.jenkins.plugins.bitbucket.api.credentials;
+package com.cloudbees.jenkins.plugins.bitbucket.credentials;
 
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import com.cloudbees.plugins.credentials.CredentialsScope;
@@ -17,8 +17,9 @@
 import jenkins.util.SetContextClassLoader;
 import org.apache.http.HttpRequest;
 
-public class BitbucketOAuthAuthenticator extends BitbucketAuthenticator {
+public class BitbucketOAuthAuthenticator implements BitbucketAuthenticator {
 
+    private final String credentialsId;
     private OAuth2AccessToken token;
 
     /**
@@ -28,7 +29,7 @@ public class BitbucketOAuthAuthenticator extends BitbucketAuthenticator {
      * @throws AuthenticationTokenException
      */
     public BitbucketOAuthAuthenticator(StandardUsernamePasswordCredentials credentials) throws AuthenticationTokenException {
-        super(credentials);
+        this.credentialsId = credentials.getId();
 
         try (SetContextClassLoader cl = new SetContextClassLoader(this.getClass());
                 OAuth20Service service = new ServiceBuilder(credentials.getUsername())
@@ -58,4 +59,9 @@ public StandardUsernameCredentials getCredentialsForSCM() {
             throw new RuntimeException(e);
         }
     }
+
+    @Override
+    public String getId() {
+        return credentialsId;
+    }
 }