support request host prefix in core sdk (#2198)

* support request host prefix in core sdk

* address pr comments

Author: raphkim

aws-android-sdk-core/src/main/java/com/amazonaws/DefaultRequest.java

@@ -73,6 +73,9 @@ public class DefaultRequest<T> implements Request<T> {
     /** All AWS Request metrics are collected into this object. */
     private AWSRequestMetrics metrics;
 
+    /** An optional prefix to prepend to the request endpoint host */
+    private String hostPrefix;
+
     /**
      * Constructs a new DefaultRequest with the specified service name and the
      * original, user facing request object.
@@ -111,57 +114,55 @@ public AmazonWebServiceRequest getOriginalRequest() {
     }
 
     /**
-     * @see com.amazonaws.Request#addHeader(java.lang.String, java.lang.String)
+     * {@inheritDoc}
      */
     @Override
     public void addHeader(String name, String value) {
         headers.put(name, value);
     }
 
     /**
-     * @see com.amazonaws.Request#getHeaders()
+     * {@inheritDoc}
      */
     @Override
     public Map<String, String> getHeaders() {
         return headers;
     }
 
     /**
-     * @see com.amazonaws.Request#setResourcePath(java.lang.String)
+     * {@inheritDoc}
      */
     @Override
     public void setResourcePath(String resourcePath) {
         this.resourcePath = resourcePath;
     }
 
     /**
-     * @see com.amazonaws.Request#getResourcePath()
+     * {@inheritDoc}
      */
     @Override
     public String getResourcePath() {
         return resourcePath;
     }
 
     /**
-     * @see com.amazonaws.Request#addParameter(java.lang.String,
-     *      java.lang.String)
+     * {@inheritDoc}
      */
     @Override
     public void addParameter(String name, String value) {
         parameters.put(name, value);
     }
 
     /**
-     * @see com.amazonaws.Request#getParameters()
+     * {@inheritDoc}
      */
     @Override
     public Map<String, String> getParameters() {
         return parameters;
     }
 
     /**
-     * @see com.amazonaws.Request#withParameter(java.lang.String,
-     *      java.lang.String)
+     * {@inheritDoc}
      */
     @Override
     public Request<T> withParameter(String name, String value) {
@@ -170,63 +171,63 @@ public Request<T> withParameter(String name, String value) {
     }
 
     /**
-     * @see com.amazonaws.Request#getHttpMethod()
+     * {@inheritDoc}
      */
     @Override
     public HttpMethodName getHttpMethod() {
         return httpMethod;
     }
 
     /**
-     * @see com.amazonaws.Request#setHttpMethod(com.amazonaws.http.HttpMethodName)
+     * {@inheritDoc}
      */
     @Override
     public void setHttpMethod(HttpMethodName httpMethod) {
         this.httpMethod = httpMethod;
     }
 
     /**
-     * @see com.amazonaws.Request#setEndpoint(java.net.URI)
+     * {@inheritDoc}
      */
     @Override
     public void setEndpoint(URI endpoint) {
         this.endpoint = endpoint;
     }
 
     /**
-     * @see com.amazonaws.Request#getEndpoint()
+     * {@inheritDoc}
      */
     @Override
     public URI getEndpoint() {
         return endpoint;
     }
 
     /**
-     * @see com.amazonaws.Request#getServiceName()
+     * {@inheritDoc}
      */
     @Override
     public String getServiceName() {
         return serviceName;
     }
 
     /**
-     * @see com.amazonaws.Request#getContent()
+     * {@inheritDoc}
      */
     @Override
     public InputStream getContent() {
         return content;
     }
 
     /**
-     * @see com.amazonaws.Request#setContent(java.io.InputStream)
+     * {@inheritDoc}
      */
     @Override
     public void setContent(InputStream content) {
         this.content = content;
     }
 
     /**
-     * @see com.amazonaws.Request#setHeaders(java.util.Map)
+     * {@inheritDoc}
      */
     @Override
     public void setHeaders(Map<String, String> headers) {
@@ -235,7 +236,7 @@ public void setHeaders(Map<String, String> headers) {
     }
 
     /**
-     * @see com.amazonaws.Request#setParameters(java.util.Map)
+     * {@inheritDoc}
      */
     @Override
     public void setParameters(Map<String, String> parameters) {
@@ -244,23 +245,39 @@ public void setParameters(Map<String, String> parameters) {
     }
 
     /**
-     * @see com.amazonaws.Request#getTimeOffset
+     * {@inheritDoc}
+     */
+    @Override
+    public String getHostPrefix() {
+        return this.hostPrefix;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void setHostPrefix(String hostPrefix) {
+        this.hostPrefix = hostPrefix;
+    }
+
+    /**
+     * {@inheritDoc}
      */
     @Override
     public int getTimeOffset() {
         return timeOffset;
     }
 
     /**
-     * @see Request#setTimeOffset(int)
+     * {@inheritDoc}
      */
     @Override
     public void setTimeOffset(int timeOffset) {
         this.timeOffset = timeOffset;
     }
 
     /**
-     * @see Request#setTimeOffset(int)
+     * {@inheritDoc}
      */
     @Override
     @SuppressWarnings("checkstyle:hiddenfield")

aws-android-sdk-core/src/main/java/com/amazonaws/Request.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2010-2020 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.
@@ -151,6 +151,24 @@ public interface Request<T> {
      */
     public void setContent(InputStream content);
 
+    /**
+     * Returns the optional prefix to prepend to the request endpoint's host
+     * before sending this request.
+     *
+     * @return the optional prefix to prepend to the request endpoint host
+     *          before sending this request.
+     */
+    public String getHostPrefix();
+
+    /**
+     * Sets the optional prefix to prepend to the request endpoint's host before
+     * sending this request.
+     *
+     * @param hostPrefix The optional prefix to prepend to the request endpoint
+     *                   host.
+     */
+    public void setHostPrefix(String hostPrefix);
+
     /**
      * Returns the name of the Amazon service this request is for.
      *

aws-android-sdk-core/src/main/java/com/amazonaws/http/AmazonHttpClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2010-2020 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.
@@ -43,9 +43,12 @@
 
 import com.amazonaws.logging.Log;
 import com.amazonaws.logging.LogFactory;
+import com.amazonaws.util.URIBuilder;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
@@ -201,6 +204,20 @@ public <T> Response<T> execute(Request<?> request,
             HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler,
             HttpResponseHandler<AmazonServiceException> errorResponseHandler,
             ExecutionContext executionContext) {
+        // Prepend host prefix if specified in the request.
+        if (request.getHostPrefix() != null) {
+            try {
+                URI endpoint = request.getEndpoint();
+                String host = request.getHostPrefix() + endpoint.getHost();
+                request.setEndpoint(URIBuilder.builder(endpoint)
+                        .host(host)
+                        .build());
+            } catch (URISyntaxException error) {
+                if (log.isDebugEnabled()) {
+                    log.debug("Failed to prepend host prefix: " + error.getMessage(), error);
+                }
+            }
+        }
         if (executionContext == null) {
             throw new AmazonClientException(
                     "Internal SDK Error: No execution context parameter specified.");
@@ -261,8 +278,6 @@ List<RequestHandler2> requestHandler2s(Request<?> request,
      * Internal method to execute the HTTP method given.
      *
      * @see AmazonHttpClient#execute(Request, HttpResponseHandler,
-     *      HttpResponseHandler)
-     * @see AmazonHttpClient#execute(Request, HttpResponseHandler,
      *      HttpResponseHandler, ExecutionContext)
      */
     @SuppressWarnings("checkstyle:methodlength")
@@ -564,7 +579,6 @@ public void shutdown() {
      *
      * @param originalRequest The original service request that is being
      *            executed.
-     * @param method The current HTTP method being executed.
      * @param exception The client/service exception from the failed request.
      * @param requestCount The number of times the current request has been
      *            attempted.
@@ -628,8 +642,6 @@ private boolean isRequestSuccessful(HttpResponse response) {
      *            handled.
      * @param responseHandler The response unmarshaller used to interpret the
      *            contents of the response.
-     * @param method The HTTP method that was invoked, and contains the contents
-     *            of the response.
      * @param executionContext Extra state information about the request
      *            currently being executed.
      * @return The contents of the response, unmarshalled using the specified
@@ -686,7 +698,6 @@ <T> T handleResponse(Request<?> request,
      *            handled.
      * @param errorResponseHandler The response handler responsible for
      *            unmarshalling the error response.
-     * @param method The HTTP method containing the actual response content.
      * @throws IOException If any problems are encountering reading the error
      *             response.
      */