Merge pull request #1267 from ShvaykaD/master

added assign/unassign to/from customer rule nodes

application/src/main/java/org/thingsboard/server/actors/ActorSystemContext.java

@@ -48,6 +48,7 @@ import org.thingsboard.server.dao.asset.AssetService;
 import org.thingsboard.server.dao.attributes.AttributesService;
 import org.thingsboard.server.dao.audit.AuditLogService;
 import org.thingsboard.server.dao.customer.CustomerService;
+import org.thingsboard.server.dao.dashboard.DashboardService;
 import org.thingsboard.server.dao.device.DeviceService;
 import org.thingsboard.server.dao.entityview.EntityViewService;
 import org.thingsboard.server.dao.event.EventService;
@@ -124,6 +125,10 @@ public class ActorSystemContext {
     @Getter
     private AssetService assetService;
 
+    @Autowired
+    @Getter
+    private DashboardService dashboardService;
+
     @Autowired
     @Getter
     private TenantService tenantService;

application/src/main/java/org/thingsboard/server/actors/ruleChain/DefaultTbContext.java

@@ -43,6 +43,7 @@ import org.thingsboard.server.dao.alarm.AlarmService;
 import org.thingsboard.server.dao.asset.AssetService;
 import org.thingsboard.server.dao.attributes.AttributesService;
 import org.thingsboard.server.dao.customer.CustomerService;
+import org.thingsboard.server.dao.dashboard.DashboardService;
 import org.thingsboard.server.dao.device.DeviceService;
 import org.thingsboard.server.dao.entityview.EntityViewService;
 import org.thingsboard.server.dao.relation.RelationService;
@@ -196,6 +197,11 @@ class DefaultTbContext implements TbContext {
         return mainCtx.getDeviceService();
     }
 
+    @Override
+    public DashboardService getDashboardService() {
+        return mainCtx.getDashboardService();
+    }
+
     @Override
     public AlarmService getAlarmService() {
         return mainCtx.getAlarmService();

rule-engine/rule-engine-api/src/main/java/org/thingsboard/rule/engine/api/TbContext.java

@@ -25,6 +25,7 @@ import org.thingsboard.server.dao.alarm.AlarmService;
 import org.thingsboard.server.dao.asset.AssetService;
 import org.thingsboard.server.dao.attributes.AttributesService;
 import org.thingsboard.server.dao.customer.CustomerService;
+import org.thingsboard.server.dao.dashboard.DashboardService;
 import org.thingsboard.server.dao.device.DeviceService;
 import org.thingsboard.server.dao.entityview.EntityViewService;
 import org.thingsboard.server.dao.relation.RelationService;
@@ -73,6 +74,8 @@ public interface TbContext {
 
     DeviceService getDeviceService();
 
+    DashboardService getDashboardService();
+
     AlarmService getAlarmService();
 
     RuleChainService getRuleChainService();

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbAbstractCustomerActionNode.java

@@ -0,0 +1,130 @@
+/**
+ * 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.action;
+
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.thingsboard.rule.engine.api.TbContext;
+import org.thingsboard.rule.engine.api.TbNode;
+import org.thingsboard.rule.engine.api.TbNodeConfiguration;
+import org.thingsboard.rule.engine.api.TbNodeException;
+import org.thingsboard.rule.engine.api.util.TbNodeUtils;
+import org.thingsboard.server.common.data.Customer;
+import org.thingsboard.server.common.data.id.CustomerId;
+import org.thingsboard.server.common.msg.TbMsg;
+import org.thingsboard.server.dao.customer.CustomerService;
+
+import java.util.Optional;
+import java.util.concurrent.TimeUnit;
+
+import static org.thingsboard.rule.engine.api.util.DonAsynchron.withCallback;
+
+@Slf4j
+public abstract class TbAbstractCustomerActionNode<C extends TbAbstractCustomerActionNodeConfiguration> implements TbNode {
+
+    protected C config;
+
+    private LoadingCache<CustomerKey, Optional<CustomerId>> customerIdCache;
+
+    @Override
+    public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
+        this.config = loadCustomerNodeActionConfig(configuration);
+        CacheBuilder cacheBuilder = CacheBuilder.newBuilder();
+        if (this.config.getCustomerCacheExpiration() > 0) {
+            cacheBuilder.expireAfterWrite(this.config.getCustomerCacheExpiration(), TimeUnit.SECONDS);
+        }
+        customerIdCache = cacheBuilder
+                .build(new CustomerCacheLoader(ctx, createCustomerIfNotExists()));
+    }
+
+    protected abstract boolean createCustomerIfNotExists();
+
+    protected abstract C loadCustomerNodeActionConfig(TbNodeConfiguration configuration) throws TbNodeException;
+
+    @Override
+    public void onMsg(TbContext ctx, TbMsg msg) {
+        withCallback(processCustomerAction(ctx, msg),
+                m -> ctx.tellNext(msg, "Success"),
+                t -> ctx.tellFailure(msg, t), ctx.getDbCallbackExecutor());
+    }
+
+    private ListenableFuture<Void> processCustomerAction(TbContext ctx, TbMsg msg) {
+        ListenableFuture<CustomerId> customerIdFeature = getCustomer(ctx, msg);
+        return Futures.transform(customerIdFeature, customerId -> {
+                    doProcessCustomerAction(ctx, msg, customerId);
+                    return null;
+                }, ctx.getDbCallbackExecutor()
+        );
+    }
+
+    protected abstract void doProcessCustomerAction(TbContext ctx, TbMsg msg, CustomerId customerId);
+
+    protected ListenableFuture<CustomerId> getCustomer(TbContext ctx, TbMsg msg) {
+        String customerTitle = TbNodeUtils.processPattern(this.config.getCustomerNamePattern(), msg.getMetaData());
+        CustomerKey key = new CustomerKey(customerTitle);
+        return ctx.getDbCallbackExecutor().executeAsync(() -> {
+            Optional<CustomerId> customerId = customerIdCache.get(key);
+            if (!customerId.isPresent()) {
+                throw new RuntimeException("No customer found with name '" + key.getCustomerTitle() + "'.");
+            }
+            return customerId.get();
+        });
+    }
+
+    @Override
+    public void destroy() {
+    }
+
+    @Data
+    @AllArgsConstructor
+    private static class CustomerKey {
+        private String customerTitle;
+    }
+
+    private static class CustomerCacheLoader extends CacheLoader<CustomerKey, Optional<CustomerId>> {
+
+        private final TbContext ctx;
+        private final boolean createIfNotExists;
+
+        private CustomerCacheLoader(TbContext ctx, boolean createIfNotExists) {
+            this.ctx = ctx;
+            this.createIfNotExists = createIfNotExists;
+        }
+
+        @Override
+        public Optional<CustomerId> load(CustomerKey key) {
+            CustomerService service = ctx.getCustomerService();
+            Optional<Customer> customerOptional =
+                    service.findCustomerByTenantIdAndTitle(ctx.getTenantId(), key.getCustomerTitle());
+            if (customerOptional.isPresent()) {
+                return Optional.of(customerOptional.get().getId());
+            } else if (createIfNotExists) {
+                Customer newCustomer = new Customer();
+                newCustomer.setTitle(key.getCustomerTitle());
+                newCustomer.setTenantId(ctx.getTenantId());
+                return Optional.of(service.saveCustomer(newCustomer).getId());
+            }
+            return Optional.empty();
+        }
+    }
+
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbAbstractCustomerActionNodeConfiguration.java

@@ -0,0 +1,29 @@
+/**
+ * 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.action;
+
+import lombok.Data;
+
+/**
+ * Created by igor on 6/1/18.
+ */
+@Data
+public abstract class TbAbstractCustomerActionNodeConfiguration {
+
+    private String customerNamePattern;
+    private long customerCacheExpiration;
+
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbAssignToCustomerNode.java

@@ -0,0 +1,92 @@
+/**
+ * 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.action;
+
+import lombok.extern.slf4j.Slf4j;
+import org.thingsboard.rule.engine.api.RuleNode;
+import org.thingsboard.rule.engine.api.TbContext;
+import org.thingsboard.rule.engine.api.TbNodeConfiguration;
+import org.thingsboard.rule.engine.api.TbNodeException;
+import org.thingsboard.rule.engine.api.util.TbNodeUtils;
+import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.id.*;
+import org.thingsboard.server.common.data.plugin.ComponentType;
+import org.thingsboard.server.common.msg.TbMsg;
+
+@Slf4j
+@RuleNode(
+        type = ComponentType.ACTION,
+        name = "assign to customer",
+        configClazz = TbAssignToCustomerNodeConfiguration.class,
+        nodeDescription = "Assign Message Originator Entity to Customer",
+        nodeDetails = "Finds target Customer by customer name pattern and then assign Originator Entity to this customer. " +
+                "Will create new Customer if it doesn't exists and 'Create new Customer if not exists' is set to true.",
+        uiResources = {"static/rulenode/rulenode-core-config.js"},
+        configDirective = "tbActionNodeAssignToCustomerConfig",
+        icon = "add_circle"
+)
+public class TbAssignToCustomerNode extends TbAbstractCustomerActionNode<TbAssignToCustomerNodeConfiguration> {
+
+    @Override
+    protected boolean createCustomerIfNotExists() {
+        return config.isCreateCustomerIfNotExists();
+    }
+
+    @Override
+    protected TbAssignToCustomerNodeConfiguration loadCustomerNodeActionConfig(TbNodeConfiguration configuration) throws TbNodeException {
+        return TbNodeUtils.convert(configuration, TbAssignToCustomerNodeConfiguration.class);
+    }
+
+    @Override
+    protected void doProcessCustomerAction(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        EntityType originatorType = msg.getOriginator().getEntityType();
+        switch (originatorType) {
+            case DEVICE:
+                processAssignDevice(ctx, msg, customerId);
+                break;
+            case ASSET:
+                processAssignAsset(ctx, msg, customerId);
+                break;
+            case ENTITY_VIEW:
+                processAssignEntityView(ctx, msg, customerId);
+                break;
+            case DASHBOARD:
+                processAssignDashboard(ctx, msg, customerId);
+                break;
+            default:
+                ctx.tellFailure(msg, new RuntimeException("Unsupported originator type '" + originatorType +
+                        "'! Only 'DEVICE', 'ASSET',  'ENTITY_VIEW' or 'DASHBOARD' types are allowed."));
+                break;
+        }
+    }
+
+    private void processAssignAsset(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        ctx.getAssetService().assignAssetToCustomer(ctx.getTenantId(), new AssetId(msg.getOriginator().getId()), customerId);
+    }
+
+    private void processAssignDevice(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        ctx.getDeviceService().assignDeviceToCustomer(ctx.getTenantId(), new DeviceId(msg.getOriginator().getId()), customerId);
+    }
+
+    private void processAssignEntityView(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        ctx.getEntityViewService().assignEntityViewToCustomer(ctx.getTenantId(), new EntityViewId(msg.getOriginator().getId()), customerId);
+    }
+
+    private void processAssignDashboard(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        ctx.getDashboardService().assignDashboardToCustomer(ctx.getTenantId(), new DashboardId(msg.getOriginator().getId()), customerId);
+    }
+
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbAssignToCustomerNodeConfiguration.java

@@ -0,0 +1,34 @@
+/**
+ * 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.action;
+
+import lombok.Data;
+import org.thingsboard.rule.engine.api.NodeConfiguration;
+
+@Data
+public class TbAssignToCustomerNodeConfiguration extends TbAbstractCustomerActionNodeConfiguration implements NodeConfiguration<TbAssignToCustomerNodeConfiguration> {
+
+    private boolean createCustomerIfNotExists;
+
+    @Override
+    public TbAssignToCustomerNodeConfiguration defaultConfiguration() {
+        TbAssignToCustomerNodeConfiguration configuration = new TbAssignToCustomerNodeConfiguration();
+        configuration.setCustomerNamePattern("");
+        configuration.setCreateCustomerIfNotExists(false);
+        configuration.setCustomerCacheExpiration(300);
+        return configuration;
+    }
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbUnassignFromCustomerNode.java

@@ -0,0 +1,88 @@
+/**
+ * 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.action;
+
+import org.thingsboard.rule.engine.api.RuleNode;
+import org.thingsboard.rule.engine.api.TbContext;
+import org.thingsboard.rule.engine.api.TbNodeConfiguration;
+import org.thingsboard.rule.engine.api.TbNodeException;
+import org.thingsboard.rule.engine.api.util.TbNodeUtils;
+import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.id.*;
+import org.thingsboard.server.common.data.plugin.ComponentType;
+import org.thingsboard.server.common.msg.TbMsg;
+
+@RuleNode(
+        type = ComponentType.ACTION,
+        name = "unassign from customer",
+        configClazz = TbUnassignFromCustomerNodeConfiguration.class,
+        nodeDescription = "Unassign Message Originator Entity from Customer",
+        nodeDetails = "Finds target Entity Customer by Customer name pattern and then unassign Originator Entity from this customer.",
+        uiResources = {"static/rulenode/rulenode-core-config.js"},
+        configDirective = "tbActionNodeUnAssignToCustomerConfig",
+        icon = "remove_circle"
+)
+public class TbUnassignFromCustomerNode extends TbAbstractCustomerActionNode<TbUnassignFromCustomerNodeConfiguration> {
+
+    @Override
+    protected boolean createCustomerIfNotExists() {
+        return false;
+    }
+
+    @Override
+    protected TbUnassignFromCustomerNodeConfiguration loadCustomerNodeActionConfig(TbNodeConfiguration configuration) throws TbNodeException {
+        return TbNodeUtils.convert(configuration, TbUnassignFromCustomerNodeConfiguration.class);
+    }
+
+    @Override
+    protected void doProcessCustomerAction(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        EntityType originatorType = msg.getOriginator().getEntityType();
+        switch (originatorType) {
+            case DEVICE:
+                processUnnasignDevice(ctx, msg);
+                break;
+            case ASSET:
+                processUnnasignAsset(ctx, msg);
+                break;
+            case ENTITY_VIEW:
+                processUnassignEntityView(ctx, msg);
+                break;
+            case DASHBOARD:
+                processUnnasignDashboard(ctx, msg, customerId);
+                break;
+            default:
+                ctx.tellFailure(msg, new RuntimeException("Unsupported originator type '" + originatorType +
+                        "'! Only 'DEVICE', 'ASSET',  'ENTITY_VIEW' or 'DASHBOARD' types are allowed."));
+                break;
+        }
+    }
+
+    private void processUnnasignAsset(TbContext ctx, TbMsg msg) {
+        ctx.getAssetService().unassignAssetFromCustomer(ctx.getTenantId(), new AssetId(msg.getOriginator().getId()));
+    }
+
+    private void processUnnasignDevice(TbContext ctx, TbMsg msg) {
+        ctx.getDeviceService().unassignDeviceFromCustomer(ctx.getTenantId(), new DeviceId(msg.getOriginator().getId()));
+    }
+
+    private void processUnnasignDashboard(TbContext ctx, TbMsg msg, CustomerId customerId) {
+        ctx.getDashboardService().unassignDashboardFromCustomer(ctx.getTenantId(), new DashboardId(msg.getOriginator().getId()), customerId);
+    }
+
+    private void processUnassignEntityView(TbContext ctx, TbMsg msg) {
+        ctx.getEntityViewService().unassignEntityViewFromCustomer(ctx.getTenantId(), new EntityViewId(msg.getOriginator().getId()));
+    }
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/action/TbUnassignFromCustomerNodeConfiguration.java

@@ -0,0 +1,31 @@
+/**
+ * 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.action;
+
+import lombok.Data;
+import org.thingsboard.rule.engine.api.NodeConfiguration;
+
+@Data
+public class TbUnassignFromCustomerNodeConfiguration extends TbAbstractCustomerActionNodeConfiguration implements NodeConfiguration<TbUnassignFromCustomerNodeConfiguration> {
+
+    @Override
+    public TbUnassignFromCustomerNodeConfiguration defaultConfiguration() {
+        TbUnassignFromCustomerNodeConfiguration configuration = new TbUnassignFromCustomerNodeConfiguration();
+        configuration.setCustomerNamePattern("");
+        configuration.setCustomerCacheExpiration(300);
+        return configuration;
+    }
+}