Updated ServiceBusAdministrationClientBuilder to Support HttpPipelinePosition (Azure#23328)

Updated ServiceBusAdministrationClientBuilder to Support HttpPipleinePosition

Author: alzimmermsft

sdk/core/azure-core/src/main/java/com/azure/core/util/CoreUtils.java

@@ -3,6 +3,8 @@
 
 package com.azure.core.util;
 
+import com.azure.core.http.HttpHeader;
+import com.azure.core.http.HttpHeaders;
 import com.azure.core.http.policy.HttpLogOptions;
 import com.azure.core.http.rest.PagedResponse;
 import com.azure.core.util.logging.ClientLogger;
@@ -15,9 +17,11 @@
 import java.nio.charset.IllegalCharsetNameException;
 import java.nio.charset.StandardCharsets;
 import java.nio.charset.UnsupportedCharsetException;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 import java.util.Properties;
 import java.util.function.BiFunction;
@@ -283,4 +287,26 @@ public static String getApplicationId(ClientOptions clientOptions, HttpLogOption
             return null;
         }
     }
+
+    /**
+     * Creates {@link HttpHeaders} from the provided {@link ClientOptions}.
+     * <p>
+     * If {@code clientOptions} is null or {@link ClientOptions#getHeaders()} doesn't return any {@link Header} values
+     * null will be returned.
+     *
+     * @param clientOptions The {@link ClientOptions} used to create the {@link HttpHeaders}.
+     * @return {@link HttpHeaders} containing the {@link Header} values from {@link ClientOptions#getHeaders()} if
+     * {@code clientOptions} isn't null and contains {@link Header} values, otherwise null.
+     */
+    public static HttpHeaders createHttpHeadersFromClientOptions(ClientOptions clientOptions) {
+        if (clientOptions == null) {
+            return null;
+        }
+
+        List<HttpHeader> httpHeaderList = new ArrayList<>();
+        clientOptions.getHeaders().forEach(
+            header -> httpHeaderList.add(new HttpHeader(header.getName(), header.getValue())));
+
+        return httpHeaderList.isEmpty() ? null : new HttpHeaders(httpHeaderList);
+    }
 }

sdk/core/azure-core/src/test/java/com/azure/core/util/CoreUtilsTests.java

@@ -3,6 +3,7 @@
 
 package com.azure.core.util;
 
+import com.azure.core.http.HttpHeaders;
 import com.azure.core.http.policy.HttpLogOptions;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
@@ -15,6 +16,9 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
@@ -195,4 +199,40 @@ private static Stream<Arguments> getApplicationIdSupplier() {
             Arguments.of(null, null, null)
         );
     }
+
+    @ParameterizedTest
+    @MethodSource("createHttpHeadersFromClientOptionsSupplier")
+    public void createHttpHeadersFromClientOptions(ClientOptions clientOptions, HttpHeaders expected) {
+        HttpHeaders actual = CoreUtils.createHttpHeadersFromClientOptions(clientOptions);
+        if (expected == null) {
+            assertNull(actual);
+        } else {
+            assertEquals(expected.toMap(), actual.toMap());
+        }
+    }
+
+    private static Stream<Arguments> createHttpHeadersFromClientOptionsSupplier() {
+        List<Header> multipleHeadersList = new ArrayList<>();
+        multipleHeadersList.add(new Header("a", "header"));
+        multipleHeadersList.add(new Header("another", "headerValue"));
+
+        Map<String, String> multipleHeadersMap = new HashMap<>();
+        multipleHeadersMap.put("a", "header");
+        multipleHeadersMap.put("another", "headerValue");
+
+        return Stream.of(
+            // ClientOptions is null, null is returned.
+            Arguments.of(null, null),
+
+            // ClientOptions doesn't contain Header values, null is returned.
+            Arguments.of(new ClientOptions(), null),
+
+            // ClientOptions contains a single header value, a single header HttpHeaders is returned.
+            Arguments.of(new ClientOptions().setHeaders(Collections.singletonList(new Header("a", "header"))),
+                new HttpHeaders(Collections.singletonMap("a", "header"))),
+
+            // ClientOptions contains multiple header values, a multi-header HttpHeaders is returned.
+            Arguments.of(new ClientOptions().setHeaders(multipleHeadersList), new HttpHeaders(multipleHeadersMap))
+        );
+    }
 }

sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/administration/ServiceBusAdministrationClientBuilder.java

@@ -8,9 +8,13 @@
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.exception.AzureException;
 import com.azure.core.http.HttpClient;
+import com.azure.core.http.HttpHeader;
+import com.azure.core.http.HttpHeaders;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpPipelineBuilder;
+import com.azure.core.http.HttpPipelinePosition;
 import com.azure.core.http.policy.AddHeadersFromContextPolicy;
+import com.azure.core.http.policy.AddHeadersPolicy;
 import com.azure.core.http.policy.HttpLogDetailLevel;
 import com.azure.core.http.policy.HttpLogOptions;
 import com.azure.core.http.policy.HttpLoggingPolicy;
@@ -55,11 +59,21 @@
 @ServiceClientBuilder(serviceClients = {ServiceBusAdministrationClient.class,
     ServiceBusAdministrationAsyncClient.class})
 public final class ServiceBusAdministrationClientBuilder {
+    private static final String CLIENT_NAME;
+    private static final String CLIENT_VERSION;
+
+    static {
+        Map<String, String> properties = CoreUtils.getProperties("azure-messaging-servicebus.properties");
+
+        CLIENT_NAME = properties.getOrDefault("name", "UnknownName");
+        CLIENT_VERSION = properties.getOrDefault("version", "UnknownVersion");
+    }
+
     private final ClientLogger logger = new ClientLogger(ServiceBusAdministrationClientBuilder.class);
     private final ServiceBusManagementSerializer serializer = new ServiceBusManagementSerializer();
-    private final List<HttpPipelinePolicy> userPolicies = new ArrayList<>();
-    private final Map<String, String> properties =
-        CoreUtils.getProperties("azure-messaging-servicebus.properties");
+
+    private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
+    private final List<HttpPipelinePolicy> perRetryPolicies = new ArrayList<>();
 
     private Configuration configuration;
 
@@ -142,7 +156,12 @@ public ServiceBusAdministrationClient buildClient() {
      */
     public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy) {
         Objects.requireNonNull(policy);
-        userPolicies.add(policy);
+        if (policy.getPipelinePosition() == HttpPipelinePosition.PER_CALL) {
+            perCallPolicies.add(policy);
+        } else {
+            perRetryPolicies.add(policy);
+        }
+
         return this;
     }
 
@@ -348,44 +367,38 @@ private HttpPipeline createPipeline() {
 
         // Closest to API goes first, closest to wire goes last.
         final List<HttpPipelinePolicy> httpPolicies = new ArrayList<>();
-        final String clientName = properties.getOrDefault("name", "UnknownName");
-        final String clientVersion = properties.getOrDefault("version", "UnknownVersion");
 
         // Find applicationId to use
-        String logApplicationId = null;
-        if (httpLogOptions != null) {
-            logApplicationId = httpLogOptions.getApplicationId();
-        }
+        final String applicationId = CoreUtils.getApplicationId(clientOptions, httpLogOptions);
 
-        String clientApplicationId = null;
-        if (clientOptions != null && clientOptions.getApplicationId() != null) {
-            clientApplicationId = clientOptions.getApplicationId();
-        }
-
-        if (logApplicationId != null && clientApplicationId != null
-            && !logApplicationId.equalsIgnoreCase(clientApplicationId)) {
-            throw logger.logExceptionAsError(new IllegalStateException(
-                "'httpLogOptions.getApplicationId() and clientOptions.getApplicationId()' cannot be different."));
-        }
-        // We prioritize application id set in ClientOptions.
-        final String applicationId = clientApplicationId != null ? clientApplicationId : logApplicationId;
-
-        httpPolicies.add(new UserAgentPolicy(applicationId, clientName, clientVersion,
-            buildConfiguration));
+        httpPolicies.add(new UserAgentPolicy(applicationId, CLIENT_NAME, CLIENT_VERSION, buildConfiguration));
         httpPolicies.add(new ServiceBusTokenCredentialHttpPolicy(tokenCredential));
         httpPolicies.add(new AddHeadersFromContextPolicy());
 
+        httpPolicies.addAll(perCallPolicies);
+
         HttpPolicyProviders.addBeforeRetryPolicies(httpPolicies);
 
         httpPolicies.add(retryPolicy == null ? new RetryPolicy() : retryPolicy);
-        httpPolicies.addAll(userPolicies);
+        httpPolicies.addAll(perRetryPolicies);
+
+        if (clientOptions != null) {
+            List<HttpHeader> httpHeaderList = new ArrayList<>();
+            clientOptions.getHeaders().forEach(h -> httpHeaderList.add(new HttpHeader(h.getName(), h.getValue())));
+
+            if (!httpHeaderList.isEmpty()) {
+                httpPolicies.add(new AddHeadersPolicy(new HttpHeaders(httpHeaderList)));
+            }
+        }
+
         httpPolicies.add(new HttpLoggingPolicy(httpLogOptions));
 
         HttpPolicyProviders.addAfterRetryPolicies(httpPolicies);
 
         return new HttpPipelineBuilder()
             .policies(httpPolicies.toArray(new HttpPipelinePolicy[0]))
             .httpClient(httpClient)
+            .clientOptions(clientOptions)
             .build();
     }
 }