src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java

   1 /*-\r
   2  * ============LICENSE_START=======================================================\r
   3  * ONAP CLAMP\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights\r
   6  *                             reserved.\r
   7  * ================================================================================\r
   8  * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * you may not use this file except in compliance with the License.\r
  10  * You may obtain a copy of the License at\r
  11  *\r
  12  * http://www.apache.org/licenses/LICENSE-2.0\r
  13  *\r
  14  * Unless required by applicable law or agreed to in writing, software\r
  15  * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * See the License for the specific language governing permissions and\r
  18  * limitations under the License.\r
  19  * ============LICENSE_END============================================\r
  20  * ===================================================================\r
  21  * \r
  22  */\r
  23 \r
  24 package org.onap.clamp.clds.client;\r
  25 \r
  26 import com.att.eelf.configuration.EELFLogger;\r
  27 import com.att.eelf.configuration.EELFManager;\r
  28 import com.fasterxml.jackson.core.JsonProcessingException;\r
  29 import com.fasterxml.jackson.databind.node.ObjectNode;\r
  30 \r
  31 import java.io.IOException;\r
  32 import java.util.Date;\r
  33 import java.util.List;\r
  34 \r
  35 import javax.ws.rs.BadRequestException;\r
  36 \r
  37 import org.json.simple.JSONArray;\r
  38 import org.json.simple.JSONObject;\r
  39 import org.json.simple.parser.JSONParser;\r
  40 import org.json.simple.parser.ParseException;\r
  41 import org.onap.clamp.clds.config.ClampProperties;\r
  42 import org.onap.clamp.clds.dao.CldsDao;\r
  43 import org.onap.clamp.clds.model.CldsEvent;\r
  44 import org.onap.clamp.clds.model.CldsModel;\r
  45 import org.onap.clamp.clds.model.DcaeEvent;\r
  46 import org.onap.clamp.clds.model.dcae.DcaeInventoryResponse;\r
  47 import org.onap.clamp.clds.model.properties.Global;\r
  48 import org.onap.clamp.clds.model.properties.ModelProperties;\r
  49 import org.onap.clamp.clds.util.JacksonUtils;\r
  50 import org.onap.clamp.clds.util.LoggingUtils;\r
  51 import org.springframework.beans.factory.annotation.Autowired;\r
  52 import org.springframework.stereotype.Component;\r
  53 \r
  54 /**\r
  55  * This class implements the communication with DCAE for the service inventory.\r
  56  */\r
  57 @Component\r
  58 public class DcaeInventoryServices {\r
  59 \r
  60     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(DcaeInventoryServices.class);\r
  61     protected static final EELFLogger auditLogger = EELFManager.getInstance().getAuditLogger();\r
  62     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();\r
  63     public static final String DCAE_INVENTORY_URL = "dcae.inventory.url";\r
  64     public static final String DCAE_INVENTORY_RETRY_INTERVAL = "dcae.intentory.retry.interval";\r
  65     public static final String DCAE_INVENTORY_RETRY_LIMIT = "dcae.intentory.retry.limit";\r
  66     public static final String DCAE_TYPE_NAME = "typeName";\r
  67     public static final String DCAE_TYPE_ID = "typeId";\r
  68     @Autowired\r
  69     private ClampProperties refProp;\r
  70     @Autowired\r
  71     private CldsDao cldsDao;\r
  72 \r
  73     /**\r
  74      * Set the event inventory.\r
  75      * \r
  76      * @param cldsModel\r
  77      *            The CldsModel\r
  78      * @param userId\r
  79      *            The user ID\r
  80      * @throws ParseException\r
  81      *             In case of DCAE Json parse exception\r
  82      */\r
  83     public void setEventInventory(CldsModel cldsModel, String userId) throws ParseException, InterruptedException {\r
  84         String artifactName = cldsModel.getControlName();\r
  85         DcaeEvent dcaeEvent = new DcaeEvent();\r
  86         DcaeInventoryResponse dcaeResponse = null;\r
  87         Date startTime = new Date();\r
  88         LoggingUtils.setTargetContext("DCAE", "setEventInventory");\r
  89         if (artifactName != null) {\r
  90             artifactName = artifactName + ".yml";\r
  91         }\r
  92         try {\r
  93             // Below are the properties required for calling the dcae inventory\r
  94             ModelProperties prop = new ModelProperties(cldsModel.getName(), cldsModel.getControlName(), null, false,\r
  95                     "{}", cldsModel.getPropText());\r
  96             Global global = prop.getGlobal();\r
  97             String invariantServiceUuid = global.getService();\r
  98             List<String> resourceUuidList = global.getResourceVf();\r
  99             String resourceUuid = "";\r
 100             if (resourceUuidList != null && !resourceUuidList.isEmpty()) {\r
 101                 resourceUuid = resourceUuidList.get(0);\r
 102             }\r
 103             /* Inventory service url is called in this method */\r
 104             dcaeResponse = getDcaeInformation(artifactName, invariantServiceUuid, resourceUuid);\r
 105             /* set dcae events */\r
 106             dcaeEvent.setArtifactName(artifactName);\r
 107             dcaeEvent.setEvent(DcaeEvent.EVENT_DISTRIBUTION);\r
 108             LoggingUtils.setResponseContext("0", "Set inventory success", this.getClass().getName());\r
 109         } catch (JsonProcessingException e) {\r
 110             LoggingUtils.setResponseContext("900", "Set inventory failed", this.getClass().getName());\r
 111             LoggingUtils.setErrorContext("900", "Set inventory error");\r
 112             logger.error("Error during JSON decoding", e);\r
 113         } catch (IOException ex) {\r
 114             LoggingUtils.setResponseContext("900", "Set inventory failed", this.getClass().getName());\r
 115             LoggingUtils.setErrorContext("900", "Set inventory error");\r
 116             logger.error("Error during DCAE communication", ex);\r
 117         } finally {\r
 118             LoggingUtils.setTimeContext(startTime, new Date());\r
 119             metricsLogger.info("setEventInventory complete");\r
 120         }\r
 121         this.analyzeAndSaveDcaeResponse(dcaeResponse, cldsModel, dcaeEvent, userId);\r
 122     }\r
 123 \r
 124     private void analyzeAndSaveDcaeResponse(DcaeInventoryResponse dcaeResponse, CldsModel cldsModel,\r
 125             DcaeEvent dcaeEvent, String userId) {\r
 126         if (dcaeResponse != null) {\r
 127             logger.info("Dcae Response for query on inventory: " + dcaeResponse);\r
 128             String oldTypeId = cldsModel.getTypeId();\r
 129             if (dcaeResponse.getTypeId() != null) {\r
 130                 cldsModel.setTypeId(dcaeResponse.getTypeId());\r
 131             }\r
 132             if (dcaeResponse.getTypeName() != null) {\r
 133                 cldsModel.setTypeName(dcaeResponse.getTypeName());\r
 134             }\r
 135             if (oldTypeId == null || !cldsModel.getEvent().getActionCd().equalsIgnoreCase(CldsEvent.ACTION_DISTRIBUTE)\r
 136                     || cldsModel.getEvent().getActionCd().equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE)) {\r
 137                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userId, dcaeEvent.getCldsActionCd(),\r
 138                         CldsEvent.ACTION_STATE_RECEIVED, null);\r
 139             }\r
 140             cldsModel.save(cldsDao, userId);\r
 141         } else {\r
 142             logger.info(cldsModel.getName() + " Model is not present in Dcae Inventory Service.");\r
 143         }\r
 144     }\r
 145 \r
 146     private int getTotalCountFromDcaeInventoryResponse(String responseStr) throws ParseException {\r
 147         JSONParser parser = new JSONParser();\r
 148         Object obj0 = parser.parse(responseStr);\r
 149         JSONObject jsonObj = (JSONObject) obj0;\r
 150         Long totalCount = (Long) jsonObj.get("totalCount");\r
 151         return totalCount.intValue();\r
 152     }\r
 153 \r
 154     private DcaeInventoryResponse getItemsFromDcaeInventoryResponse(String responseStr)\r
 155             throws ParseException, IOException {\r
 156         JSONParser parser = new JSONParser();\r
 157         Object obj0 = parser.parse(responseStr);\r
 158         JSONObject jsonObj = (JSONObject) obj0;\r
 159         JSONArray itemsArray = (JSONArray) jsonObj.get("items");\r
 160         JSONObject dcaeServiceType0 = (JSONObject) itemsArray.get(0);\r
 161         return JacksonUtils.getObjectMapperInstance().readValue(dcaeServiceType0.toString(),\r
 162                 DcaeInventoryResponse.class);\r
 163     }\r
 164 \r
 165     /**\r
 166      * DO a query to DCAE to get some Information.\r
 167      * \r
 168      * @param artifactName\r
 169      *            The artifact Name\r
 170      * @param serviceUuid\r
 171      *            The service UUID\r
 172      * @param resourceUuid\r
 173      *            The resource UUID\r
 174      * @return The DCAE inventory for the artifact in DcaeInventoryResponse\r
 175      * @throws IOException\r
 176      *             In case of issues with the stream\r
 177      * @throws ParseException\r
 178      *             In case of issues with the Json parsing\r
 179      */\r
 180     public DcaeInventoryResponse getDcaeInformation(String artifactName, String serviceUuid, String resourceUuid)\r
 181             throws IOException, ParseException, InterruptedException {\r
 182         Date startTime = new Date();\r
 183         LoggingUtils.setTargetContext("DCAE", "getDcaeInformation");\r
 184         String queryString = "?asdcResourceId=" + resourceUuid + "&asdcServiceId=" + serviceUuid + "&typeName="\r
 185                 + artifactName;\r
 186         String fullUrl = refProp.getStringValue(DCAE_INVENTORY_URL) + "/dcae-service-types" + queryString;\r
 187         logger.info("Dcae Inventory Service full url - " + fullUrl);\r
 188         DcaeInventoryResponse response = queryDcaeInventory(fullUrl);\r
 189         LoggingUtils.setResponseContext("0", "Get Dcae Information success", this.getClass().getName());\r
 190         LoggingUtils.setTimeContext(startTime, new Date());\r
 191         return response;\r
 192     }\r
 193 \r
 194     private DcaeInventoryResponse queryDcaeInventory(String fullUrl)\r
 195             throws IOException, InterruptedException, ParseException {\r
 196         int retryInterval = 0;\r
 197         int retryLimit = 1;\r
 198         if (refProp.getStringValue(DCAE_INVENTORY_RETRY_LIMIT) != null) {\r
 199             retryLimit = Integer.valueOf(refProp.getStringValue(DCAE_INVENTORY_RETRY_LIMIT));\r
 200         }\r
 201         if (refProp.getStringValue(DCAE_INVENTORY_RETRY_INTERVAL) != null) {\r
 202             retryInterval = Integer.valueOf(refProp.getStringValue(DCAE_INVENTORY_RETRY_INTERVAL));\r
 203         }\r
 204         for (int i = 0; i < retryLimit; i++) {\r
 205             metricsLogger.info("Attempt n°" + i + " to contact DCAE inventory");\r
 206             String response = DcaeHttpConnectionManager.doDcaeHttpQuery(fullUrl, "GET", null, null);\r
 207             int totalCount = getTotalCountFromDcaeInventoryResponse(response);\r
 208             metricsLogger.info("getDcaeInformation complete: totalCount returned=" + totalCount);\r
 209             if (totalCount > 0) {\r
 210                 logger.info("getDcaeInformation, answer from DCAE inventory:" + response);\r
 211                 return getItemsFromDcaeInventoryResponse(response);\r
 212             }\r
 213             logger.info(\r
 214                     "Dcae inventory totalCount returned is 0, so waiting " + retryInterval + "ms before retrying ...");\r
 215             // wait for a while and try to connect to DCAE again\r
 216             Thread.sleep(retryInterval);\r
 217         }\r
 218         logger.warn("Dcae inventory totalCount returned is still 0, after " + retryLimit + " attempts, returning NULL");\r
 219         return null;\r
 220     }\r
 221 \r
 222     /**\r
 223      * Inserts a new DCAEServiceType or updates an existing instance. If the\r
 224      * typeName is same second time(already exists) then the\r
 225      * DCAEServiceTypeRequest is updated\r
 226      * \r
 227      * @param blueprintTemplate\r
 228      *            blueprint content\r
 229      * @param owner\r
 230      *            owner of the data\r
 231      * @param typeName\r
 232      *            The type/artifact Name\r
 233      * @param typeVersion\r
 234      *            type version\r
 235      * @param asdcServiceId\r
 236      *            The service UUID\r
 237      * @param asdcResourceId\r
 238      *            The vf UUID\r
 239      * @return The DCAE inventory type id\r
 240      */\r
 241     public String createupdateDCAEServiceType(String blueprintTemplate, String owner, String typeName, int typeVersion,\r
 242             String asdcServiceId, String asdcResourceId) {\r
 243         Date startTime = new Date();\r
 244         LoggingUtils.setTargetContext("DCAE", "createDCAEServiceType");\r
 245         String typeId = null;\r
 246         try {\r
 247             ObjectNode dcaeServiceTypeRequest = JacksonUtils.getObjectMapperInstance().createObjectNode();\r
 248             dcaeServiceTypeRequest.put("blueprintTemplate", blueprintTemplate);\r
 249             dcaeServiceTypeRequest.put("owner", owner);\r
 250             dcaeServiceTypeRequest.put("typeName", typeName);\r
 251             dcaeServiceTypeRequest.put("typeVersion", typeVersion);\r
 252             dcaeServiceTypeRequest.put("asdcServiceId", asdcServiceId);\r
 253             dcaeServiceTypeRequest.put("asdcResourceId", asdcResourceId);\r
 254             String apiBodyString = dcaeServiceTypeRequest.toString();\r
 255             logger.info("Dcae api Body String - " + apiBodyString);\r
 256             String url = refProp.getStringValue(DCAE_INVENTORY_URL) + "/dcae-service-types";\r
 257             String responseStr = DcaeHttpConnectionManager.doDcaeHttpQuery(url, "POST", apiBodyString,\r
 258                     "application/json");\r
 259             // If the DCAEServiceTypeRequest is created successfully it will\r
 260             // return a json object responce containing a node for newly created\r
 261             // "typeId"\r
 262             // The newly generated DCAEServiceTypeRequest can then be accessed\r
 263             // via URL: https://<DCAE_INVENTORY_URL>/dcae-service-types/<typeId>\r
 264             JSONParser parser = new JSONParser();\r
 265             Object obj0 = parser.parse(responseStr);\r
 266             JSONObject jsonObj = (JSONObject) obj0;\r
 267             typeId = (String) jsonObj.get("typeId"); // need to save this\r
 268                                                      // as\r
 269                                                      // service_type_id\r
 270                                                      // in model table\r
 271         } catch (IOException | ParseException e) {\r
 272             logger.error("Exception occurred during createupdateDCAEServiceType Operation with DCAE", e);\r
 273             throw new BadRequestException("Exception occurred during createupdateDCAEServiceType Operation with DCAE",\r
 274                     e);\r
 275         } finally {\r
 276             if (typeId != null) {\r
 277                 LoggingUtils.setResponseContext("0", "Create update DCAE ServiceType success",\r
 278                         this.getClass().getName());\r
 279             } else {\r
 280                 LoggingUtils.setResponseContext("900", "Create update DCAE ServiceType failed",\r
 281                         this.getClass().getName());\r
 282                 LoggingUtils.setErrorContext("900", "Create update DCAE ServiceType error");\r
 283             }\r
 284             LoggingUtils.setTimeContext(startTime, new Date());\r
 285             metricsLogger.info("createupdateDCAEServiceType complete");\r
 286         }\r
 287         return typeId;\r
 288     }\r
 289 \r
 290     /**\r
 291      * Method to delete blueprint from dcae inventory if it's exists.\r
 292      * \r
 293      * @param typeName\r
 294      * @param serviceUuid\r
 295      * @param resourceUuid\r
 296      * @throws InterruptedException\r
 297      */\r
 298     public void deleteDCAEServiceType(String typeName, String serviceUuid, String resourceUuid)\r
 299             throws InterruptedException {\r
 300         Date startTime = new Date();\r
 301         LoggingUtils.setTargetContext("DCAE", "deleteDCAEServiceType");\r
 302         boolean result = false;\r
 303         try {\r
 304             DcaeInventoryResponse inventoryResponse = getDcaeInformation(typeName, serviceUuid, resourceUuid);\r
 305             if (inventoryResponse != null && inventoryResponse.getTypeId() != null) {\r
 306                 String fullUrl = refProp.getStringValue(DCAE_INVENTORY_URL) + "/dcae-service-types/"\r
 307                         + inventoryResponse.getTypeId();\r
 308                 DcaeHttpConnectionManager.doDcaeHttpQuery(fullUrl, "DELETE", null, null);\r
 309             }\r
 310             result = true;\r
 311         } catch (IOException | ParseException e) {\r
 312             logger.error("Exception occurred during deleteDCAEServiceType Operation with DCAE", e);\r
 313             throw new BadRequestException("Exception occurred during deleteDCAEServiceType Operation with DCAE", e);\r
 314         } finally {\r
 315             if (result) {\r
 316                 LoggingUtils.setResponseContext("0", "Delete DCAE ServiceType success", this.getClass().getName());\r
 317             } else {\r
 318                 LoggingUtils.setResponseContext("900", "Delete DCAE ServiceType failed", this.getClass().getName());\r
 319                 LoggingUtils.setErrorContext("900", "Delete DCAE ServiceType error");\r
 320             }\r
 321             LoggingUtils.setTimeContext(startTime, new Date());\r
 322             metricsLogger.info("deleteDCAEServiceType completed");\r
 323         }\r
 324     }\r
 325 }\r