NIFI-5022 InvokeAWSGatewayApi processor

Author: ottobackwards

NOTICE

@@ -50,3 +50,27 @@ This includes derived works from Apache Calcite available under Apache Software
   Copyright 2012-2017 The Apache Software Foundation
   The code can be found in nifi-nar-bundles/nifi-standard-nar/nifi-standard-processors/../FlowFileProjectTableScanRule
   and nifi-nar-bundles/nifi-standard-nar/nifi-standard-processors/../FlowFileTableScan
+
+This includes derived works from apigateway-generic-java-sdk (ASLv2 licenced) project (https://github.com/rpgreen/apigateway-generic-java-sdk):
+  The derived work is adapted from
+    main/ca/ryangreen/apigateway/generic/
+      GenericApiGatewayClient.java
+      GenericApiGatewayClientBuilder.java
+      GenericApiGatewayException.java
+      GenericApiGatewayRequest.java
+      GenericApiGatewayRequestBuilder.java
+    test/ca/ryangreen/apigateway/generic/
+      GenericApiGatewayClientTest.java
+      LambdaMatcher.java
+  and can be found in the directories:
+    nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/../wag/client/
+      GenericApiGatewayClient.java
+      GenericApiGatewayClientBuilder.java
+      GenericApiGatewayException.java
+      GenericApiGatewayRequest.java
+      GenericApiGatewayRequestBuilder.java
+      Validate.java
+    nifi-nar-bundles/nifi-aws-bundle/nifi-aws-processors/src/test/../wag/
+      RequestMatcher.java
+      GetAWSGatewayApiTest.java
+

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/pom.xml

@@ -53,6 +53,11 @@
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-java-sdk-sqs</artifactId>
         </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>2.6</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/java/org/apache/nifi/processors/aws/AbstractAWSProcessor.java

@@ -130,11 +130,11 @@ public abstract class AbstractAWSProcessor<ClientType extends AmazonWebServiceCl
     protected static final Protocol DEFAULT_PROTOCOL = Protocol.HTTPS;
     protected static final String DEFAULT_USER_AGENT = "NiFi";
 
-    private static AllowableValue createAllowableValue(final Regions region) {
+    protected static AllowableValue createAllowableValue(final Regions region) {
         return new AllowableValue(region.getName(), AWSRegions.getRegionDisplayName(region.getName()));
     }
 
-    private static AllowableValue[] getAvailableRegions() {
+    protected static AllowableValue[] getAvailableRegions() {
         final List<AllowableValue> values = new ArrayList<>();
         for (final Regions region : Regions.values()) {
             values.add(createAllowableValue(region));

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/java/org/apache/nifi/processors/aws/wag/AbstractAWSGatewayApiProcessor.java

@@ -0,0 +1,133 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.apache.nifi.processors.aws.wag.client;
+
+import com.amazonaws.AmazonServiceException;
+import com.amazonaws.AmazonWebServiceClient;
+import com.amazonaws.ClientConfiguration;
+import com.amazonaws.DefaultRequest;
+import com.amazonaws.auth.AWS4Signer;
+import com.amazonaws.auth.AWSCredentialsProvider;
+import com.amazonaws.http.AmazonHttpClient;
+import com.amazonaws.http.ExecutionContext;
+import com.amazonaws.http.HttpMethodName;
+import com.amazonaws.http.HttpResponseHandler;
+import com.amazonaws.internal.auth.DefaultSignerProvider;
+import com.amazonaws.protocol.json.JsonOperationMetadata;
+import com.amazonaws.protocol.json.SdkStructuredPlainJsonFactory;
+import com.amazonaws.regions.Region;
+import com.amazonaws.transform.JsonErrorUnmarshaller;
+import com.amazonaws.transform.JsonUnmarshallerContext;
+import com.amazonaws.transform.Unmarshaller;
+import com.fasterxml.jackson.databind.JsonNode;
+import java.io.InputStream;
+import java.net.URI;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class GenericApiGatewayClient extends AmazonWebServiceClient {
+    private static final String API_GATEWAY_SERVICE_NAME = "execute-api";
+    private static final String API_KEY_HEADER = "x-api-key";
+
+    private final JsonResponseHandler<GenericApiGatewayResponse> responseHandler;
+    private final HttpResponseHandler<AmazonServiceException> errorResponseHandler;
+    private final AWSCredentialsProvider credentials;
+    private String apiKey;
+    private final AWS4Signer signer;
+
+    GenericApiGatewayClient(ClientConfiguration clientConfiguration, String endpoint, Region region,
+                            AWSCredentialsProvider credentials, String apiKey, AmazonHttpClient httpClient) {
+        super(clientConfiguration);
+        setRegion(region);
+        setEndpoint(endpoint);
+        this.credentials = credentials;
+        this.apiKey = apiKey;
+        this.signer = new AWS4Signer();
+        this.signer.setServiceName(API_GATEWAY_SERVICE_NAME);
+        this.signer.setRegionName(region.getName());
+
+        final JsonOperationMetadata metadata = new JsonOperationMetadata().withHasStreamingSuccessResponse(false).withPayloadJson(false);
+        final Unmarshaller<GenericApiGatewayResponse, JsonUnmarshallerContext> responseUnmarshaller = in -> new GenericApiGatewayResponse(in.getHttpResponse());
+        this.responseHandler = SdkStructuredPlainJsonFactory.SDK_JSON_FACTORY.createResponseHandler(metadata, responseUnmarshaller);
+        JsonErrorUnmarshaller defaultErrorUnmarshaller = new JsonErrorUnmarshaller(GenericApiGatewayException.class, null) {
+            @Override
+            public AmazonServiceException unmarshall(JsonNode jsonContent) throws Exception {
+                return new GenericApiGatewayException(jsonContent.toString());
+            }
+        };
+        this.errorResponseHandler = SdkStructuredPlainJsonFactory.SDK_JSON_FACTORY.createErrorResponseHandler(
+                Collections.singletonList(defaultErrorUnmarshaller), null);
+
+        if (httpClient != null) {
+            super.client = httpClient;
+        }
+    }
+
+    public GenericApiGatewayResponse execute(GenericApiGatewayRequest request) {
+        return execute(request.getHttpMethod(), request.getResourcePath(), request.getHeaders(), request.getParameters(), request.getBody());
+    }
+
+    private GenericApiGatewayResponse execute(HttpMethodName method, String resourcePath, Map<String, String> headers, Map<String,List<String>> parameters, InputStream content) {
+        final ExecutionContext executionContext = buildExecutionContext();
+
+        DefaultRequest request = new DefaultRequest(API_GATEWAY_SERVICE_NAME);
+        request.setHttpMethod(method);
+        request.setContent(content);
+        request.setEndpoint(this.endpoint);
+        request.setResourcePath(resourcePath);
+        request.setHeaders(buildRequestHeaders(headers, apiKey));
+        if (parameters != null) {
+            request.setParameters(parameters);
+        }
+        return this.client.execute(request, responseHandler, errorResponseHandler, executionContext).getAwsResponse();
+    }
+
+    private ExecutionContext buildExecutionContext() {
+        final ExecutionContext executionContext = ExecutionContext.builder().withSignerProvider(
+                new DefaultSignerProvider(this, signer)).build();
+        executionContext.setCredentialsProvider(credentials);
+        executionContext.setSigner(signer);
+        return executionContext;
+    }
+
+    private Map<String, String> buildRequestHeaders(Map<String, String> headers, String apiKey) {
+        if (headers == null) {
+            headers = new HashMap<>();
+        }
+        if (apiKey != null) {
+            final Map<String, String> headersWithApiKey = new HashMap<>();
+            headers.forEach(headersWithApiKey::put);
+            headersWithApiKey.put(API_KEY_HEADER, apiKey);
+            return headersWithApiKey;
+        } else {
+            return headers;
+        }
+    }
+
+    public URI getEndpoint() {
+        return this.endpoint;
+    }
+
+    @Override
+    protected String getServiceNameIntern() {
+        return API_GATEWAY_SERVICE_NAME;
+    }
+}
+
+

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/java/org/apache/nifi/processors/aws/wag/client/GenericApiGatewayClient.java

@@ -0,0 +1,92 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.apache.nifi.processors.aws.wag.client;
+
+import com.amazonaws.ClientConfiguration;
+import com.amazonaws.auth.AWSCredentialsProvider;
+import com.amazonaws.http.AmazonHttpClient;
+import com.amazonaws.regions.Region;
+
+public class GenericApiGatewayClientBuilder {
+    private String endpoint;
+    private Region region;
+    private AWSCredentialsProvider credentials;
+    private ClientConfiguration clientConfiguration;
+    private String apiKey;
+    private AmazonHttpClient httpClient;
+
+    public GenericApiGatewayClientBuilder withEndpoint(String endpoint) {
+        this.endpoint = endpoint;
+        return this;
+    }
+
+    public GenericApiGatewayClientBuilder withRegion(Region region) {
+        this.region = region;
+        return this;
+    }
+
+    public GenericApiGatewayClientBuilder withClientConfiguration(ClientConfiguration clientConfiguration) {
+        this.clientConfiguration = clientConfiguration;
+        return this;
+    }
+
+    public GenericApiGatewayClientBuilder withCredentials(AWSCredentialsProvider credentials) {
+        this.credentials = credentials;
+        return this;
+    }
+
+    public GenericApiGatewayClientBuilder withApiKey(String apiKey) {
+        this.apiKey = apiKey;
+        return this;
+    }
+
+    public GenericApiGatewayClientBuilder withHttpClient(AmazonHttpClient client) {
+        this.httpClient = client;
+        return this;
+    }
+
+    public AWSCredentialsProvider getCredentials() {
+        return credentials;
+    }
+
+    public String getApiKey() {
+        return apiKey;
+    }
+
+    public AmazonHttpClient getHttpClient() {
+        return httpClient;
+    }
+
+    public String getEndpoint() {
+        return endpoint;
+    }
+
+    public Region getRegion() {
+        return region;
+    }
+
+    public ClientConfiguration getClientConfiguration() {
+        return clientConfiguration;
+    }
+
+    public GenericApiGatewayClient build() {
+        Validate.notEmpty(endpoint, "Endpoint");
+        Validate.notNull(region, "Region");
+        return new GenericApiGatewayClient(clientConfiguration, endpoint, region, credentials, apiKey, httpClient);
+    }
+
+}

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/java/org/apache/nifi/processors/aws/wag/client/GenericApiGatewayClientBuilder.java

@@ -0,0 +1,29 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.apache.nifi.processors.aws.wag.client;
+
+import com.amazonaws.AmazonServiceException;
+
+public class GenericApiGatewayException extends AmazonServiceException {
+    public GenericApiGatewayException(String errorMessage) {
+        super(errorMessage);
+    }
+
+    public GenericApiGatewayException(String errorMessage, Exception cause) {
+        super(errorMessage, cause);
+    }
+}

nifi-nar-bundles/nifi-aws-bundle/nifi-aws-abstract-processors/src/main/java/org/apache/nifi/processors/aws/wag/client/GenericApiGatewayException.java

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.apache.nifi.processors.aws.wag.client;
+
+import com.amazonaws.http.HttpMethodName;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Map;
+
+public class GenericApiGatewayRequest {
+
+    private final HttpMethodName httpMethod;
+    private final String resourcePath;
+    private final InputStream body;
+    private final Map<String, String> headers;
+    private final Map<String, List<String>> parameters;
+
+    public GenericApiGatewayRequest(HttpMethodName httpMethod, String resourcePath,
+                                    InputStream body, Map<String, String> headers,
+                                    Map<String, List<String>> parameters) {
+        this.httpMethod = httpMethod;
+        this.resourcePath = resourcePath;
+        this.body = body;
+        this.headers = headers;
+        this.parameters = parameters;
+    }
+
+    public HttpMethodName getHttpMethod() {
+        return httpMethod;
+    }
+
+    public String getResourcePath() {
+        return resourcePath;
+    }
+
+    public InputStream getBody() {
+        return body;
+    }
+
+    public Map<String, String> getHeaders() {
+        return headers;
+    }
+
+    public Map<String, List<String>> getParameters() {
+        return parameters;
+    }
+}