Allow Clients to set Socket channel option

Author: sushilamazon

.changes/next-release/feature-AWSSDKforJavav2.json

@@ -0,0 +1,5 @@
+{
+        "category": "AWS SDK for Java v2", 
+        "type": "feature", 
+        "description": "Allow clients to add Socket Channel Option"
+}

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.java

@@ -56,6 +56,7 @@
 import software.amazon.awssdk.http.nio.netty.internal.RequestAdapter;
 import software.amazon.awssdk.http.nio.netty.internal.RequestContext;
 import software.amazon.awssdk.http.nio.netty.internal.RunnableRequest;
+import software.amazon.awssdk.http.nio.netty.internal.SdkChannelOptions;
 import software.amazon.awssdk.http.nio.netty.internal.SdkChannelPoolMap;
 import software.amazon.awssdk.http.nio.netty.internal.SharedSdkEventLoopGroup;
 import software.amazon.awssdk.http.nio.netty.internal.http2.HttpOrHttp2ChannelPool;
@@ -73,6 +74,7 @@ public final class NettyNioAsyncHttpClient implements SdkAsyncHttpClient {
     private final RequestAdapter requestAdapter = new RequestAdapter();
     private final SdkEventLoopGroup sdkEventLoopGroup;
     private final ChannelPoolMap<URI, ChannelPool> pools;
+    private final SdkChannelOptions sdkChannelOptions;
     private final NettyConfiguration configuration;
     private final long maxStreams;
     private Protocol protocol;
@@ -83,6 +85,11 @@ public final class NettyNioAsyncHttpClient implements SdkAsyncHttpClient {
         this.maxStreams = 200;
         this.sdkEventLoopGroup = eventLoopGroup(builder);
         this.pools = createChannelPoolMap();
+        this.sdkChannelOptions = channelOptions(builder);
+    }
+
+    private SdkChannelOptions channelOptions(DefaultBuilder builder) {
+        return builder.sdkChannelOptions;
     }
 
     private SdkEventLoopGroup eventLoopGroup(DefaultBuilder builder) {
@@ -144,8 +151,8 @@ protected ChannelPool newPool(URI key) {
                         .channelFactory(sdkEventLoopGroup.channelFactory())
                         .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, configuration.connectTimeoutMillis())
                         // TODO run some performance tests with and without this.
-                        .option(ChannelOption.TCP_NODELAY, true)
                         .remoteAddress(key.getHost(), key.getPort());
+                sdkChannelOptions.channelOptions().forEach(bootstrap::option);
                 AtomicReference<ChannelPool> channelPoolRef = new AtomicReference<>();
                 ChannelPipelineInitializer handler =
                     new ChannelPipelineInitializer(protocol, sslContext, maxStreams, channelPoolRef);
@@ -279,6 +286,16 @@ public interface Builder extends SdkAsyncHttpClient.Builder<NettyNioAsyncHttpCli
          * @return This builder for method chaining.
          */
         Builder protocol(Protocol protocol);
+
+        /**
+         * Add new socket channel option which will be used to create Netty Http client. This allows custom configuration
+         * for Netty.
+         * @param channelOption {@link ChannelOption} to set
+         * @param value See {@link ChannelOption} to find the type of value for each option
+         * @return This builder for method chaining.
+         * @see SdkEventLoopGroup.Builder
+         */
+        Builder putChannelOption(ChannelOption channelOption, Object value);
     }
 
     /**
@@ -288,6 +305,9 @@ public interface Builder extends SdkAsyncHttpClient.Builder<NettyNioAsyncHttpCli
     private static final class DefaultBuilder implements Builder {
 
         private final AttributeMap.Builder standardOptions = AttributeMap.builder();
+
+        private SdkChannelOptions sdkChannelOptions = new SdkChannelOptions();
+
         private SdkEventLoopGroup eventLoopGroup;
         private SdkEventLoopGroup.Builder eventLoopGroupBuilder;
 
@@ -423,11 +443,18 @@ public void setProtocol(Protocol protocol) {
             protocol(protocol);
         }
 
+        @Override
+        public Builder putChannelOption(ChannelOption channelOption, Object value) {
+            this.sdkChannelOptions.putOption(channelOption, value);
+            return this;
+        }
+
         @Override
         public SdkAsyncHttpClient buildWithDefaults(AttributeMap serviceDefaults) {
             return new NettyNioAsyncHttpClient(this, standardOptions.build()
                                                                     .merge(serviceDefaults)
                                                                     .merge(SdkHttpConfigurationOption.GLOBAL_HTTP_DEFAULTS));
+
         }
     }
 }

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/internal/SdkChannelOptions.java

@@ -0,0 +1,43 @@
+/*
+ * 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.nio.netty.internal;
+
+import io.netty.channel.ChannelOption;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import software.amazon.awssdk.annotations.SdkProtectedApi;
+
+@SdkProtectedApi
+public class SdkChannelOptions {
+
+    private Map<ChannelOption, Object> options;
+
+    public SdkChannelOptions() {
+        options = new HashMap<>();
+        options.put(ChannelOption.TCP_NODELAY, Boolean.TRUE);
+    }
+
+    public <T> SdkChannelOptions putOption(ChannelOption<T> channelOption, T channelOptionValue) {
+        channelOption.validate(channelOptionValue);
+        options.put(channelOption, channelOptionValue);
+        return this;
+    }
+
+    public Map<ChannelOption, Object> channelOptions() {
+        return Collections.unmodifiableMap(options);
+    }
+}

http-clients/netty-nio-client/src/test/java/software/amazon/awssdk/http/nio/netty/internal/SdkChannelOptionsTest.java

@@ -0,0 +1,47 @@
+/*
+ * 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.nio.netty.internal;
+
+import static org.junit.Assert.assertEquals;
+
+import io.netty.channel.ChannelOption;
+import java.util.HashMap;
+import java.util.Map;
+import org.junit.Test;
+
+public class SdkChannelOptionsTest {
+
+    @Test
+    public void defaultSdkSocketOptionPresent() {
+        SdkChannelOptions channelOptions = new SdkChannelOptions();
+
+        Map<ChannelOption, Object> expectedOptions = new HashMap<>();
+        expectedOptions.put(ChannelOption.TCP_NODELAY, Boolean.TRUE);
+        assertEquals(expectedOptions, channelOptions.channelOptions());
+    }
+
+    @Test
+    public void additionalSdkSocketOptionsPresent() {
+        SdkChannelOptions channelOptions = new SdkChannelOptions();
+        channelOptions.putOption(ChannelOption.SO_LINGER, 0);
+
+        Map<ChannelOption, Object> expectedOptions = new HashMap<>();
+        expectedOptions.put(ChannelOption.TCP_NODELAY, Boolean.TRUE);
+        expectedOptions.put(ChannelOption.SO_LINGER, 0);
+
+        assertEquals(expectedOptions, channelOptions.channelOptions());
+    }
+}