ves-agent/src/main/java/org/commscope/tr069adapter/vesagent/controller/AlarmMappingHandler.java

   1 /*\r
   2  * ============LICENSE_START========================================================================\r
   3  * ONAP : tr-069-adapter\r
   4  * =================================================================================================\r
   5  * Copyright (C) 2020 CommScope Inc Intellectual Property.\r
   6  * =================================================================================================\r
   7  * This tr-069-adapter software file is distributed by CommScope Inc under the Apache License,\r
   8  * Version 2.0 (the "License"); you may not use this file except in compliance with the License. You\r
   9  * may obtain a copy of the License at\r
  10  *\r
  11  * http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,\r
  14  * either express or implied. See the License for the specific language governing permissions and\r
  15  * limitations under the License.\r
  16  * ===============LICENSE_END=======================================================================\r
  17  */\r
  18 package org.commscope.tr069adapter.vesagent.controller;\r
  19 \r
  20 import com.fasterxml.jackson.core.JsonProcessingException;\r
  21 import com.fasterxml.jackson.databind.ObjectMapper;\r
  22 \r
  23 import java.text.SimpleDateFormat;\r
  24 import java.util.ArrayList;\r
  25 import java.util.Date;\r
  26 import java.util.HashMap;\r
  27 import java.util.Iterator;\r
  28 import java.util.List;\r
  29 import java.util.Map;\r
  30 \r
  31 import org.commscope.tr069adapter.acs.common.DeviceInform;\r
  32 import org.commscope.tr069adapter.acs.common.ParameterDTO;\r
  33 import org.commscope.tr069adapter.mapper.model.VESNotification;\r
  34 import org.commscope.tr069adapter.mapper.model.VESNotificationResponse;\r
  35 import org.commscope.tr069adapter.vesagent.VesConfiguration;\r
  36 import org.commscope.tr069adapter.vesagent.exception.InvalidFaultOperationException;\r
  37 import org.commscope.tr069adapter.vesagent.fault.AlarmFrameWorkSeverityEnum;\r
  38 import org.commscope.tr069adapter.vesagent.fault.ExpeditedEvent;\r
  39 import org.commscope.tr069adapter.vesagent.fault.Parser;\r
  40 import org.commscope.tr069adapter.vesagent.http.HttpRequestSender;\r
  41 import org.commscope.tr069adapter.vesagent.model.CommonEventHeader;\r
  42 import org.commscope.tr069adapter.vesagent.model.Event;\r
  43 import org.commscope.tr069adapter.vesagent.model.EventMessage;\r
  44 import org.commscope.tr069adapter.vesagent.model.FaultFields;\r
  45 import org.commscope.tr069adapter.vesagent.util.EventUtil;\r
  46 import org.slf4j.Logger;\r
  47 import org.slf4j.LoggerFactory;\r
  48 import org.springframework.beans.factory.annotation.Autowired;\r
  49 import org.springframework.http.HttpStatus;\r
  50 import org.springframework.stereotype.Component;\r
  51 \r
  52 @Component\r
  53 public class AlarmMappingHandler {\r
  54 \r
  55   private static final Logger logger = LoggerFactory.getLogger(AlarmMappingHandler.class);\r
  56 \r
  57   @Autowired\r
  58   VesConfiguration config;\r
  59 \r
  60   @Autowired\r
  61   HttpRequestSender sender;\r
  62 \r
  63   public VESNotificationResponse handleAlarmNotification(VESNotification notification)\r
  64       throws InvalidFaultOperationException, JsonProcessingException {\r
  65     List<Event> events = convertNotificationToVESEvent(notification.getDevnotification(),\r
  66         notification.geteNodeBName());\r
  67 \r
  68     for (Iterator<Event> iterator = events.iterator(); iterator.hasNext();) {\r
  69       Event event = iterator.next();\r
  70       EventMessage evMsg = new EventMessage();\r
  71       evMsg.setEvent(event);\r
  72 \r
  73       ObjectMapper mapper = new ObjectMapper();\r
  74 \r
  75       String requestBody = mapper.writeValueAsString(evMsg);\r
  76       if (requestBody.isEmpty()) {\r
  77         logger.debug("Alarm Event body is empty");\r
  78       }\r
  79 \r
  80       String url = config.getFaultVesUrl();\r
  81       VESNotificationResponse response = sender.postRequest(url, requestBody);\r
  82       if (response.getStatusCode() == HttpStatus.INTERNAL_SERVER_ERROR.value()) {\r
  83         logger.debug(\r
  84             "Error received while posting alarms; skiiping this alarm in the fault event and continue for remaining");\r
  85       }\r
  86     }\r
  87 \r
  88     return new VESNotificationResponse(HttpStatus.ACCEPTED.value(), "No Alarms in the request");\r
  89   }\r
  90 \r
  91   List<Event> convertNotificationToVESEvent(DeviceInform notification, String eNodeBName)\r
  92       throws InvalidFaultOperationException {\r
  93     logger.debug("Converting Notification to VES fault event started");\r
  94     ArrayList<Event> mlist = new ArrayList<>();\r
  95 \r
  96     List<ParameterDTO> parameter = notification.getParameters();\r
  97     Map<String, ExpeditedEvent> hmAlarmParameters = null;\r
  98     Parser parser = new Parser();\r
  99     hmAlarmParameters = parser.parseFaultParams(parameter);\r
 100 \r
 101     for (Iterator<String> iterator = hmAlarmParameters.keySet().iterator(); iterator.hasNext();) {\r
 102       ExpeditedEvent event = hmAlarmParameters.get(iterator.next());\r
 103 \r
 104       if (event.getAdditionalInformation() != null\r
 105           && event.getAdditionalInformation().contains("-")) {\r
 106         String eNBName = event.getAdditionalInformation().split("-")[0].trim();\r
 107         eNodeBName = eNBName;\r
 108       }\r
 109 \r
 110       Event faultEvent = new Event();\r
 111       CommonEventHeader eventHeader = new CommonEventHeader();\r
 112       eventHeader.setDomain("fault");\r
 113       eventHeader.setEventId(event.getAlarmIdentifier());\r
 114       eventHeader.setEventName("Fault_" + notification.getDeviceDetails().getProductClass() + "-"\r
 115           + config.getVendorName() + "_" + event.getProbableCause().replace(" ", ""));\r
 116       eventHeader.setEventType(config.getFaultEventType());\r
 117       eventHeader.setLastEpochMicrosec(System.currentTimeMillis());\r
 118       eventHeader.setTimeZoneOffset(extractTimeZoneOffSet(event.getAdditionalInformation()));\r
 119       eventHeader.setPriority(extractPriority(event.getPerceivedSeverity()));\r
 120 \r
 121       EventUtil.populateEnodeBName(eventHeader, notification, eNodeBName);\r
 122 \r
 123       eventHeader.setSequence(1);\r
 124       eventHeader.setStartEpochMicrosec(System.currentTimeMillis()*1000);\r
 125       eventHeader.setVersion(config.getEventVersion());\r
 126       if (eNodeBName != null && eNodeBName.length() > 3)\r
 127         eventHeader.setNfNamingCode(eNodeBName.substring(0, 3));\r
 128       else\r
 129         eventHeader.setNfNamingCode("");\r
 130       eventHeader.setNfcNamingCode("");\r
 131       eventHeader.setNfVendorName(config.getVendorName());\r
 132       eventHeader.setVesEventListenerVersion(config.getVesVersion());\r
 133       faultEvent.setCommonEventHeader(eventHeader);\r
 134 \r
 135       FaultFields faultfields = new FaultFields();\r
 136       faultfields.setAlarmCondition(event.getProbableCause().replace(" ", ""));\r
 137 \r
 138       faultfields.setEventSeverity(event.getPerceivedSeverity().toString());\r
 139       if (event.getPerceivedSeverity() == AlarmFrameWorkSeverityEnum.CLEAR\r
 140           || event.getPerceivedSeverity() == AlarmFrameWorkSeverityEnum.CLEARED) {\r
 141         faultfields.setEventSeverity("NORMAL");\r
 142       }\r
 143 \r
 144       faultfields.setEventSourceType(config.getFaultEventSourcePrefix() + "_"\r
 145           + notification.getDeviceDetails().getProductClass());\r
 146       faultfields.setFaultFieldsVersion(config.getFaultFeildVersion());\r
 147       faultfields.setSpecificProblem(event.getSpecificProblem());\r
 148       faultfields.setVfStatus("Active");\r
 149       faultfields.setEventCategory(event.getEventType());\r
 150       faultfields.setAlarmInterfaceA(event.getManagedObjectInstance());\r
 151       Map<String, String> addition = new HashMap<>();\r
 152       addition.put("eventTime",\r
 153           new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.s'Z'").format(new Date()));\r
 154       addition.put("AdditionalText", event.getAdditionalText());\r
 155       addition.put("AdditionalInformation", event.getAdditionalInformation());\r
 156       faultfields.setAlarmAdditionalInformation(addition);\r
 157 \r
 158       faultEvent.setFaultFields(faultfields);\r
 159       mlist.add(faultEvent);\r
 160 \r
 161     }\r
 162     logger.debug("Converting Notification to VES fault event completed :{}", mlist);\r
 163     return mlist;\r
 164   }\r
 165 \r
 166   private String extractTimeZoneOffSet(String additionalInformation) {\r
 167     String[] additionalInfoArray = null;\r
 168     String[] timeZoneOffset = null;\r
 169     String timeOffset = "UTC+00.00";\r
 170 \r
 171     if (additionalInformation != null && additionalInformation.contains("|")) {\r
 172       additionalInfoArray = additionalInformation.split("\\|");\r
 173 \r
 174       int index = -1;\r
 175       for (int i = 0; i < additionalInfoArray.length; i++) {\r
 176         if (additionalInfoArray[i].contains("TZD=")) {\r
 177           index = i;\r
 178         }\r
 179       }\r
 180       if (index >= 0) {\r
 181         timeZoneOffset = additionalInfoArray[index].split("=");\r
 182         timeOffset = timeZoneOffset[timeZoneOffset.length - 1];\r
 183       }\r
 184     } else if (additionalInformation != null && additionalInformation.contains("TZD=")) {\r
 185       timeZoneOffset = additionalInformation.split("=");\r
 186       timeOffset = timeZoneOffset[timeZoneOffset.length - 1];\r
 187     }\r
 188 \r
 189     return timeOffset;\r
 190   }\r
 191 \r
 192   private String extractPriority(AlarmFrameWorkSeverityEnum severity) {\r
 193     String priority;\r
 194     if (severity == AlarmFrameWorkSeverityEnum.CRITICAL\r
 195         || severity == AlarmFrameWorkSeverityEnum.MAJOR) {\r
 196       priority = "High";\r
 197     } else if (severity == AlarmFrameWorkSeverityEnum.MINOR) {\r
 198       priority = "Medium";\r
 199     } else {\r
 200       priority = "Low";\r
 201     }\r
 202 \r
 203     return priority;\r
 204   }\r
 205 }\r