Move HttpClient SPI Implementation to Public API (#18580)

* Move HttpClient Service Provider Interface Implementations to Public API * Clean up linting * Update documentation, fix styling
Azure · Jan 13, 2021 · 5c12e44 · 5c12e44
1 parent 3bc2464
commit 5c12e44
Show file tree

Hide file tree

Showing 18 changed files with 55 additions and 54 deletions.
diff --git a/...ttpclient/src/main/java/com/azure/core/http/jdk/httpclient/JdkAsyncHttpClientBuilder.java b/...ttpclient/src/main/java/com/azure/core/http/jdk/httpclient/JdkAsyncHttpClientBuilder.java
@@ -7,8 +7,8 @@
 import com.azure.core.http.ProxyOptions;
 import com.azure.core.http.jdk.httpclient.implementation.JdkHttpClientProxySelector;
 import com.azure.core.util.Configuration;
-
 import com.azure.core.util.logging.ClientLogger;
+
 import java.io.IOException;
 import java.io.Reader;
 import java.net.Authenticator;
@@ -83,8 +83,8 @@ public JdkAsyncHttpClientBuilder(java.net.http.HttpClient.Builder httpClientBuil
 
     /**
      * Sets the executor to be used for asynchronous and dependent tasks. This cannot be null.
-     *
-     * <p> If this method is not invoked prior to {@linkplain #build() building}, a default executor is created for each
+     * <p>
+     * If this method is not invoked prior to {@linkplain #build() building}, a default executor is created for each
      * newly built {@code HttpClient}.
      *
      * @param executor the executor to be used for asynchronous and dependent tasks
@@ -151,8 +151,8 @@ public JdkAsyncHttpClientBuilder configuration(Configuration configuration) {
      */
     public HttpClient build() {
         java.net.http.HttpClient.Builder httpClientBuilder = this.httpClientBuilder == null
-                     ? java.net.http.HttpClient.newBuilder()
-                     : this.httpClientBuilder;
+            ? java.net.http.HttpClient.newBuilder()
+            : this.httpClientBuilder;
 
         httpClientBuilder = (this.connectionTimeout != null)
             ? httpClientBuilder.connectTimeout(this.connectionTimeout)
@@ -210,7 +210,7 @@ private Set<String> getAllowRestrictedHeaders() {
 
         // Combine the set of all allowed restricted headers from both sources
         allowRestrictedHeaders.addAll(
-                Arrays.stream(allowRestrictedHeadersSystemProperties)
+            Arrays.stream(allowRestrictedHeadersSystemProperties)
                 .map(String::trim)
                 .collect(Collectors.toSet()));
 

diff --git a/...dk-httpclient/src/main/java/com/azure/core/http/jdk/httpclient/JdkHttpClientProvider.java b/...dk-httpclient/src/main/java/com/azure/core/http/jdk/httpclient/JdkHttpClientProvider.java
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.core.http.jdk.httpclient;
+
+import com.azure.core.http.HttpClient;
+import com.azure.core.http.HttpClientProvider;
+
+/**
+ * An {@link HttpClientProvider} that provides an implementation of HttpClient based on native JDK HttpClient.
+ * <p>
+ * NOTE: This implementation is only available in Java 11+ as that is when {@link java.net.http.HttpClient} was
+ * introduced.
+ */
+public final class JdkHttpClientProvider implements HttpClientProvider {
+
+    @Override
+    public HttpClient createInstance() {
+        return new JdkAsyncHttpClientBuilder().build();
+    }
+}
diff --git a/...rc/main/java/com/azure/core/http/jdk/httpclient/implementation/JdkHttpClientProvider.java b/...rc/main/java/com/azure/core/http/jdk/httpclient/implementation/JdkHttpClientProvider.java
diff --git a/sdk/core/azure-core-http-jdk-httpclient/src/main/java/module-info.java b/sdk/core/azure-core-http-jdk-httpclient/src/main/java/module-info.java
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import com.azure.core.http.jdk.httpclient.implementation.JdkHttpClientProvider;
+import com.azure.core.http.jdk.httpclient.JdkHttpClientProvider;
 
 module com.azure.core.http.jdk.httpclient {
     requires transitive com.azure.core;

diff --git a/...dk-httpclient/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider b/...dk-httpclient/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider
@@ -1 +1 @@
-com.azure.core.http.jdk.httpclient.implementation.JdkHttpClientProvider
+com.azure.core.http.jdk.httpclient.JdkHttpClientProvider
diff --git a/...ProxyWithHttpProxyJdkHttpClientTests.java → ...ProxyWithHttpProxyJdkHttpClientTests.java b/...ProxyWithHttpProxyJdkHttpClientTests.java → ...ProxyWithHttpProxyJdkHttpClientTests.java
@@ -1,11 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.jdk.httpclient.implementation;
+package com.azure.core.http.jdk.httpclient;
 
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.ProxyOptions;
-import com.azure.core.http.jdk.httpclient.JdkAsyncHttpClientBuilder;
 import com.azure.core.test.RestProxyTestsWireMockServer;
 import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;
@@ -26,7 +25,7 @@ public static void getWireMockServer() {
     }
 
     @AfterAll
-    public static void shutdownWireMockServer() {
+    public static void shutJdkAsyncHttpClientBuilderdownWireMockServer() {
         if (server != null) {
             server.shutdown();
         }

diff --git a/...tion/RestProxyWithJdkHttpClientTests.java → ...ient/RestProxyWithJdkHttpClientTests.java b/...tion/RestProxyWithJdkHttpClientTests.java → ...ient/RestProxyWithJdkHttpClientTests.java
@@ -1,12 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.jdk.httpclient.implementation;
+package com.azure.core.http.jdk.httpclient;
 
 import com.azure.core.http.HttpClient;
-import com.azure.core.http.jdk.httpclient.JdkAsyncHttpClientBuilder;
-import com.azure.core.test.implementation.RestProxyTests;
 import com.azure.core.test.RestProxyTestsWireMockServer;
+import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;

diff --git a/...mentation/ReactorNettyClientProvider.java → ...ttp/netty/ReactorNettyClientProvider.java b/...mentation/ReactorNettyClientProvider.java → ...ttp/netty/ReactorNettyClientProvider.java
@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.netty.implementation;
+package com.azure.core.http.netty;
 
 import com.azure.core.http.HttpClient;
-import com.azure.core.http.netty.NettyAsyncHttpClientBuilder;
 import com.azure.core.http.HttpClientProvider;
 
-public class ReactorNettyClientProvider implements HttpClientProvider {
+/**
+ * An {@link HttpClientProvider} that provides an implementation of HttpClient based on Netty.
+ */
+public final class ReactorNettyClientProvider implements HttpClientProvider {
 
     @Override
     public HttpClient createInstance() {

diff --git a/sdk/core/azure-core-http-netty/src/main/java/module-info.java b/sdk/core/azure-core-http-netty/src/main/java/module-info.java
@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import com.azure.core.http.netty.ReactorNettyClientProvider;
+
 module com.azure.http.netty {
     requires transitive com.azure.core;
     requires reactor.netty;
@@ -13,10 +15,9 @@
     requires io.netty.handler.proxy;
 
     exports com.azure.core.http.netty;
-    exports com.azure.core.http.netty.implementation;       // FIXME this should not be a long-term solution
 
     provides com.azure.core.http.HttpClientProvider
-        with com.azure.core.http.netty.implementation.ReactorNettyClientProvider;
+        with ReactorNettyClientProvider;
 
     uses com.azure.core.http.HttpClientProvider;
 }
diff --git a/...re-http-netty/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider b/...re-http-netty/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider
@@ -1 +1 @@
-com.azure.core.http.netty.implementation.ReactorNettyClientProvider
+com.azure.core.http.netty.ReactorNettyClientProvider
diff --git a/...zure-core-http-netty/src/test/java/com/azure/core/http/netty/ReactorNettyClientTests.java b/...zure-core-http-netty/src/test/java/com/azure/core/http/netty/ReactorNettyClientTests.java
@@ -8,7 +8,6 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.HttpResponse;
-import com.azure.core.http.netty.implementation.ReactorNettyClientProvider;
 import com.azure.core.util.Context;
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.core.WireMockConfiguration;

diff --git a/...ion/RestProxyWithHttpProxyNettyTests.java → ...tty/RestProxyWithHttpProxyNettyTests.java b/...ion/RestProxyWithHttpProxyNettyTests.java → ...tty/RestProxyWithHttpProxyNettyTests.java
@@ -1,11 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.netty.implementation;
+package com.azure.core.http.netty;
 
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.ProxyOptions;
-import com.azure.core.http.netty.NettyAsyncHttpClientBuilder;
 import com.azure.core.test.RestProxyTestsWireMockServer;
 import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;

diff --git a/...plementation/RestProxyWithNettyTests.java → ...e/http/netty/RestProxyWithNettyTests.java b/...plementation/RestProxyWithNettyTests.java → ...e/http/netty/RestProxyWithNettyTests.java
@@ -1,10 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.netty.implementation;
+package com.azure.core.http.netty;
 
 import com.azure.core.http.HttpClient;
-import com.azure.core.http.netty.NettyAsyncHttpClientBuilder;
 import com.azure.core.test.RestProxyTestsWireMockServer;
 import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;

diff --git a/.../implementation/OkHttpClientProvider.java → ...ore/http/okhttp/OkHttpClientProvider.java b/.../implementation/OkHttpClientProvider.java → ...ore/http/okhttp/OkHttpClientProvider.java
@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.okhttp.implementation;
+package com.azure.core.http.okhttp;
 
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpClientProvider;
-import com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder;
 
-public class OkHttpClientProvider implements HttpClientProvider {
+/**
+ * An {@link HttpClientProvider} that provides an implementation of HttpClient based on OkHttp.
+ */
+public final class OkHttpClientProvider implements HttpClientProvider {
 
     @Override
     public HttpClient createInstance() {

diff --git a/sdk/core/azure-core-http-okhttp/src/main/java/module-info.java b/sdk/core/azure-core-http-okhttp/src/main/java/module-info.java
@@ -1,17 +1,18 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import com.azure.core.http.okhttp.OkHttpClientProvider;
+
 module com.azure.core.http.okhttp {
     requires transitive com.azure.core;
 
     requires okhttp3;
     requires okio;
 
     exports com.azure.core.http.okhttp;
-    exports com.azure.core.http.okhttp.implementation;      // FIXME this should not be a long-term solution
 
     provides com.azure.core.http.HttpClientProvider
-        with com.azure.core.http.okhttp.implementation.OkHttpClientProvider;
+        with OkHttpClientProvider;
 
     uses com.azure.core.http.HttpClientProvider;
 }
diff --git a/...e-http-okhttp/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider b/...e-http-okhttp/src/main/resources/META-INF/services/com.azure.core.http.HttpClientProvider
@@ -1 +1 @@
-com.azure.core.http.okhttp.implementation.OkHttpClientProvider
+com.azure.core.http.okhttp.OkHttpClientProvider
diff --git a/...on/RestProxyWithHttpProxyOkHttpTests.java → ...tp/RestProxyWithHttpProxyOkHttpTests.java b/...on/RestProxyWithHttpProxyOkHttpTests.java → ...tp/RestProxyWithHttpProxyOkHttpTests.java
@@ -1,11 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.okhttp.implementation;
+package com.azure.core.http.okhttp;
 
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.ProxyOptions;
-import com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder;
 import com.azure.core.test.RestProxyTestsWireMockServer;
 import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;

diff --git a/...lementation/RestProxyWithOkHttpTests.java → ...http/okhttp/RestProxyWithOkHttpTests.java b/...lementation/RestProxyWithOkHttpTests.java → ...http/okhttp/RestProxyWithOkHttpTests.java
@@ -1,10 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package com.azure.core.http.okhttp.implementation;
+package com.azure.core.http.okhttp;
 
 import com.azure.core.http.HttpClient;
-import com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder;
 import com.azure.core.test.RestProxyTestsWireMockServer;
 import com.azure.core.test.implementation.RestProxyTests;
 import com.github.tomakehurst.wiremock.WireMockServer;
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		com.azure.core.http.jdk.httpclient.implementation.JdkHttpClientProvider
		com.azure.core.http.jdk.httpclient.JdkHttpClientProvider
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		com.azure.core.http.netty.implementation.ReactorNettyClientProvider
		com.azure.core.http.netty.ReactorNettyClientProvider
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		com.azure.core.http.okhttp.implementation.OkHttpClientProvider
		com.azure.core.http.okhttp.OkHttpClientProvider