AWS SNS Rule Node

rule-engine/rule-engine-components/pom.xml

@@ -35,6 +35,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <main.dir>${basedir}/../..</main.dir>
+        <aws.sdk.version>1.11.323</aws.sdk.version>
     </properties>
 
     <dependencies>
@@ -90,6 +91,11 @@
             <groupId>org.apache.kafka</groupId>
             <artifactId>kafka_2.10</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.amazonaws</groupId>
+            <artifactId>aws-java-sdk-sns</artifactId>
+            <version>${aws.sdk.version}</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/aws/sns/TbSnsNode.java

@@ -0,0 +1,119 @@
+/**
+ * Copyright © 2016-2018 The Thingsboard Authors
+ *
+ * Licensed 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.thingsboard.rule.engine.aws.sns;
+
+import com.amazonaws.auth.AWSCredentials;
+import com.amazonaws.auth.AWSStaticCredentialsProvider;
+import com.amazonaws.auth.BasicAWSCredentials;
+import com.amazonaws.regions.Region;
+import com.amazonaws.regions.Regions;
+import com.amazonaws.services.sns.AmazonSNS;
+import com.amazonaws.services.sns.AmazonSNSClient;
+import com.amazonaws.services.sns.model.PublishRequest;
+import com.amazonaws.services.sns.model.PublishResult;
+import com.google.common.util.concurrent.ListenableFuture;
+import lombok.extern.slf4j.Slf4j;
+import org.thingsboard.rule.engine.TbNodeUtils;
+import org.thingsboard.rule.engine.api.*;
+import org.thingsboard.server.common.data.plugin.ComponentType;
+import org.thingsboard.server.common.msg.TbMsg;
+import org.thingsboard.server.common.msg.TbMsgMetaData;
+
+import java.util.concurrent.ExecutionException;
+
+import static org.thingsboard.rule.engine.DonAsynchron.withCallback;
+
+@Slf4j
+@RuleNode(
+        type = ComponentType.ACTION,
+        name = "aws sns",
+        configClazz = TbSnsNodeConfiguration.class,
+        nodeDescription = "Publish messages to AWS SNS",
+        nodeDetails = "Expects messages with any message type. Will publish message to AWS SNS topic.",
+        uiResources = {"static/rulenode/rulenode-core-config.js"},
+        configDirective = "tbActionNodeSnsConfig"
+)
+public class TbSnsNode implements TbNode {
+
+    private static final String MESSAGE_ID = "messageId";
+    private static final String REQUEST_ID = "requestId";
+    private static final String ERROR = "error";
+
+    private TbSnsNodeConfiguration config;
+    private AmazonSNS snsClient;
+
+    @Override
+    public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
+        this.config = TbNodeUtils.convert(configuration, TbSnsNodeConfiguration.class);
+        AWSCredentials awsCredentials = new BasicAWSCredentials(this.config.getAccessKeyId(), this.config.getSecretAccessKey());
+        AWSStaticCredentialsProvider credProvider = new AWSStaticCredentialsProvider(awsCredentials);
+        try {
+            this.snsClient = AmazonSNSClient.builder()
+                    .withCredentials(credProvider)
+                    .withRegion(this.config.getRegion())
+                    .build();
+        } catch (Exception e) {
+            throw new TbNodeException(e);
+        }
+    }
+
+    @Override
+    public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException {
+        withCallback(publishMessageAsync(ctx, msg),
+                m -> ctx.tellNext(m, TbRelationTypes.SUCCESS),
+                t -> {
+                    TbMsg next = processException(ctx, msg, t);
+                    ctx.tellNext(next, TbRelationTypes.FAILURE, t);
+                });
+    }
+
+    ListenableFuture<TbMsg> publishMessageAsync(TbContext ctx, TbMsg msg) {
+        return ctx.getExternalCallExecutor().executeAsync(() -> publishMessage(ctx, msg));
+    }
+
+    TbMsg publishMessage(TbContext ctx, TbMsg msg) {
+        String topicArn = TbNodeUtils.processPattern(this.config.getTopicArnPattern(), msg.getMetaData());
+        PublishRequest publishRequest = new PublishRequest()
+                .withTopicArn(topicArn)
+                .withMessage(msg.getData());
+        PublishResult result = this.snsClient.publish(publishRequest);
+        return processPublishResult(ctx, msg, result);
+    }
+
+    private TbMsg processPublishResult(TbContext ctx, TbMsg origMsg, PublishResult result) {
+        TbMsgMetaData metaData = origMsg.getMetaData().copy();
+        metaData.putValue(MESSAGE_ID, result.getMessageId());
+        metaData.putValue(REQUEST_ID, result.getSdkResponseMetadata().getRequestId());
+        return ctx.transformMsg(origMsg, origMsg.getType(), origMsg.getOriginator(), metaData, origMsg.getData());
+    }
+
+    private TbMsg processException(TbContext ctx, TbMsg origMsg, Throwable t) {
+        TbMsgMetaData metaData = origMsg.getMetaData().copy();
+        metaData.putValue(ERROR, t.getClass() + ": " + t.getMessage());
+        return ctx.transformMsg(origMsg, origMsg.getType(), origMsg.getOriginator(), metaData, origMsg.getData());
+    }
+
+    @Override
+    public void destroy() {
+        if (this.snsClient != null) {
+            try {
+                this.snsClient.shutdown();
+            } catch (Exception e) {
+                log.error("Failed to shutdown SNS client during destroy()", e);
+            }
+        }
+    }
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/aws/sns/TbSnsNodeConfiguration.java

@@ -0,0 +1,37 @@
+/**
+ * Copyright © 2016-2018 The Thingsboard Authors
+ *
+ * Licensed 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.thingsboard.rule.engine.aws.sns;
+
+import lombok.Data;
+import org.thingsboard.rule.engine.api.NodeConfiguration;
+
+@Data
+public class TbSnsNodeConfiguration implements NodeConfiguration<TbSnsNodeConfiguration> {
+
+    private String topicArnPattern;
+    private String accessKeyId;
+    private String secretAccessKey;
+    private String region;
+
+    @Override
+    public TbSnsNodeConfiguration defaultConfiguration() {
+        TbSnsNodeConfiguration configuration = new TbSnsNodeConfiguration();
+        configuration.setTopicArnPattern("arn:aws:sns:us-east-1:123456789012:MyNewTopic");
+        configuration.setRegion("us-east-1");
+        return configuration;
+    }
+}