add custom hosts to BaseAuthenticationProvider w/out breaking

Author: ramsessanchez

src/main/java/com/microsoft/graph/authentication/BaseAuthenticationProvider.java

@@ -3,24 +3,43 @@
 import java.net.URL;
 import java.util.Arrays;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Locale;
 
 import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
 
 /**
  * Provides basic common methods for all authentication providers
  */
 public abstract class BaseAuthenticationProvider implements IAuthenticationProvider {
     private static final HashSet<String> validGraphHostNames = new HashSet<>(Arrays.asList("graph.microsoft.com", "graph.microsoft.us", "dod-graph.microsoft.us", "graph.microsoft.de", "microsoftgraph.chinacloudapi.cn", "canary.graph.microsoft.com"));
+    private HashSet<String> customHosts;
+
+    /**
+     * Allow the user to add custom hosts by passing in Array
+     * @param customHosts custom hosts passed in by user.
+     */
+    public void setCustomHosts(String[] customHosts) {
+        if(this.customHosts == null){
+            this.customHosts = new HashSet<String>();
+        }
+        for(String host: customHosts){
+            this.customHosts.add(host.toLowerCase(Locale.ROOT));
+        }
+    }
+    /**
+     * Get the custom hosts set by user.
+     * @return the custom hosts set by user.
+     */
+    public HashSet<String> getCustomHosts(){
+        return (HashSet<String>) this.customHosts.clone();
+    }
     /**
      * Determines whether a request should be authenticated or not based on it's url.
      * If you're implementing a custom provider, call that method first before getting the token
      * @param requestUrl request URL that is about to be executed
      * @return whether a token should be attached to this request
      */
-    protected boolean shouldAuthenticateRequestWithUrl(@Nonnull final URL requestUrl, @Nullable final List<String> customHosts) {
+    protected boolean shouldAuthenticateRequestWithUrl(@Nonnull final URL requestUrl) {
         if (requestUrl == null || !requestUrl.getProtocol().toLowerCase(Locale.ROOT).equals("https"))
             return false;
         final String hostName = requestUrl.getHost().toLowerCase(Locale.ROOT);

src/main/java/com/microsoft/graph/authentication/TokenCredentialAuthProvider.java

@@ -19,8 +19,6 @@ public class TokenCredentialAuthProvider extends BaseAuthenticationProvider {
     private final TokenCredential tokenCredential;
     /** Context options which can be optionally set by the user */
     private final TokenRequestContext context;
-    /** Custom hosts which can be optionally set by the user */
-    private List<String> customHosts = null;
     /** Default scope to use when no scopes are provided */
     private static final String DEFAULT_GRAPH_SCOPE = "https://graph.microsoft.com/.default";
 
@@ -48,35 +46,14 @@ public TokenCredentialAuthProvider(@Nonnull final List<String> scopes, @Nonnull
         this.tokenCredential = Objects.requireNonNull(tokenCredential, "tokenCredential parameter cannot be null.");
     }
 
-    /**
-     * Creates an Authentication provider using a TokenCredential and a list of custom hosts
-     * @param tokenCredential Credential object inheriting the TokenCredential interface used to instantiate the Auth Provider.
-     * @param customHosts the user defined custom hosts.
-     */
-    public TokenCredentialAuthProvider(@Nonnull final TokenCredential tokenCredential, @Nonnull final List<String> customHosts){
-        this(Collections.singletonList(DEFAULT_GRAPH_SCOPE), tokenCredential);
-        this.customHosts = customHosts;
-    }
-
-    /**
-     * Creates an Authentication provider using a TokenCredential, a list of scopes, and a list of custom hosts.
-     * @param scopes Specified desired scopes of the Auth Provider
-     * @param tokenCredential Credential object inheriting the TokenCredential interface used to instantiate the Auth Provider
-     * @param customHosts the user defined custom hosts.
-     */
-    public TokenCredentialAuthProvider(@Nonnull final List<String> scopes, @Nonnull final TokenCredential tokenCredential, @Nonnull final List<String> customHosts) {
-        this(scopes, tokenCredential);
-        this.customHosts = customHosts;
-    }
-
     /**
      * Returns an AccessToken as a string
      *
      * @return String representing the retrieved AccessToken
      */
     @Nonnull
     public CompletableFuture<String> getAuthorizationTokenAsync(@Nonnull final URL requestUrl) {
-        if(shouldAuthenticateRequestWithUrl(Objects.requireNonNull(requestUrl, "requestUrl parameter cannot be null"), customHosts))
+        if(shouldAuthenticateRequestWithUrl(Objects.requireNonNull(requestUrl, "requestUrl parameter cannot be null")))
             return this.tokenCredential
                         .getToken(this.context)
                         .toFuture()

src/test/java/com/microsoft/graph/authentication/BaseAuthenticationProviderTest.java

@@ -28,7 +28,7 @@ public void providerAddsTokenOnAllNationalAndPublicClouds() throws MalformedURLE
             // Arrange
             final URL url = new URL("https://"+ hostName);
             // Act
-            final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url, null);
+            final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url);
 
             // Assert
             assertTrue(result);
@@ -40,7 +40,7 @@ public void providerDoesNotAddTokenOnInvalidDomains() throws MalformedURLExcepti
         final URL url = new URL("https://localhost");
 
         //Act
-        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url, null);
+        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url);
 
         //Assert
         assertFalse(result);
@@ -51,7 +51,7 @@ public void providerDoesNotAddTokenOnInvalidProtocols() throws MalformedURLExcep
         final URL url = new URL("http://graph.microsoft.com");
 
         //Act
-        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url, null);
+        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url);
 
         //Assert
         assertFalse(result);
@@ -62,18 +62,19 @@ public void providerDoesNotAddTokenOnNullUrls() throws MalformedURLException {
         final URL url = (URL)null;
 
         //Act
-        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url, null);
+        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url);
 
         //Assert
         assertFalse(result);
     }
     @Test
     public void providerAddsTokenToCustomHosts() throws MalformedURLException {
         //Arrange
-        final URL url = new URL("https://localhost");
+        final URL url = new URL("https://localhost.com");
+        authProvider.setCustomHosts(new String[]{"localHost.com"});
 
         //Act
-        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url, Arrays.asList("localhost"));
+        final boolean result = authProvider.shouldAuthenticateRequestWithUrl(url);
 
         //Assert
         assertTrue(result);