holmes-actions/src/main/java/org/onap/holmes/common/dmaap/DmaapService.java

   1 /*
   2  * Copyright 2017 ZTE Corporation.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.onap.holmes.common.dmaap;
  17
  18 import java.util.Map.Entry;
  19 import java.util.Optional;
  20 import java.util.UUID;
  21 import java.util.concurrent.ConcurrentHashMap;
  22 import javax.inject.Inject;
  23 import lombok.extern.slf4j.Slf4j;
  24 import org.jvnet.hk2.annotations.Service;
  25 import org.onap.holmes.common.aai.AaiQuery;
  26 import org.onap.holmes.common.aai.entity.RelationshipList.Relationship;
  27 import org.onap.holmes.common.aai.entity.VmEntity;
  28 import org.onap.holmes.common.aai.entity.VnfEntity;
  29 import org.onap.holmes.common.api.stat.VesAlarm;
  30 import org.onap.holmes.common.dcae.DcaeConfigurationsCache;
  31 import org.onap.holmes.common.dmaap.entity.PolicyMsg;
  32 import org.onap.holmes.common.dmaap.entity.PolicyMsg.EVENT_STATUS;
  33 import org.onap.holmes.common.exception.CorrelationException;
  34 import org.onap.holmes.common.utils.GsonUtil;
  35
  36 @Slf4j
  37 @Service
  38 public class DmaapService {
  39
  40     @Inject
  41     private AaiQuery aaiQuery;
  42     public static final ConcurrentHashMap<String, String> loopControlNames = new ConcurrentHashMap<>();
  43     public static final ConcurrentHashMap<String, String> alarmUniqueRequestID = new ConcurrentHashMap<>();
  44
  45     public void publishPolicyMsg(PolicyMsg policyMsg, String dmaapConfigKey) {
  46         try {
  47             Publisher publisher = new Publisher();
  48             publisher.setUrl(DcaeConfigurationsCache.getPubSecInfo(dmaapConfigKey).getDmaapInfo()
  49                     .getTopicUrl());
  50             publisher.publish(policyMsg);
  51             deleteRequestId(policyMsg);
  52             log.info("send policyMsg: " + GsonUtil.beanToJson(policyMsg));
  53         } catch (CorrelationException e) {
  54             log.error("Failed to publish the control loop event to DMaaP", e);
  55         } catch (NullPointerException e) {
  56             log.error("DMaaP configurations do not exist!");
  57         }
  58     }
  59
  60     public PolicyMsg getPolicyMsg(VesAlarm rootAlarm, VesAlarm childAlarm, String packgeName) {
  61         return Optional.ofNullable(getVmEntity(rootAlarm.getSourceId(), rootAlarm.getSourceName()))
  62                 .map(vmEntity -> getEnrichedPolicyMsg(vmEntity, rootAlarm, childAlarm, packgeName))
  63                 .orElse(getDefaultPolicyMsg(rootAlarm, packgeName));
  64     }
  65
  66     private PolicyMsg getEnrichedPolicyMsg(VmEntity vmEntity, VesAlarm rootAlarm, VesAlarm childAlarm,
  67             String packageName) {
  68         PolicyMsg policyMsg = new PolicyMsg();
  69         policyMsg.setRequestID(getUniqueRequestId(rootAlarm));
  70         if (rootAlarm.getAlarmIsCleared() == PolicyMassgeConstant.POLICY_MESSAGE_ONSET) {
  71             enrichVnfInfo(vmEntity, childAlarm, policyMsg);
  72             policyMsg.setClosedLoopEventStatus(EVENT_STATUS.ONSET);
  73             try {
  74                 policyMsg.getAai().put("vserver.in-maint", Boolean.valueOf(vmEntity.getInMaint()).booleanValue());
  75             } catch (Exception e) {
  76                 log.error("Failed to parse the field \"in-maint\". A boolean string (\"true\"/\"false\")"
  77                         + " is expected but the actual value is " + vmEntity.getInMaint() + ".", e);
  78             }
  79             try {
  80                 policyMsg.getAai().put("vserver.is-closed-loop-disabled",
  81                         Boolean.valueOf(vmEntity.getClosedLoopDisable()).booleanValue());
  82             } catch (Exception e) {
  83                 log.error("Failed to parse the field \"is-closed-loop-disabled\". A boolean string (\"true\"/\"false\")"
  84                         + " is expected but the actual value is " + vmEntity.getClosedLoopDisable() + ".", e);
  85             }
  86             policyMsg.getAai().put("vserver.prov-status", vmEntity.getProvStatus());
  87             policyMsg.getAai().put("vserver.resource-version", vmEntity.getResourceVersion());
  88         } else {
  89             policyMsg.setClosedLoopAlarmEnd(rootAlarm.getLastEpochMicrosec());
  90             policyMsg.setClosedLoopEventStatus(EVENT_STATUS.ABATED);
  91         }
  92         policyMsg.setClosedLoopControlName(loopControlNames.get(packageName));
  93         policyMsg.setClosedLoopAlarmStart(rootAlarm.getStartEpochMicrosec());
  94         policyMsg.getAai().put("vserver.vserver-id", vmEntity.getVserverId());
  95         policyMsg.getAai().put("vserver.vserver-name", vmEntity.getVserverName());
  96         policyMsg.getAai().put("vserver.vserver-name2", vmEntity.getVserverName2());
  97         policyMsg.getAai().put("vserver.vserver-selflink", vmEntity.getVserverSelflink());
  98         policyMsg.setTarget("vserver.vserver-name");
  99         return policyMsg;
 100     }
 101
 102     private PolicyMsg getDefaultPolicyMsg(VesAlarm rootAlarm, String packageName) {
 103         PolicyMsg policyMsg = new PolicyMsg();
 104         policyMsg.setRequestID(getUniqueRequestId(rootAlarm));
 105         policyMsg.setClosedLoopControlName(loopControlNames.get(packageName));
 106         policyMsg.setClosedLoopAlarmStart(rootAlarm.getStartEpochMicrosec());
 107         policyMsg.setTarget("vserver.vserver-name");
 108         policyMsg.setTargetType("VM");
 109         policyMsg.getAai().put("vserver.vserver-name", rootAlarm.getSourceName());
 110         if (rootAlarm.getAlarmIsCleared() == PolicyMassgeConstant.POLICY_MESSAGE_ABATED) {
 111             policyMsg.setClosedLoopAlarmEnd(rootAlarm.getLastEpochMicrosec());
 112             policyMsg.setClosedLoopEventStatus(EVENT_STATUS.ABATED);
 113         }
 114         return policyMsg;
 115     }
 116
 117     private String getUniqueRequestId(VesAlarm rootAlarm) {
 118         String alarmUniqueKey = "";
 119         if (rootAlarm.getAlarmIsCleared() == PolicyMassgeConstant.POLICY_MESSAGE_ABATED) {
 120             alarmUniqueKey =
 121                     rootAlarm.getSourceId() + ":" + rootAlarm.getEventName().replace("Cleared", "");
 122         } else {
 123             alarmUniqueKey = rootAlarm.getSourceId() + ":" + rootAlarm.getEventName();
 124         }
 125         if (alarmUniqueRequestID.containsKey(alarmUniqueKey)) {
 126             return alarmUniqueRequestID.get(alarmUniqueKey);
 127         } else {
 128             String requestID = UUID.randomUUID().toString();
 129             alarmUniqueRequestID.put(alarmUniqueKey, requestID);
 130             return requestID;
 131         }
 132     }
 133
 134     private void enrichVnfInfo(VmEntity vmEntity, VesAlarm childAlarm, PolicyMsg policyMsg) {
 135         String vnfId = "";
 136         String vnfName = "";
 137         if (null != childAlarm) {
 138             vnfId = childAlarm.getSourceId();
 139             vnfName = childAlarm.getSourceName();
 140         } else {
 141             Relationship relationship = vmEntity.getRelationshipList()
 142                     .getRelationship(PolicyMassgeConstant.GENERIC_VNF);
 143             if (null != relationship) {
 144                 vnfId = relationship.getRelationshipDataValue(PolicyMassgeConstant.GENERIC_VNF_VNF_ID);
 145                 vnfName = relationship.getRelatedToPropertyValue(PolicyMassgeConstant.GENERIC_VNF_VNF_NAME);
 146             }
 147         }
 148         VnfEntity vnfEntity = getVnfEntity(vnfId, vnfName);
 149         String vserverInstatnceId = getVserverInstanceId(vnfEntity);
 150         policyMsg.getAai().put("generic-vnf.vnf-id", vnfId);
 151         policyMsg.getAai().put("generic-vnf.service-instance-id", vserverInstatnceId);
 152     }
 153
 154
 155     private String getVserverInstanceId(VnfEntity vnfEntity) {
 156         String vserverInstanceId = "";
 157         if (vnfEntity != null) {
 158             Relationship relationship = vnfEntity.getRelationshipList()
 159                     .getRelationship(PolicyMassgeConstant.SERVICE_INSTANCE);
 160             if (relationship == null) {
 161                 return vserverInstanceId;
 162             }
 163             vserverInstanceId = relationship
 164                     .getRelationshipDataValue(PolicyMassgeConstant.SERVICE_INSTANCE_ID);
 165         }
 166         return vserverInstanceId;
 167     }
 168
 169     private VnfEntity getVnfEntity(String vnfId, String vnfName) {
 170         VnfEntity vnfEntity = null;
 171         try {
 172             vnfEntity = aaiQuery.getAaiVnfData(vnfId, vnfName);
 173         } catch (CorrelationException e) {
 174             log.error("Failed to get the VNF data.", e);
 175         }
 176         return vnfEntity;
 177     }
 178
 179     private VmEntity getVmEntity(String sourceId, String sourceName) {
 180         VmEntity vmEntity = null;
 181         try {
 182             vmEntity = aaiQuery.getAaiVmData(sourceId, sourceName);
 183         } catch (CorrelationException e) {
 184             log.error("Failed to get the VM data.", e);
 185         }
 186         return vmEntity;
 187     }
 188
 189     private void deleteRequestId(PolicyMsg policyMsg){
 190         EVENT_STATUS status = policyMsg.getClosedLoopEventStatus();
 191         if(EVENT_STATUS.ABATED.equals(status)) {
 192             String requestId = policyMsg.getRequestID();
 193             for(Entry<String, String> kv: alarmUniqueRequestID.entrySet()) {
 194                 if(kv.getValue().equals(requestId)) {
 195                     alarmUniqueRequestID.remove(kv.getKey());
 196                     break;
 197                 }
 198             }
 199             log.info("Clear alarm, requestId deleted successful");
 200         }
 201     }
 202 }