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             policyMsg.getAai().put("vserver.in-maint", vmEntity.getInMaint());
  74             policyMsg.getAai().put("vserver.is-closed-loop-disabled",
  75                         vmEntity.getClosedLoopDisable());
  76             policyMsg.getAai().put("vserver.prov-status", vmEntity.getProvStatus());
  77             policyMsg.getAai().put("vserver.resource-version", vmEntity.getResourceVersion());
  78         } else {
  79             policyMsg.setClosedLoopAlarmEnd(rootAlarm.getLastEpochMicrosec());
  80             policyMsg.setClosedLoopEventStatus(EVENT_STATUS.ABATED);
  81         }
  82         policyMsg.setClosedLoopControlName(loopControlNames.get(packageName));
  83         policyMsg.setClosedLoopAlarmStart(rootAlarm.getStartEpochMicrosec());
  84         policyMsg.getAai().put("vserver.vserver-id", vmEntity.getVserverId());
  85         policyMsg.getAai().put("vserver.vserver-name", vmEntity.getVserverName());
  86         policyMsg.getAai().put("vserver.vserver-name2", vmEntity.getVserverName2());
  87         policyMsg.getAai().put("vserver.vserver-selflink", vmEntity.getVserverSelflink());
  88         policyMsg.setTarget("vserver.vserver-name");
  89         return policyMsg;
  90     }
  91
  92     private PolicyMsg getDefaultPolicyMsg(VesAlarm rootAlarm, String packageName) {
  93         PolicyMsg policyMsg = new PolicyMsg();
  94         policyMsg.setRequestID(getUniqueRequestId(rootAlarm));
  95         policyMsg.setClosedLoopControlName(loopControlNames.get(packageName));
  96         policyMsg.setClosedLoopAlarmStart(rootAlarm.getStartEpochMicrosec());
  97         policyMsg.setTarget("vserver.vserver-name");
  98         policyMsg.setTargetType("VM");
  99         policyMsg.getAai().put("vserver.vserver-name", rootAlarm.getSourceName());
 100         if (rootAlarm.getAlarmIsCleared() == PolicyMassgeConstant.POLICY_MESSAGE_ABATED) {
 101             policyMsg.setClosedLoopAlarmEnd(rootAlarm.getLastEpochMicrosec());
 102             policyMsg.setClosedLoopEventStatus(EVENT_STATUS.ABATED);
 103         }
 104         return policyMsg;
 105     }
 106
 107     private String getUniqueRequestId(VesAlarm rootAlarm) {
 108         String alarmUniqueKey = "";
 109         if (rootAlarm.getAlarmIsCleared() == PolicyMassgeConstant.POLICY_MESSAGE_ABATED) {
 110             alarmUniqueKey =
 111                     rootAlarm.getSourceId() + ":" + rootAlarm.getEventName().replace("Cleared", "");
 112         } else {
 113             alarmUniqueKey = rootAlarm.getSourceId() + ":" + rootAlarm.getEventName();
 114         }
 115         if (alarmUniqueRequestID.containsKey(alarmUniqueKey)) {
 116             return alarmUniqueRequestID.get(alarmUniqueKey);
 117         } else {
 118             String requestID = UUID.randomUUID().toString();
 119             alarmUniqueRequestID.put(alarmUniqueKey, requestID);
 120             return requestID;
 121         }
 122     }
 123
 124     private void enrichVnfInfo(VmEntity vmEntity, VesAlarm childAlarm, PolicyMsg policyMsg) {
 125         String vnfId = "";
 126         String vnfName = "";
 127         if (null != childAlarm) {
 128             vnfId = childAlarm.getSourceId();
 129             vnfName = childAlarm.getSourceName();
 130         } else {
 131             Relationship relationship = vmEntity.getRelationshipList()
 132                     .getRelationship(PolicyMassgeConstant.GENERIC_VNF);
 133             if (null != relationship) {
 134                 vnfId = relationship.getRelationshipDataValue(PolicyMassgeConstant.GENERIC_VNF_VNF_ID);
 135                 vnfName = relationship.getRelatedToPropertyValue(PolicyMassgeConstant.GENERIC_VNF_VNF_NAME);
 136             }
 137         }
 138         VnfEntity vnfEntity = getVnfEntity(vnfId, vnfName);
 139         String vserverInstatnceId = getVserverInstanceId(vnfEntity);
 140         policyMsg.getAai().put("generic-vnf.vnf-id", vnfId);
 141         policyMsg.getAai().put("generic-vnf.service-instance-id", vserverInstatnceId);
 142     }
 143
 144
 145     private String getVserverInstanceId(VnfEntity vnfEntity) {
 146         String vserverInstanceId = "";
 147         if (vnfEntity != null) {
 148             Relationship relationship = vnfEntity.getRelationshipList()
 149                     .getRelationship(PolicyMassgeConstant.SERVICE_INSTANCE);
 150             if (relationship == null) {
 151                 return vserverInstanceId;
 152             }
 153             vserverInstanceId = relationship
 154                     .getRelationshipDataValue(PolicyMassgeConstant.SERVICE_INSTANCE_ID);
 155         }
 156         return vserverInstanceId;
 157     }
 158
 159     private VnfEntity getVnfEntity(String vnfId, String vnfName) {
 160         VnfEntity vnfEntity = null;
 161         try {
 162             vnfEntity = aaiQuery.getAaiVnfData(vnfId, vnfName);
 163         } catch (CorrelationException e) {
 164             log.error("Failed to get the VNF data.", e);
 165         }
 166         return vnfEntity;
 167     }
 168
 169     private VmEntity getVmEntity(String sourceId, String sourceName) {
 170         VmEntity vmEntity = null;
 171         try {
 172             vmEntity = aaiQuery.getAaiVmData(sourceId, sourceName);
 173         } catch (CorrelationException e) {
 174             log.error("Failed to get the VM data.", e);
 175         }
 176         return vmEntity;
 177     }
 178
 179     private void deleteRequestId(PolicyMsg policyMsg){
 180         EVENT_STATUS status = policyMsg.getClosedLoopEventStatus();
 181         if(EVENT_STATUS.ABATED.equals(status)) {
 182             String requestId = policyMsg.getRequestID();
 183             for(Entry<String, String> kv: alarmUniqueRequestID.entrySet()) {
 184                 if(kv.getValue().equals(requestId)) {
 185                     alarmUniqueRequestID.remove(kv.getKey());
 186                     break;
 187                 }
 188             }
 189             log.info("An alarm is cleared and the corresponding requestId is deleted successfully");
 190         }
 191     }
 192 }