Cleaning up interceptors and HTTP SPI

Author: spfink

core/aws-core/src/main/java/software/amazon/awssdk/awscore/AwsExecutionAttribute.java

@@ -15,8 +15,8 @@
 
 package software.amazon.awssdk.awscore;
 
-import software.amazon.awssdk.annotations.SdkProtectedApi;
-import software.amazon.awssdk.auth.signer.AwsSignerExecutionAttribute;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.auth.signer.internal.AwsSignerExecutionAttribute;
 import software.amazon.awssdk.core.interceptor.ExecutionAttribute;
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
 import software.amazon.awssdk.core.interceptor.SdkExecutionAttribute;
@@ -25,7 +25,7 @@
 /**
  * AWS-specific attributes attached to the execution. This information is available to {@link ExecutionInterceptor}s.
  */
-@SdkProtectedApi
+@SdkPublicApi
 public final class AwsExecutionAttribute extends SdkExecutionAttribute {
     /**
      * The AWS {@link Region} the client was configured with. This is not always same as the

core/aws-core/src/main/java/software/amazon/awssdk/awscore/internal/client/handler/AwsClientHandlerUtils.java

@@ -29,7 +29,6 @@
 import software.amazon.awssdk.awscore.client.config.AwsAdvancedClientOption;
 import software.amazon.awssdk.awscore.client.config.AwsClientOption;
 import software.amazon.awssdk.core.Request;
-import software.amazon.awssdk.core.RequestOverrideConfiguration;
 import software.amazon.awssdk.core.SdkRequest;
 import software.amazon.awssdk.core.SdkResponse;
 import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
@@ -71,10 +70,6 @@ public static <InputT extends SdkRequest, OutputT extends SdkResponse> Execution
         ExecutionAttributes executionAttributes = new ExecutionAttributes()
             .putAttribute(AwsSignerExecutionAttribute.SERVICE_CONFIG, clientConfig.option(SdkClientOption.SERVICE_CONFIGURATION))
             .putAttribute(AwsSignerExecutionAttribute.AWS_CREDENTIALS, credentials)
-            .putAttribute(AwsSignerExecutionAttribute.REQUEST_CONFIG,
-                          originalRequest.overrideConfiguration()
-                                         .map(c -> (RequestOverrideConfiguration) c)
-                                         .orElse(AwsRequestOverrideConfiguration.builder().build()))
             .putAttribute(AwsSignerExecutionAttribute.SERVICE_SIGNING_NAME,
                           clientConfig.option(AwsClientOption.SERVICE_SIGNING_NAME))
             .putAttribute(AwsExecutionAttribute.AWS_REGION, clientConfig.option(AwsClientOption.AWS_REGION))

core/sdk-core/src/it/java/software/amazon/awssdk/core/http/timers/client/AbortedExceptionClientExecutionTimerIntegrationTest.java

@@ -71,7 +71,7 @@ public class AbortedExceptionClientExecutionTimerIntegrationTest extends MockSer
 
     @Before
     public void setup() throws Exception {
-        when(sdkHttpClient.prepareRequest(any(), any())).thenReturn(abortableCallable);
+        when(sdkHttpClient.prepareRequest(any())).thenReturn(abortableCallable);
         httpClient = HttpTestUtils.testClientBuilder().httpClient(sdkHttpClient).build();
         when(abortableCallable.call()).thenReturn(SdkHttpFullResponse.builder()
                                                                      .statusCode(200)

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkDefaultClientBuilder.java

@@ -56,11 +56,9 @@
 import software.amazon.awssdk.core.internal.util.UserAgentUtils;
 import software.amazon.awssdk.core.retry.RetryPolicy;
 import software.amazon.awssdk.http.AbortableCallable;
+import software.amazon.awssdk.http.ExecuteRequest;
 import software.amazon.awssdk.http.SdkHttpClient;
-import software.amazon.awssdk.http.SdkHttpConfigurationOption;
-import software.amazon.awssdk.http.SdkHttpFullRequest;
 import software.amazon.awssdk.http.SdkHttpFullResponse;
-import software.amazon.awssdk.http.SdkRequestContext;
 import software.amazon.awssdk.http.async.AsyncExecuteRequest;
 import software.amazon.awssdk.http.async.SdkAsyncHttpClient;
 import software.amazon.awssdk.utils.AttributeMap;
@@ -368,14 +366,8 @@ private NonManagedSdkHttpClient(SdkHttpClient delegate) {
         }
 
         @Override
-        public AbortableCallable<SdkHttpFullResponse> prepareRequest(SdkHttpFullRequest request,
-                                                                     SdkRequestContext requestContext) {
-            return delegate.prepareRequest(request, requestContext);
-        }
-
-        @Override
-        public <T> Optional<T> getConfigurationValue(SdkHttpConfigurationOption<T> key) {
-            return delegate.getConfigurationValue(key);
+        public AbortableCallable<SdkHttpFullResponse> prepareRequest(ExecuteRequest request) {
+            return delegate.prepareRequest(request);
         }
 
         @Override
@@ -402,11 +394,6 @@ public CompletableFuture<Void> execute(AsyncExecuteRequest request) {
             return delegate.execute(request);
         }
 
-        @Override
-        public <T> Optional<T> getConfigurationValue(SdkHttpConfigurationOption<T> key) {
-            return delegate.getConfigurationValue(key);
-        }
-
         @Override
         public void close() {
             // Do nothing, this client is managed by the customer.

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/handler/BaseClientHandler.java

@@ -17,9 +17,7 @@
 
 import software.amazon.awssdk.annotations.SdkProtectedApi;
 import software.amazon.awssdk.core.Request;
-import software.amazon.awssdk.core.RequestOverrideConfiguration;
 import software.amazon.awssdk.core.SdkRequest;
-import software.amazon.awssdk.core.SdkRequestOverrideConfiguration;
 import software.amazon.awssdk.core.SdkResponse;
 import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
 import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
@@ -133,18 +131,8 @@ protected <InputT extends SdkRequest, OutputT extends SdkResponse> ExecutionCont
 
         SdkRequest originalRequest = params.getInput();
         ExecutionAttributes executionAttributes = new ExecutionAttributes()
-            .putAttribute(SdkExecutionAttribute.REQUEST_CONFIG, originalRequest.overrideConfiguration()
-                                                                               .filter(c -> c instanceof
-                                                                                        SdkRequestOverrideConfiguration)
-                                                                               .map(c -> (RequestOverrideConfiguration) c)
-                                                                               .orElse(SdkRequestOverrideConfiguration.builder()
-                                                                                                                       .build()))
             .putAttribute(SdkExecutionAttribute.SERVICE_CONFIG,
-                          clientConfiguration.option(SdkClientOption.SERVICE_CONFIGURATION))
-            .putAttribute(SdkExecutionAttribute.REQUEST_CONFIG, originalRequest.overrideConfiguration()
-                                                                               .map(c -> (SdkRequestOverrideConfiguration) c)
-                                                                               .orElse(SdkRequestOverrideConfiguration.builder()
-                                                                                                                       .build()));
+                          clientConfiguration.option(SdkClientOption.SERVICE_CONFIGURATION));
 
         ExecutionInterceptorChain interceptorChain =
                 new ExecutionInterceptorChain(clientConfiguration.option(SdkClientOption.EXECUTION_INTERCEPTORS));

core/sdk-core/src/main/java/software/amazon/awssdk/core/interceptor/SdkExecutionAttribute.java

@@ -15,24 +15,17 @@
 
 package software.amazon.awssdk.core.interceptor;
 
-import software.amazon.awssdk.annotations.SdkProtectedApi;
-import software.amazon.awssdk.core.RequestOverrideConfiguration;
+import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.core.ServiceConfiguration;
 import software.amazon.awssdk.core.signer.Signer;
 
 /**
  * Contains attributes attached to the execution. This information is available to {@link ExecutionInterceptor}s and
  * {@link Signer}s.
  */
-@SdkProtectedApi
+@SdkPublicApi
 public class SdkExecutionAttribute {
 
-    /**
-     * The key under which the request config is stored.
-     */
-    public static final ExecutionAttribute<RequestOverrideConfiguration> REQUEST_CONFIG =
-        new ExecutionAttribute<>("RequestConfig");
-
     /**
      * Handler context key for advanced configuration.
      */

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/MakeHttpRequestStage.java

@@ -22,10 +22,10 @@
 import software.amazon.awssdk.core.internal.http.RequestExecutionContext;
 import software.amazon.awssdk.core.internal.http.pipeline.RequestPipeline;
 import software.amazon.awssdk.http.AbortableCallable;
+import software.amazon.awssdk.http.ExecuteRequest;
 import software.amazon.awssdk.http.SdkHttpClient;
 import software.amazon.awssdk.http.SdkHttpFullRequest;
 import software.amazon.awssdk.http.SdkHttpFullResponse;
-import software.amazon.awssdk.http.SdkRequestContext;
 import software.amazon.awssdk.utils.Pair;
 
 /**
@@ -53,7 +53,7 @@ public Pair<SdkHttpFullRequest, SdkHttpFullResponse> execute(SdkHttpFullRequest
 
     private SdkHttpFullResponse executeHttpRequest(SdkHttpFullRequest request, RequestExecutionContext context) throws Exception {
         final AbortableCallable<SdkHttpFullResponse> requestCallable = sdkHttpClient
-                .prepareRequest(request, SdkRequestContext.builder().build());
+                .prepareRequest(ExecuteRequest.builder().request(request).build());
 
         return requestCallable.call();
     }

core/sdk-core/src/test/java/software/amazon/awssdk/core/client/handler/SyncClientHandlerTest.java

@@ -120,7 +120,7 @@ public void failedExecutionCallsErrorResponseHandler() throws Exception {
 
     private void expectRetrievalFromMocks() {
         when(marshaller.marshall(request)).thenReturn(marshalledRequest);
-        when(httpClient.prepareRequest(any(), any())).thenReturn(httpClientCall);
+        when(httpClient.prepareRequest(any())).thenReturn(httpClientCall);
     }
 
     private ClientExecutionParams<SdkRequest, SdkResponse> clientExecutionParams() {

core/sdk-core/src/test/java/software/amazon/awssdk/core/http/AmazonHttpClientTest.java

@@ -39,6 +39,7 @@
 import software.amazon.awssdk.core.internal.http.AmazonSyncHttpClient;
 import software.amazon.awssdk.core.internal.http.timers.ClientExecutionAndRequestTimerTestUtils;
 import software.amazon.awssdk.http.AbortableCallable;
+import software.amazon.awssdk.http.ExecuteRequest;
 import software.amazon.awssdk.http.SdkHttpClient;
 import software.amazon.awssdk.http.SdkHttpFullRequest;
 import software.amazon.awssdk.http.SdkHttpFullResponse;
@@ -60,7 +61,7 @@ public class AmazonHttpClientTest {
     public void setUp() throws Exception {
         BasicConfigurator.configure();
         client = HttpTestUtils.testClientBuilder().httpClient(sdkHttpClient).build();
-        when(sdkHttpClient.prepareRequest(any(), any())).thenReturn(abortableCallable);
+        when(sdkHttpClient.prepareRequest(any())).thenReturn(abortableCallable);
         stubSuccessfulResponse();
     }
 
@@ -85,7 +86,7 @@ public void testRetryIoExceptionFromExecute() throws Exception {
         }
 
         // Verify that we called execute 4 times.
-        verify(sdkHttpClient, times(4)).prepareRequest(any(), any());
+        verify(sdkHttpClient, times(4)).prepareRequest(any());
     }
 
     @Test
@@ -137,10 +138,10 @@ public void testUserAgentPrefixAndSuffixAreAdded() throws Exception {
               .executionContext(ClientExecutionAndRequestTimerTestUtils.executionContext(null))
               .execute(handler);
 
-        ArgumentCaptor<SdkHttpFullRequest> httpRequestCaptor = ArgumentCaptor.forClass(SdkHttpFullRequest.class);
-        verify(sdkHttpClient).prepareRequest(httpRequestCaptor.capture(), any());
+        ArgumentCaptor<ExecuteRequest> httpRequestCaptor = ArgumentCaptor.forClass(ExecuteRequest.class);
+        verify(sdkHttpClient).prepareRequest(httpRequestCaptor.capture());
 
-        final String userAgent = httpRequestCaptor.getValue().firstMatchingHeader("User-Agent")
+        final String userAgent = httpRequestCaptor.getValue().httpRequest().firstMatchingHeader("User-Agent")
                                                   .orElseThrow(() -> new AssertionError("User-Agent header was not found"));
 
         Assert.assertTrue(userAgent.startsWith(prefix));

http-client-spi/src/main/java/software/amazon/awssdk/http/ConfigurationProvider.java

@@ -0,0 +1,95 @@
+/*
+ * 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;
+
+import software.amazon.awssdk.annotations.SdkPublicApi;
+
+/**
+ * Request object containing the parameters necessary to make a synchronous HTTP request.
+ *
+ * @see SdkHttpClient
+ */
+@SdkPublicApi
+public final class ExecuteRequest {
+
+    private final SdkHttpFullRequest request;
+    private final boolean isFullDuplex;
+
+    private ExecuteRequest(BuilderImpl builder) {
+        this.request = builder.request;
+        this.isFullDuplex = builder.isFullDuplex;
+    }
+
+    /**
+     * @return The HTTP request.
+     */
+    public SdkHttpFullRequest httpRequest() {
+        return request;
+    }
+
+    public boolean fullDuplex() {
+        return isFullDuplex;
+    }
+
+    public static Builder builder() {
+        return new BuilderImpl();
+    }
+
+    public interface Builder {
+        /**
+         * Set the HTTP request to be executed by the client.
+         *
+         * @param request The request.
+         * @return This builder for method chaining.
+         */
+        Builder request(SdkHttpFullRequest request);
+
+        /**
+         * Option to indicate if the request is for a full duplex operation ie., request and response are sent/received at
+         * the same time.
+         * <p>
+         * This can be used to set http configuration like ReadTimeouts as soon as request has begin sending data instead of
+         * waiting for the entire request to be sent.
+         *
+         * @return True if the operation this request belongs to is full duplex. Otherwise false.
+         */
+        Builder fullDuplex(boolean fullDuplex);
+
+        ExecuteRequest build();
+    }
+
+    private static class BuilderImpl implements Builder {
+        private SdkHttpFullRequest request;
+        private boolean isFullDuplex;
+
+        @Override
+        public Builder request(SdkHttpFullRequest request) {
+            this.request = request;
+            return this;
+        }
+
+        @Override
+        public Builder fullDuplex(boolean fullDuplex) {
+            isFullDuplex = fullDuplex;
+            return this;
+        }
+
+        @Override
+        public ExecuteRequest build() {
+            return new ExecuteRequest(this);
+        }
+    }
+}

http-client-spi/src/main/java/software/amazon/awssdk/http/ExecuteRequest.java

@@ -32,15 +32,14 @@
 @Immutable
 @ThreadSafe
 @SdkProtectedApi
-public interface SdkHttpClient extends SdkAutoCloseable, ConfigurationProvider {
+public interface SdkHttpClient extends SdkAutoCloseable {
     /**
      * Create a {@link AbortableCallable} that can be used to execute the HTTP request.
      *
      * @param request        Representation of an HTTP request.
-     * @param requestContext Contains any extra dependencies needed.
      * @return Task that can execute an HTTP request and can be aborted.
      */
-    AbortableCallable<SdkHttpFullResponse> prepareRequest(SdkHttpFullRequest request, SdkRequestContext requestContext);
+    AbortableCallable<SdkHttpFullResponse> prepareRequest(ExecuteRequest request);
 
     /**
      * Interface for creating an {@link SdkHttpClient} with service specific defaults applied.

http-client-spi/src/main/java/software/amazon/awssdk/http/SdkHttpClient.java

@@ -20,7 +20,6 @@
 import software.amazon.awssdk.annotations.Immutable;
 import software.amazon.awssdk.annotations.SdkProtectedApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
-import software.amazon.awssdk.http.ConfigurationProvider;
 import software.amazon.awssdk.utils.AttributeMap;
 import software.amazon.awssdk.utils.SdkAutoCloseable;
 import software.amazon.awssdk.utils.builder.SdkBuilder;
@@ -36,7 +35,7 @@
 @Immutable
 @ThreadSafe
 @SdkProtectedApi
-public interface SdkAsyncHttpClient extends SdkAutoCloseable, ConfigurationProvider {
+public interface SdkAsyncHttpClient extends SdkAutoCloseable {
 
     /**
      * Execute the request.