rulemgt/src/main/java/org/onap/holmes/rulemgt/wrapper/RuleMgtWrapper.java

   1 /**\r
   2  * Copyright 2017 ZTE Corporation.\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 package org.onap.holmes.rulemgt.wrapper;\r
  17 \r
  18 import java.util.ArrayList;\r
  19 import java.util.Date;\r
  20 import java.util.List;\r
  21 import javax.annotation.PostConstruct;\r
  22 import javax.inject.Inject;\r
  23 import javax.inject.Singleton;\r
  24 import lombok.extern.slf4j.Slf4j;\r
  25 import org.jvnet.hk2.annotations.Service;\r
  26 import org.onap.holmes.common.dmaap.DmaapService;\r
  27 import org.onap.holmes.rulemgt.bean.request.CorrelationCheckRule4Engine;\r
  28 import org.onap.holmes.rulemgt.bean.response.RuleResult4API;\r
  29 import org.onap.holmes.rulemgt.constant.RuleMgtConstant;\r
  30 import org.onap.holmes.rulemgt.db.CorrelationRuleDao;\r
  31 import org.onap.holmes.common.api.entity.CorrelationRule;\r
  32 import org.onap.holmes.common.exception.CorrelationException;\r
  33 import org.onap.holmes.common.utils.DbDaoUtil;\r
  34 import org.onap.holmes.rulemgt.bean.request.CorrelationDeployRule4Engine;\r
  35 import org.onap.holmes.rulemgt.bean.request.RuleCreateRequest;\r
  36 import org.onap.holmes.rulemgt.bean.request.RuleDeleteRequest;\r
  37 import org.onap.holmes.rulemgt.bean.request.RuleQueryCondition;\r
  38 import org.onap.holmes.rulemgt.bean.request.RuleUpdateRequest;\r
  39 import org.onap.holmes.rulemgt.bean.response.RuleAddAndUpdateResponse;\r
  40 import org.onap.holmes.rulemgt.bean.response.RuleQueryListResponse;\r
  41 import org.onap.holmes.rulemgt.bolt.enginebolt.EngineWrapper;\r
  42 import org.onap.holmes.rulemgt.db.CorrelationRuleQueryDao;\r
  43 \r
  44 \r
  45 @Service\r
  46 @Singleton\r
  47 @Slf4j\r
  48 public class RuleMgtWrapper {\r
  49 \r
  50     @Inject\r
  51     private CorrelationRuleQueryDao correlationRuleQueryDao;\r
  52     @Inject\r
  53     private EngineWrapper engineWarpper;\r
  54     @Inject\r
  55     private DbDaoUtil daoUtil;\r
  56 \r
  57     private CorrelationRuleDao correlationRuleDao;\r
  58 \r
  59     @PostConstruct\r
  60     public void initDaoUtil() {\r
  61         correlationRuleDao = daoUtil.getJdbiDaoByOnDemand(CorrelationRuleDao.class);\r
  62     }\r
  63 \r
  64     public RuleAddAndUpdateResponse addCorrelationRule(String creator, RuleCreateRequest ruleCreateRequest)\r
  65             throws CorrelationException {\r
  66         if (ruleCreateRequest == null) {\r
  67             throw new CorrelationException("The request object can not be empty!");\r
  68         }\r
  69         CorrelationRule correlationRule = convertCreateRequest2Rule(creator,\r
  70                 ruleCreateRequest);\r
  71         checkCorrelation(correlationRule);\r
  72         CorrelationRule ruleTemp = correlationRuleDao.queryRuleByRuleName(correlationRule.getName());\r
  73         if (ruleTemp != null) {\r
  74             throw new CorrelationException("A rule with the same name already exists.");\r
  75         }\r
  76         String packageName = deployRule2Engine(correlationRule);\r
  77         DmaapService.loopControlNames.put(packageName, ruleCreateRequest.getLoopControlName());\r
  78         correlationRule.setPackageName(packageName);\r
  79         CorrelationRule result = correlationRuleDao.saveRule(correlationRule);\r
  80         RuleAddAndUpdateResponse ruleAddAndUpdateResponse = new RuleAddAndUpdateResponse();\r
  81         ruleAddAndUpdateResponse.setRuleId(result.getRid());\r
  82         return ruleAddAndUpdateResponse;\r
  83     }\r
  84 \r
  85     public RuleAddAndUpdateResponse updateCorrelationRule(String modifier, RuleUpdateRequest ruleUpdateRequest)\r
  86             throws CorrelationException {\r
  87         if (ruleUpdateRequest == null) {\r
  88             throw new CorrelationException("The request object can not be empty!");\r
  89         }\r
  90         CorrelationRule oldCorrelationRule = correlationRuleDao.queryRuleByRid(ruleUpdateRequest.getRuleId());\r
  91         if (oldCorrelationRule == null) {\r
  92             throw new CorrelationException("You're trying to update a rule which does not exist in the system.");\r
  93         }\r
  94         CorrelationRule newCorrelationRule = convertRuleUpdateRequest2CorrelationRule(modifier,\r
  95                 ruleUpdateRequest, oldCorrelationRule.getName());\r
  96         checkCorrelation(newCorrelationRule);\r
  97         RuleAddAndUpdateResponse ruleChangeResponse = new RuleAddAndUpdateResponse();\r
  98         ruleChangeResponse.setRuleId(newCorrelationRule.getRid());\r
  99         if (!haveChange(newCorrelationRule, oldCorrelationRule)) {\r
 100             return ruleChangeResponse;\r
 101         }\r
 102         if (oldCorrelationRule.getEnabled() == RuleMgtConstant.STATUS_RULE_OPEN) {\r
 103             engineWarpper.deleteRuleFromEngine(oldCorrelationRule.getPackageName());\r
 104         }\r
 105         newCorrelationRule.setPackageName(deployRule2Engine(newCorrelationRule));\r
 106         correlationRuleDao.updateRule(newCorrelationRule);\r
 107         return ruleChangeResponse;\r
 108     }\r
 109 \r
 110     private void checkCorrelation(CorrelationRule correlationRule) throws CorrelationException {\r
 111         int enabled = correlationRule.getEnabled();\r
 112         String ruleName = correlationRule.getName() == null ? "" : correlationRule.getName().trim();\r
 113         String content = correlationRule.getContent() == null ? "" : correlationRule.getContent().trim();\r
 114         if ("".equals(content)) {\r
 115             throw new CorrelationException("The contents of the rule can not be empty!");\r
 116         }\r
 117         if (enabled != RuleMgtConstant.STATUS_RULE_CLOSE\r
 118                 && enabled != RuleMgtConstant.STATUS_RULE_OPEN) {\r
 119             throw new CorrelationException("Invalid rule status. Only 0 (disabled) and 1 (enabled) are allowed.");\r
 120         }\r
 121         if ("".equals(ruleName)) {\r
 122             throw new CorrelationException("The name of the rule can not be empty.");\r
 123         }\r
 124     }\r
 125 \r
 126     private boolean haveChange(CorrelationRule newCorrelationRule, CorrelationRule oldCorrelationRule) {\r
 127         String newContent = newCorrelationRule.getContent();\r
 128         String oldContent = oldCorrelationRule.getContent();\r
 129         int newEnabled = newCorrelationRule.getEnabled();\r
 130         int oldEnabled = oldCorrelationRule.getEnabled();\r
 131         String newDes = newCorrelationRule.getDescription();\r
 132         String oldDes = oldCorrelationRule.getDescription();\r
 133         if (newContent.equals(oldContent) && newEnabled == oldEnabled && newDes.equals(oldDes)) {\r
 134             return false;\r
 135         }\r
 136         return true;\r
 137     }\r
 138 \r
 139     public void deleteCorrelationRule(RuleDeleteRequest ruleDeleteRequest)\r
 140             throws CorrelationException {\r
 141         if (ruleDeleteRequest == null) {\r
 142             throw new CorrelationException("The request object can not be empty!");\r
 143         }\r
 144         CorrelationRule correlationRule = correlationRuleDao.queryRuleByRid(ruleDeleteRequest.getRuleId());\r
 145         if (correlationRule == null) {\r
 146             log.warn("the rule:rule id=" + ruleDeleteRequest.getRuleId() + " does not exist the database.");\r
 147             throw new CorrelationException("You're trying to delete a rule which does not exist in the system.");\r
 148         }\r
 149         if (correlationRule.getEnabled() == RuleMgtConstant.STATUS_RULE_OPEN) {\r
 150             engineWarpper.deleteRuleFromEngine(correlationRule.getPackageName());\r
 151         }\r
 152         correlationRuleDao.deleteRule(correlationRule);\r
 153     }\r
 154 \r
 155     private CorrelationRule convertCreateRequest2Rule(String userName,\r
 156             RuleCreateRequest ruleCreateRequest) throws CorrelationException {\r
 157         String tempContent = ruleCreateRequest.getContent();\r
 158         CorrelationRule correlationRule = new CorrelationRule();\r
 159         String ruleId = "rule_" + System.currentTimeMillis();\r
 160         String description = ruleCreateRequest.getDescription() == null ? "" : ruleCreateRequest.getDescription();\r
 161         correlationRule.setRid(ruleId);\r
 162         if (tempContent != null) {\r
 163             correlationRule.setContent(tempContent.trim());\r
 164         }\r
 165         correlationRule.setDescription(description);\r
 166         correlationRule.setCreateTime(new Date());\r
 167         correlationRule.setUpdateTime(new Date());\r
 168         correlationRule.setName(ruleCreateRequest.getRuleName());\r
 169         correlationRule.setEngineID("correlation-d");\r
 170         correlationRule.setEngineType("");\r
 171         correlationRule.setTemplateID(0);\r
 172         correlationRule.setVendor("");\r
 173         correlationRule.setCreator(userName);\r
 174         correlationRule.setModifier(userName);\r
 175         correlationRule.setEnabled(ruleCreateRequest.getEnabled());\r
 176         return correlationRule;\r
 177     }\r
 178 \r
 179     private CorrelationRule convertRuleUpdateRequest2CorrelationRule(String modifier,\r
 180             RuleUpdateRequest ruleUpdateRequest, String ruleName) throws CorrelationException {\r
 181         CorrelationRule correlationRule = new CorrelationRule();\r
 182         String description = ruleUpdateRequest.getDescription() == null ? "" : ruleUpdateRequest.getDescription();\r
 183         correlationRule.setRid(ruleUpdateRequest.getRuleId());\r
 184         correlationRule.setContent(ruleUpdateRequest.getContent());\r
 185         correlationRule.setDescription(description);\r
 186         correlationRule.setEnabled(ruleUpdateRequest.getEnabled());\r
 187         correlationRule.setUpdateTime(new Date());\r
 188         correlationRule.setModifier(modifier);\r
 189         correlationRule.setName(ruleName);\r
 190         return correlationRule;\r
 191     }\r
 192 \r
 193     private String deployRule2Engine(CorrelationRule correlationRule)\r
 194             throws CorrelationException {\r
 195         if (engineWarpper.checkRuleFromEngine(correlationRules2CheckRule(correlationRule)) && (\r
 196                 correlationRule.getEnabled() == RuleMgtConstant.STATUS_RULE_OPEN)) {\r
 197             return engineWarpper.deployEngine(correlationRules2DeployRule(correlationRule));\r
 198         }\r
 199         return "";\r
 200     }\r
 201 \r
 202     public RuleQueryListResponse getCorrelationRuleByCondition(\r
 203             RuleQueryCondition ruleQueryCondition) throws CorrelationException {\r
 204         List<CorrelationRule> correlationRule = correlationRuleQueryDao\r
 205                 .getCorrelationRulesByCondition(ruleQueryCondition);\r
 206         RuleQueryListResponse ruleQueryListResponse = new RuleQueryListResponse();\r
 207         ruleQueryListResponse.setTotalCount(correlationRule.size());\r
 208         ruleQueryListResponse\r
 209                 .setCorrelationRules(correlationRules2RuleResult4APIs(correlationRule));\r
 210         return ruleQueryListResponse;\r
 211     }\r
 212 \r
 213     private List<RuleResult4API> correlationRules2RuleResult4APIs(\r
 214             List<CorrelationRule> correlationRules) {\r
 215         List<RuleResult4API> ruleResult4APIs = new ArrayList<RuleResult4API>();\r
 216         for (CorrelationRule correlationRule : correlationRules) {\r
 217             RuleResult4API ruleResult4API = new RuleResult4API();\r
 218             String description = correlationRule.getDescription() == null ? "" : correlationRule.getDescription();\r
 219             ruleResult4API.setRuleId(correlationRule.getRid());\r
 220             ruleResult4API.setRuleName(correlationRule.getName());\r
 221             ruleResult4API.setDescription(description);\r
 222             ruleResult4API.setContent(correlationRule.getContent());\r
 223             ruleResult4API.setCreateTime(correlationRule.getCreateTime());\r
 224             ruleResult4API.setCreator(correlationRule.getCreator());\r
 225             ruleResult4API.setUpdateTime(correlationRule.getUpdateTime());\r
 226             ruleResult4API.setModifier(correlationRule.getModifier());\r
 227             ruleResult4API.setEnabled(correlationRule.getEnabled());\r
 228             ruleResult4APIs.add(ruleResult4API);\r
 229         }\r
 230         return ruleResult4APIs;\r
 231     }\r
 232 \r
 233     private CorrelationDeployRule4Engine correlationRules2DeployRule(\r
 234             CorrelationRule correlationRule) {\r
 235         CorrelationDeployRule4Engine correlationDeployRule4Engine = new CorrelationDeployRule4Engine();\r
 236         correlationDeployRule4Engine.setContent(correlationRule.getContent());\r
 237         correlationDeployRule4Engine.setEngineId(correlationRule.getEngineID());\r
 238         return correlationDeployRule4Engine;\r
 239     }\r
 240 \r
 241     private CorrelationCheckRule4Engine correlationRules2CheckRule(\r
 242             CorrelationRule correlationRule) {\r
 243         CorrelationCheckRule4Engine correlationCheckRule4Engine = new CorrelationCheckRule4Engine();\r
 244         correlationCheckRule4Engine.setContent(correlationRule.getContent());\r
 245         return correlationCheckRule4Engine;\r
 246     }\r
 247 }\r