support customized authentication

Author: weidongxu-microsoft

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/MetricsAdvisorClientBuilder.java

@@ -4,6 +4,7 @@
 package com.azure.ai.metricsadvisor;
 
 import com.azure.ai.metricsadvisor.implementation.MetricsAdvisorClientImpl;
+import com.azure.ai.metricsadvisor.models.MetricsAdvisorKeyCredential;
 import com.azure.core.annotation.Generated;
 import com.azure.core.annotation.ServiceClientBuilder;
 import com.azure.core.credential.TokenCredential;
@@ -24,10 +25,12 @@
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
+import com.azure.core.util.logging.ClientLogger;
 import com.azure.core.util.serializer.JacksonAdapter;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 /** A builder for creating a new instance of the MetricsAdvisorClient type. */
@@ -203,7 +206,6 @@ private MetricsAdvisorClientImpl buildInnerClient() {
         return client;
     }
 
-    @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration =
                 (configuration == null) ? Configuration.getGlobalConfiguration() : configuration;
@@ -232,6 +234,16 @@ private HttpPipeline createHttpPipeline() {
         policies.add(new CookiePolicy());
         if (tokenCredential != null) {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
+        } else if (!CoreUtils.isNullOrEmpty(metricsAdvisorKeyCredential.getKeys().getSubscriptionKey())
+            || !CoreUtils.isNullOrEmpty(metricsAdvisorKeyCredential.getKeys().getApiKey())) {
+            HttpHeaders apiKeyHeaders = new HttpHeaders();
+            apiKeyHeaders.set(OCP_APIM_SUBSCRIPTION_KEY, metricsAdvisorKeyCredential.getKeys().getSubscriptionKey());
+            apiKeyHeaders.set(API_KEY, metricsAdvisorKeyCredential.getKeys().getApiKey());
+            policies.add(new AddHeadersPolicy(apiKeyHeaders));
+        } else {
+            // Throw exception that credential cannot be null
+            throw LOGGER.logExceptionAsError(
+                new IllegalArgumentException("Missing credential information while building a client."));
         }
         policies.addAll(
                 this.pipelinePolicies.stream()
@@ -287,4 +299,25 @@ public MetricsAdvisorClientBuilder credential(TokenCredential tokenCredential) {
         this.tokenCredential = tokenCredential;
         return this;
     }
+
+    private static final ClientLogger LOGGER = new ClientLogger(MetricsAdvisorClientBuilder.class);
+    private static final String OCP_APIM_SUBSCRIPTION_KEY = "Ocp-Apim-Subscription-Key";
+    private static final String API_KEY = "x-api-key";
+
+    private MetricsAdvisorKeyCredential metricsAdvisorKeyCredential = null;
+
+    /**
+     * Sets the {@link MetricsAdvisorKeyCredential} to use when authenticating HTTP requests for this
+     * MetricsAdvisorClientBuilder.
+     *
+     * @param metricsAdvisorKeyCredential {@link MetricsAdvisorKeyCredential} API key credential
+     *
+     * @return The updated MetricsAdvisorClientBuilder object.
+     * @throws NullPointerException If {@code metricsAdvisorKeyCredential} is null.
+     */
+    public MetricsAdvisorClientBuilder credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential) {
+        this.metricsAdvisorKeyCredential = Objects.requireNonNull(metricsAdvisorKeyCredential,
+            "'metricsAdvisorKeyCredential' cannot be null.");
+        return this;
+    }
 }

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/models/MetricsAdvisorKeyCredential.java

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.ai.metricsadvisor.models;
+
+import com.azure.core.annotation.Fluent;
+
+/**
+ * The MetricsAdvisorKeyCredential class.
+ */
+@Fluent
+public final class MetricsAdvisorKeyCredential {
+    private volatile MetricsAdvisorKeys keys;
+    private final Object updateLock = new Object();
+
+    /**
+     * Creates a MetricsAdvisorKeyCredential credential that authorizes request with the given keys.
+     *
+     * @param subscriptionKey the subscription key used to authorize requests
+     * @param apiKey the api key used to authorize requests
+     */
+    public MetricsAdvisorKeyCredential(String subscriptionKey, String apiKey) {
+        this.keys = new MetricsAdvisorKeys(subscriptionKey, apiKey);
+    }
+
+    /**
+     * Retrieves the {@link MetricsAdvisorKeys} containing the subscription key and api key
+     * associated with this credential.
+     *
+     * @return The {@link MetricsAdvisorKeys} containing the subscription key and api key.
+     */
+    public MetricsAdvisorKeys getKeys() {
+        return this.keys;
+    }
+
+    /**
+     * Update the subscription and api key associated to this credential.
+     * <p>
+     * This is intended to be used when you've regenerated your subscription key and
+     * api key want to update long lived clients.
+     * </p>
+     * @param subscriptionKey The new subscription key to associated with this credential.
+     * @param apiKey The new api key to associated with this credential.
+     * @return The updated {@code MetricsAdvisorKeyCredential} object.
+     */
+    public MetricsAdvisorKeyCredential updateKey(String subscriptionKey, String apiKey) {
+        synchronized (this.updateLock) {
+            this.keys = new MetricsAdvisorKeys(subscriptionKey, apiKey);
+        }
+        return this;
+    }
+}
+

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/models/MetricsAdvisorKeys.java

@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.ai.metricsadvisor.models;
+
+import com.azure.core.annotation.Immutable;
+
+/**
+ * Represents a credential bag containing the subscription key and api key.
+ *
+ * @see MetricsAdvisorKeyCredential
+ */
+@Immutable
+public final class MetricsAdvisorKeys {
+    private final String subscriptionKey;
+    private final String apiKey;
+
+    MetricsAdvisorKeys(String subscriptionKey, String apiKey) {
+        this.subscriptionKey = subscriptionKey;
+        this.apiKey = apiKey;
+    }
+
+    /**
+     * Retrieves the subscription key.
+     *
+     * @return The subscription key.
+     */
+    public String getSubscriptionKey() {
+        return this.subscriptionKey;
+    }
+
+    /**
+     * Retrieves the api key.
+     *
+     * @return The api key.
+     */
+    public String getApiKey() {
+        return this.apiKey;
+    }
+}
+

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/module-info.java

@@ -6,4 +6,5 @@
     requires transitive com.azure.core;
 
     exports com.azure.ai.metricsadvisor;
+    exports com.azure.ai.metricsadvisor.models;
 }