Adding the ability to control how a HttpURLConnection gets created.

Author: kiiadi

.changes/next-release/feature-URLConnectionHTTPClient-777a68c.json

@@ -0,0 +1,5 @@
+{
+    "category": "URLConnection HTTP Client", 
+    "type": "feature", 
+    "description": "Adding a hook to enable custom creation of the initial `HttpURLConnection`. This enables customers to control how a connection is established for a given `URL` including handling any required proxy configuration etc."
+}

http-clients/url-connection-client/src/main/java/software/amazon/awssdk/http/urlconnection/UrlConnectionFactory.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.http.urlconnection;
+
+import java.net.HttpURLConnection;
+import java.net.URI;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+
+/**
+ * An interface that, given a {@link URI} creates a new {@link HttpURLConnection}. This allows customization
+ * of the creation and configuration of the {@link HttpURLConnection}.
+ */
+@FunctionalInterface
+@SdkPublicApi
+public interface UrlConnectionFactory {
+
+    /**
+     * For the given {@link URI} create an {@link HttpURLConnection}.
+     * @param uri the {@link URI} of the request
+     * @return a {@link HttpURLConnection} to the given {@link URI}
+     */
+    HttpURLConnection createConnection(URI uri);
+}

http-clients/url-connection-client/src/main/java/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.java

@@ -25,6 +25,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
+import java.net.URI;
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
@@ -54,15 +55,42 @@
 public final class UrlConnectionHttpClient implements SdkHttpClient {
 
     private final AttributeMap options;
+    private final UrlConnectionFactory connectionFactory;
 
-    private UrlConnectionHttpClient(AttributeMap options) {
+    private UrlConnectionHttpClient(AttributeMap options, UrlConnectionFactory connectionFactory) {
         this.options = options;
+        if (connectionFactory != null) {
+            this.connectionFactory = connectionFactory;
+        } else {
+            this.connectionFactory = this::createDefaultConnection;
+        }
+
     }
 
     public static Builder builder() {
         return new DefaultBuilder();
     }
 
+    /**
+     * Create a {@link HttpURLConnection} client with the default properties
+     *
+     * @return an {@link UrlConnectionHttpClient}
+     */
+    public static SdkHttpClient create() {
+        return new DefaultBuilder().build();
+    }
+
+    /**
+     * Use this method if you want to control the way a {@link HttpURLConnection} is created.
+     * This will ignore SDK defaults like {@link SdkHttpConfigurationOption#CONNECTION_TIMEOUT}
+     * and {@link SdkHttpConfigurationOption#READ_TIMEOUT}
+     * @param connectionFactory a function that, given a {@link URI} will create an {@link HttpURLConnection}
+     * @return an {@link UrlConnectionHttpClient}
+     */
+    public static SdkHttpClient create(UrlConnectionFactory connectionFactory) {
+        return new UrlConnectionHttpClient(AttributeMap.empty(), connectionFactory);
+    }
+
     @Override
     public ExecutableHttpRequest prepareRequest(HttpExecuteRequest request) {
         HttpURLConnection connection = createAndConfigureConnection(request);
@@ -75,8 +103,7 @@ public void close() {
     }
 
     private HttpURLConnection createAndConfigureConnection(HttpExecuteRequest request) {
-        HttpURLConnection connection =
-            invokeSafely(() -> (HttpURLConnection) request.httpRequest().getUri().toURL().openConnection());
+        HttpURLConnection connection = connectionFactory.createConnection(request.httpRequest().getUri());
         request.httpRequest()
                .headers()
                .forEach((key, values) -> values.forEach(value -> connection.setRequestProperty(key, value)));
@@ -85,9 +112,13 @@ private HttpURLConnection createAndConfigureConnection(HttpExecuteRequest reques
             connection.setDoOutput(true);
         }
 
+        return connection;
+    }
+
+    private HttpURLConnection createDefaultConnection(URI uri) {
+        HttpURLConnection connection = invokeSafely(() -> (HttpURLConnection) uri.toURL().openConnection());
         connection.setConnectTimeout(saturatedCast(options.get(CONNECTION_TIMEOUT).toMillis()));
         connection.setReadTimeout(saturatedCast(options.get(READ_TIMEOUT).toMillis()));
-
         return connection;
     }
 
@@ -210,7 +241,8 @@ public void setConnectionTimeout(Duration connectionTimeout) {
         public SdkHttpClient buildWithDefaults(AttributeMap serviceDefaults) {
             return new UrlConnectionHttpClient(standardOptions.build()
                                                               .merge(serviceDefaults)
-                                                              .merge(SdkHttpConfigurationOption.GLOBAL_HTTP_DEFAULTS));
+                                                              .merge(SdkHttpConfigurationOption.GLOBAL_HTTP_DEFAULTS),
+                                               null);
         }
     }
 }

http-clients/url-connection-client/src/test/java/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClientWireMockTest.java

@@ -20,6 +20,6 @@
 public final class UrlConnectionHttpClientWireMockTest extends SdkHttpClientTestSuite {
     @Override
     protected SdkHttpClient createSdkHttpClient(SdkHttpClientOptions options) {
-        return UrlConnectionHttpClient.builder().build();
+        return UrlConnectionHttpClient.create();
     }
 }

http-clients/url-connection-client/src/test/java/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClientWithCustomCreateWireMockTest.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+package software.amazon.awssdk.http.urlconnection;
+
+import static software.amazon.awssdk.utils.FunctionalUtils.invokeSafely;
+
+import java.net.HttpURLConnection;
+import software.amazon.awssdk.http.SdkHttpClient;
+import software.amazon.awssdk.http.SdkHttpClientTestSuite;
+
+public final class UrlConnectionHttpClientWithCustomCreateWireMockTest extends SdkHttpClientTestSuite {
+    @Override
+    protected SdkHttpClient createSdkHttpClient(SdkHttpClientOptions options) {
+        return UrlConnectionHttpClient.create((uri) -> invokeSafely(() -> (HttpURLConnection) uri.toURL().openConnection()));
+    }
+}