Move Stax parser classes and AWS speicifc JSON Unmarshaller/Mashaller to aws-core

Author: zoewangg

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

@@ -33,7 +33,7 @@
 import software.amazon.awssdk.utils.Validate;
 
 @SdkInternalApi
-class AwsClientHandlerUtils {
+final class AwsClientHandlerUtils {
 
     private AwsClientHandlerUtils() {
 

core/src/main/java/software/amazon/awssdk/core/internal/http/response/JsonErrorResponseHandler.java renamed to aws-core/src/main/java/software/amazon/awssdk/awscore/http/response/AwsJsonErrorResponseHandler.java

@@ -13,42 +13,37 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.core.internal.http.response;
+package software.amazon.awssdk.awscore.http.response;
 
 import com.fasterxml.jackson.core.JsonFactory;
 import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.annotations.SdkInternalApi;
-import software.amazon.awssdk.core.exception.ErrorType;
+import software.amazon.awssdk.awscore.protocol.json.AwsJsonErrorUnmarshaller;
+import software.amazon.awssdk.awscore.protocol.json.ErrorCodeParser;
 import software.amazon.awssdk.core.exception.SdkServiceException;
 import software.amazon.awssdk.core.http.HttpResponse;
-import software.amazon.awssdk.core.http.HttpResponseHandler;
 import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
 import software.amazon.awssdk.core.interceptor.SdkExecutionAttributes;
-import software.amazon.awssdk.core.internal.http.ErrorCodeParser;
+import software.amazon.awssdk.core.protocol.json.ErrorMessageParser;
 import software.amazon.awssdk.core.protocol.json.JsonContent;
-import software.amazon.awssdk.core.runtime.http.JsonErrorMessageParser;
-import software.amazon.awssdk.core.runtime.transform.JsonErrorUnmarshaller;
-import software.amazon.awssdk.http.HttpStatusFamily;
+import software.amazon.awssdk.core.runtime.http.response.JsonErrorResponseHandler;
 
+/**
+ * Implementation of HttpResponseHandler that handles a error response from AWS
+ * services and unmarshalls the result using a JSON unmarshaller.
+ */
 @SdkInternalApi
-public class JsonErrorResponseHandler implements HttpResponseHandler<SdkServiceException> {
-
-    private static final Logger log = LoggerFactory.getLogger(JsonErrorResponseHandler.class);
+public class AwsJsonErrorResponseHandler extends JsonErrorResponseHandler {
 
-    private final List<JsonErrorUnmarshaller> unmarshallers;
+    private final List<AwsJsonErrorUnmarshaller> unmarshallers;
     private final ErrorCodeParser errorCodeParser;
-    private final JsonErrorMessageParser errorMessageParser;
+    private final ErrorMessageParser errorMessageParser;
     private final JsonFactory jsonFactory;
 
-    public JsonErrorResponseHandler(
-            List<JsonErrorUnmarshaller> errorUnmarshallers,
-            ErrorCodeParser errorCodeParser,
-            JsonErrorMessageParser errorMessageParser,
-            JsonFactory jsonFactory) {
+    public AwsJsonErrorResponseHandler(List<AwsJsonErrorUnmarshaller> errorUnmarshallers,
+                                       ErrorCodeParser errorCodeParser,
+                                       ErrorMessageParser errorMessageParser,
+                                       JsonFactory jsonFactory) {
         this.unmarshallers = errorUnmarshallers;
         this.errorCodeParser = errorCodeParser;
         this.errorMessageParser = errorMessageParser;
@@ -88,44 +83,15 @@ public SdkServiceException handle(HttpResponse response,
      * Create an SdkServiceException using the chain of unmarshallers. This method will never
      * return null, it will always return a valid SdkServiceException
      *
-     * @param errorCode   Error code to find an appropriate unmarshaller
+     * @param errorCode Error code to find an appropriate unmarshaller
      * @param jsonContent JsonContent of HTTP response
      * @return SdkServiceException
      */
     private SdkServiceException createException(String errorCode, JsonContent jsonContent) {
-        SdkServiceException exception = unmarshallException(errorCode, jsonContent);
-        if (exception == null) {
-            exception = new SdkServiceException(
-                    "Unable to unmarshall exception response with the unmarshallers provided");
-        }
-        return exception;
-    }
-
-    private SdkServiceException unmarshallException(String errorCode, JsonContent jsonContent) {
-        for (JsonErrorUnmarshaller unmarshaller : unmarshallers) {
-            if (unmarshaller.matchErrorCode(errorCode)) {
-                try {
-                    return unmarshaller.unmarshall(jsonContent.getJsonNode());
-                } catch (Exception e) {
-                    log.debug("Unable to unmarshall exception content", e);
-                    return null;
-                }
-            }
-        }
-        return null;
+        return unmarshallers.stream()
+                            .filter(u -> u.matchErrorCode(errorCode))
+                            .findFirst()
+                            .map(u -> safeUnmarshall(jsonContent, u))
+                            .orElseGet(this::createUnknownException);
     }
-
-    private ErrorType getErrorType(int statusCode) {
-        return HttpStatusFamily.of(statusCode) == HttpStatusFamily.SERVER_ERROR ? ErrorType.SERVICE : ErrorType.CLIENT;
-    }
-
-    private String getRequestIdFromHeaders(Map<String, String> headers) {
-        for (Entry<String, String> headerEntry : headers.entrySet()) {
-            if (headerEntry.getKey().equalsIgnoreCase(X_AMZN_REQUEST_ID_HEADER)) {
-                return headerEntry.getValue();
-            }
-        }
-        return null;
-    }
-
 }

aws-core/src/main/java/software/amazon/awssdk/awscore/http/DefaultErrorResponseHandler.java renamed to aws-core/src/main/java/software/amazon/awssdk/awscore/http/response/DefaultErrorResponseHandler.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.awscore.http;
+package software.amazon.awssdk.awscore.http.response;
 
 import java.io.IOException;
 import java.io.InputStream;

core/src/main/java/software/amazon/awssdk/core/http/StaxResponseHandler.java renamed to aws-core/src/main/java/software/amazon/awssdk/awscore/http/response/StaxResponseHandler.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.core.http;
+package software.amazon.awssdk.awscore.http.response;
 
 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
@@ -22,12 +22,16 @@
 import javax.xml.stream.XMLStreamException;
 import software.amazon.awssdk.annotations.ReviewBeforeRelease;
 import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.awscore.protocol.xml.StaxUnmarshallerContext;
+import software.amazon.awssdk.awscore.protocol.xml.VoidStaxUnmarshaller;
 import software.amazon.awssdk.core.ResponseMetadata;
 import software.amazon.awssdk.core.SdkStandardLoggers;
+import software.amazon.awssdk.core.async.AsyncResponseTransformer;
+import software.amazon.awssdk.core.http.HttpResponse;
+import software.amazon.awssdk.core.http.HttpResponseHandler;
 import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
-import software.amazon.awssdk.core.runtime.transform.StaxUnmarshallerContext;
 import software.amazon.awssdk.core.runtime.transform.Unmarshaller;
-import software.amazon.awssdk.core.runtime.transform.VoidStaxUnmarshaller;
+import software.amazon.awssdk.core.sync.ResponseTransformer;
 import software.amazon.awssdk.core.util.StringUtils;
 import software.amazon.awssdk.utils.FunctionalUtils.UnsafeFunction;
 import software.amazon.awssdk.utils.Logger;
@@ -137,7 +141,7 @@ public boolean needsConnectionLeftOpen() {
 
     /**
      * Creates an synchronous {@link HttpResponseHandler} that unmarshalls into the response POJO while leaving the
-     * connection open for further processing (by a {@link StreamingResponseHandler} or {@link AsyncResponseHandler}
+     * connection open for further processing (by a {@link ResponseTransformer} or {@link AsyncResponseTransformer}
      * for example).
      *
      * @param unmarshaller Unmarshaller for response POJO.
@@ -161,7 +165,7 @@ public boolean needsConnectionLeftOpen() {
 
     /**
      * Unmarshalls a streaming HTTP response into a POJO. Does not touch the content since that's consumed by the response
-     * handler (either {@link StreamingResponseHandler} or {@link AsyncResponseHandler}).
+     * handler (either {@link ResponseTransformer} or {@link AsyncResponseTransformer}).
      *
      * @param unmarshaller Unmarshaller for resposne type.
      * @param response HTTP response

aws-core/src/main/java/software/amazon/awssdk/awscore/protocol/json/AwsJsonErrorMessageParser.java

@@ -0,0 +1,61 @@
+/*
+ * 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.awscore.protocol.json;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.core.http.HttpResponse;
+import software.amazon.awssdk.core.protocol.json.ErrorMessageParser;
+import software.amazon.awssdk.core.protocol.json.SdkJsonErrorMessageParser;
+
+@SdkProtectedApi
+public class AwsJsonErrorMessageParser implements ErrorMessageParser {
+
+    static final ErrorMessageParser DEFAULT_ERROR_MESSAGE_PARSER =
+        new AwsJsonErrorMessageParser(SdkJsonErrorMessageParser.DEFAULT_ERROR_MESSAGE_PARSER);
+
+    /**
+     * x-amzn-error-message may be returned by RESTFUL services that do not send a response
+     * payload (like in a HEAD request).
+     */
+    private static final String X_AMZN_ERROR_MESSAGE = "x-amzn-error-message";
+
+    private SdkJsonErrorMessageParser errorMessageParser;
+
+    /**
+     * @param errorMessageJsonLocations JSON field locations where the parser will attempt to
+     * extract the error message from.
+     */
+    public AwsJsonErrorMessageParser(SdkJsonErrorMessageParser errorMessageJsonLocations) {
+        this.errorMessageParser = errorMessageJsonLocations;
+    }
+
+    /**
+     * Parse the error message from the response.
+     *
+     * @return Error Code of exceptional response or null if it can't be determined
+     */
+    @Override
+    public String parseErrorMessage(HttpResponse httpResponse, JsonNode jsonNode) {
+        // If X_AMZN_ERROR_MESSAGE is present, prefer that. Otherwise check the JSON body.
+        final String headerMessage = httpResponse.getHeader(X_AMZN_ERROR_MESSAGE);
+        if (headerMessage != null) {
+            return headerMessage;
+        }
+        return errorMessageParser.parseErrorMessage(httpResponse, jsonNode);
+    }
+
+}

aws-core/src/main/java/software/amazon/awssdk/awscore/protocol/json/AwsJsonErrorUnmarshaller.java

@@ -0,0 +1,59 @@
+/*
+ * 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.awscore.protocol.json;
+
+import static com.fasterxml.jackson.databind.PropertyNamingStrategy.UPPER_CAMEL_CASE;
+
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
+import software.amazon.awssdk.core.exception.SdkServiceException;
+import software.amazon.awssdk.core.protocol.json.JsonErrorUnmarshaller;
+
+/**
+ * Unmarshaller for JSON error responses from AWS services.
+ */
+@SdkInternalApi
+@ThreadSafe
+public class AwsJsonErrorUnmarshaller extends JsonErrorUnmarshaller {
+
+    public static final AwsJsonErrorUnmarshaller DEFAULT_UNMARSHALLER = new AwsJsonErrorUnmarshaller(
+        SdkServiceException.class, null);
+
+    private static final ObjectMapper MAPPER = new ObjectMapper().configure(
+            DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false).setPropertyNamingStrategy(UPPER_CAMEL_CASE);
+
+    private final String handledErrorCode;
+
+    /**
+     * @param exceptionClass   Exception class this unmarshaller will attempt to deserialize error response into
+     * @param handledErrorCode AWS error code that this unmarshaller handles. Pass null to handle all exceptions
+     */
+    public AwsJsonErrorUnmarshaller(Class<? extends SdkServiceException> exceptionClass, String handledErrorCode) {
+        super(exceptionClass);
+        this.handledErrorCode = handledErrorCode;
+    }
+
+    /**
+     * @param actualErrorCode Actual AWS error code found in the error response.
+     * @return True if the actualErrorCode can be handled by this unmarshaller, false otherwise
+     */
+    public boolean matchErrorCode(String actualErrorCode) {
+        return handledErrorCode == null || handledErrorCode.equals(actualErrorCode);
+    }
+
+}

core/src/main/java/software/amazon/awssdk/core/protocol/Protocol.java renamed to aws-core/src/main/java/software/amazon/awssdk/awscore/protocol/json/AwsJsonProtocol.java

@@ -13,12 +13,15 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.core.protocol;
+package software.amazon.awssdk.awscore.protocol.json;
+
+import software.amazon.awssdk.annotations.SdkInternalApi;
 
 /**
  * Supported protocols for the new marshalling style. Currently only includes JSON based services.
  */
-public enum Protocol {
+@SdkInternalApi
+public enum AwsJsonProtocol {
 
     /**
      * RPC protocol that sends all data in the payload as JSON and sends the X-Amz-Target header to indicate the
@@ -31,9 +34,4 @@ public enum Protocol {
      * binary and streaming data. Operation is identified by HTTP verb and resource path combination.
      */
     REST_JSON,
-
-    /**
-     * A variation of REST_JSON for externally generated, API Gateway clients.
-     */
-    API_GATEWAY
 }