src/main/java/org/onap/clamp/clds/service/CldsService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  * Modifications copyright (c) 2018 Nokia
  21  * ===================================================================
  22  *
  23  */
  24
  25 package org.onap.clamp.clds.service;
  26
  27 import com.att.eelf.configuration.EELFLogger;
  28 import com.att.eelf.configuration.EELFManager;
  29 import com.fasterxml.jackson.databind.JsonNode;
  30 import com.fasterxml.jackson.databind.ObjectMapper;
  31 import com.fasterxml.jackson.databind.node.ObjectNode;
  32
  33 import java.io.IOException;
  34 import java.security.GeneralSecurityException;
  35 import java.util.Date;
  36 import java.util.List;
  37 import java.util.Optional;
  38 import java.util.UUID;
  39
  40 import javax.servlet.http.HttpServletRequest;
  41 import javax.ws.rs.BadRequestException;
  42 import javax.ws.rs.NotAuthorizedException;
  43 import javax.xml.transform.TransformerException;
  44
  45 import org.apache.camel.Produce;
  46 import org.apache.commons.codec.DecoderException;
  47 import org.apache.commons.lang3.StringUtils;
  48 import org.json.simple.parser.ParseException;
  49 import org.onap.clamp.clds.camel.CamelProxy;
  50 import org.onap.clamp.clds.client.DcaeDispatcherServices;
  51 import org.onap.clamp.clds.client.DcaeInventoryServices;
  52 import org.onap.clamp.clds.client.req.sdc.SdcCatalogServices;
  53 import org.onap.clamp.clds.config.ClampProperties;
  54 import org.onap.clamp.clds.dao.CldsDao;
  55 import org.onap.clamp.clds.exception.CldsConfigException;
  56 import org.onap.clamp.clds.exception.policy.PolicyClientException;
  57 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
  58 import org.onap.clamp.clds.model.CldsDbServiceCache;
  59 import org.onap.clamp.clds.model.CldsEvent;
  60 import org.onap.clamp.clds.model.CldsInfo;
  61 import org.onap.clamp.clds.model.CldsModel;
  62 import org.onap.clamp.clds.model.CldsModelProp;
  63 import org.onap.clamp.clds.model.CldsMonitoringDetails;
  64 import org.onap.clamp.clds.model.CldsServiceData;
  65 import org.onap.clamp.clds.model.CldsTemplate;
  66 import org.onap.clamp.clds.model.DcaeEvent;
  67 import org.onap.clamp.clds.model.ValueItem;
  68 import org.onap.clamp.clds.model.properties.AbstractModelElement;
  69 import org.onap.clamp.clds.model.properties.ModelProperties;
  70 import org.onap.clamp.clds.model.sdc.SdcResource;
  71 import org.onap.clamp.clds.model.sdc.SdcServiceDetail;
  72 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
  73 import org.onap.clamp.clds.sdc.controller.installer.CsarInstallerImpl;
  74 import org.onap.clamp.clds.transform.XslTransformer;
  75 import org.onap.clamp.clds.util.JacksonUtils;
  76 import org.onap.clamp.clds.util.LoggingUtils;
  77 import org.onap.clamp.clds.util.ONAPLogConstants;
  78 import org.slf4j.event.Level;
  79 import org.springframework.beans.factory.annotation.Autowired;
  80 import org.springframework.beans.factory.annotation.Value;
  81 import org.springframework.http.HttpStatus;
  82 import org.springframework.http.ResponseEntity;
  83 import org.springframework.stereotype.Component;
  84 import org.springframework.web.client.HttpClientErrorException;
  85
  86 /**
  87  * Service to save and retrieve the CLDS model attributes.
  88  */
  89 @Component
  90 public class CldsService extends SecureServiceBase {
  91
  92     @Produce(uri = "direct:processSubmit")
  93     private CamelProxy camelProxy;
  94     protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
  95     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
  96
  97     public static final String GLOBAL_PROPERTIES_KEY = "files.globalProperties";
  98     private final String cldsPersmissionTypeCl;
  99     private final String cldsPermissionTypeClManage;
 100     private final String cldsPermissionTypeClEvent;
 101     private final String cldsPermissionTypeFilterVf;
 102     private final String cldsPermissionTypeTemplate;
 103     private final String cldsPermissionInstance;
 104     final SecureServicePermission permissionReadCl;
 105     final SecureServicePermission permissionUpdateCl;
 106     final SecureServicePermission permissionReadTemplate;
 107     final SecureServicePermission permissionUpdateTemplate;
 108     final SecureServicePermission permissionReadTosca;
 109     final SecureServicePermission permissionUpdateTosca;
 110
 111     private final CldsDao cldsDao;
 112     private final XslTransformer cldsBpmnTransformer;
 113     private final ClampProperties refProp;
 114     private final SdcCatalogServices sdcCatalogServices;
 115     private final DcaeDispatcherServices dcaeDispatcherServices;
 116     private final DcaeInventoryServices dcaeInventoryServices;
 117     private LoggingUtils util = new LoggingUtils(logger);
 118
 119     @Autowired
 120     private HttpServletRequest request;
 121
 122     @Autowired
 123     public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
 124         SdcCatalogServices sdcCatalogServices, DcaeDispatcherServices dcaeDispatcherServices,
 125         DcaeInventoryServices dcaeInventoryServices,
 126         @Value("${clamp.config.security.permission.type.cl:permission-type-cl}") String cldsPersmissionTypeCl,
 127         @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}") String cldsPermissionTypeClManage,
 128         @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}") String cldsPermissionTypeClEvent,
 129         @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}") String cldsPermissionTypeFilterVf,
 130         @Value("${clamp.config.security.permission.type.template:permission-type-template}") String cldsPermissionTypeTemplate,
 131         @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}") String cldsPermissionTypeTosca,
 132         @Value("${clamp.config.security.permission.instance:dev}") String cldsPermissionInstance) {
 133         this.cldsDao = cldsDao;
 134         this.cldsBpmnTransformer = cldsBpmnTransformer;
 135         this.refProp = refProp;
 136         this.sdcCatalogServices = sdcCatalogServices;
 137         this.dcaeDispatcherServices = dcaeDispatcherServices;
 138         this.dcaeInventoryServices = dcaeInventoryServices;
 139         this.cldsPersmissionTypeCl = cldsPersmissionTypeCl;
 140         this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
 141         this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
 142         this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
 143         this.cldsPermissionTypeTemplate = cldsPermissionTypeTemplate;
 144         this.cldsPermissionInstance = cldsPermissionInstance;
 145         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 146         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 147         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 148             "read");
 149         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 150             "update");
 151         permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
 152         permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
 153             "update");
 154     }
 155
 156     /*
 157      * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
 158      * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
 159      * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
 160      * from the DCAE application when the ClosedLoop is submitted
 161      * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
 162      * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
 163      * used to generate the ClosedLoop model. ACTION_CD | Current state of the
 164      * ClosedLoop in CLDS application.
 165      */
 166     public List<CldsMonitoringDetails> getCLDSDetails() {
 167         util.entering(request, "CldsService: GET model details");
 168         Date startTime = new Date();
 169         List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCLDSMonitoringDetails();
 170         // audit log
 171         LoggingUtils.setTimeContext(startTime, new Date());
 172         auditLogger.info("GET cldsDetails completed");
 173         util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 174         return cldsMonitoringDetailsList;
 175     }
 176
 177     /*
 178      * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
 179      * is currently installed from pom.xml file 3. User permissions
 180      */
 181     public CldsInfo getCldsInfo() {
 182         util.entering(request, "CldsService: GET cldsInfo");
 183         Date startTime = new Date();
 184         LoggingUtils.setTimeContext(startTime, new Date());
 185
 186         CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
 187         CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
 188
 189         // audit log
 190         LoggingUtils.setTimeContext(startTime, new Date());
 191         securityLogger.info("GET cldsInfo completed");
 192         util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 193         return cldsInfo;
 194     }
 195
 196     /**
 197      * REST service that retrieves BPMN for a CLDS model name from the database.
 198      * This is subset of the json getModel. This is only expected to be used for
 199      * testing purposes, not by the UI.
 200      *
 201      * @param modelName
 202      * @return bpmn xml text - content of bpmn given name
 203      */
 204     public String getBpmnXml(String modelName) {
 205         util.entering(request, "CldsService: GET model bpmn");
 206         Date startTime = new Date();
 207         isAuthorized(permissionReadCl);
 208         logger.info("GET bpmnText for modelName={}", modelName);
 209         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 210         // audit log
 211         LoggingUtils.setTimeContext(startTime, new Date());
 212         auditLogger.info("GET model bpmn completed");
 213         util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 214         return model.getBpmnText();
 215     }
 216
 217     /**
 218      * REST service that retrieves image for a CLDS model name from the database.
 219      * This is subset of the json getModel. This is only expected to be used for
 220      * testing purposes, not by the UI.
 221      *
 222      * @param modelName
 223      * @return image xml text - content of image given name
 224      */
 225     public String getImageXml(String modelName) {
 226         util.entering(request, "CldsService: GET model image");
 227         Date startTime = new Date();
 228         isAuthorized(permissionReadCl);
 229         logger.info("GET imageText for modelName={}", modelName);
 230         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 231         // audit log
 232         LoggingUtils.setTimeContext(startTime, new Date());
 233         auditLogger.info("GET model image completed");
 234         util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 235         return model.getImageText();
 236     }
 237
 238     /**
 239      * REST service that retrieves a CLDS model by name from the database.
 240      *
 241      * @param modelName
 242      * @return clds model - clds model for the given model name
 243      */
 244     public CldsModel getModel(String modelName) {
 245         util.entering(request, "CldsService: GET model");
 246         Date startTime = new Date();
 247         isAuthorized(permissionReadCl);
 248         logger.debug("GET model for  modelName={}", modelName);
 249         CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
 250         isAuthorizedForVf(cldsModel);
 251         // Checking condition whether our CLDS model can call Inventory Method
 252         if (cldsModel.canInventoryCall()) {
 253             try {
 254                 // Method to call dcae inventory and invoke insert event method
 255                 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
 256             } catch (Exception e) {
 257                 LoggingUtils.setErrorContext("900", "Set event inventory error");
 258                 logger.error("getModel set event Inventory error:" + e);
 259             }
 260         }
 261         // audit log
 262         LoggingUtils.setTimeContext(startTime, new Date());
 263         auditLogger.info("GET model completed");
 264         util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 265         return cldsModel;
 266     }
 267
 268     /**
 269      * REST service that saves a CLDS model by name in the database.
 270      *
 271      * @param modelName
 272      */
 273     public CldsModel putModel(String modelName, CldsModel cldsModel) {
 274         util.entering(request, "CldsService: PUT model");
 275         Date startTime = new Date();
 276         isAuthorized(permissionUpdateCl);
 277         isAuthorizedForVf(cldsModel);
 278         logger.info("PUT model for  modelName={}", modelName);
 279         logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
 280         logger.info("PUT propText={}", cldsModel.getPropText());
 281         logger.info("PUT imageText={}", cldsModel.getImageText());
 282         cldsModel.setName(modelName);
 283         fillInCldsModel(cldsModel);
 284         updateAndInsertNewEvent(cldsModel.getName(), cldsModel.getControlNamePrefix(), cldsModel.getEvent(),
 285             CldsEvent.ACTION_MODIFY);
 286         cldsModel.save(cldsDao, getUserId());
 287         // audit log
 288         LoggingUtils.setTimeContext(startTime, new Date());
 289         auditLogger.info("PUT model completed");
 290         util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 291         return cldsModel;
 292     }
 293
 294     /**
 295      * REST service that retrieves a list of CLDS model names.
 296      *
 297      * @return model names in JSON
 298      */
 299     public List<ValueItem> getModelNames() {
 300         util.entering(request, "CldsService: GET model names");
 301         Date startTime = new Date();
 302         isAuthorized(permissionReadCl);
 303         logger.info("GET list of model names");
 304         List<ValueItem> names = cldsDao.getModelNames();
 305         // audit log
 306         LoggingUtils.setTimeContext(startTime, new Date());
 307         auditLogger.info("GET model names completed");
 308         util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 309         return names;
 310     }
 311
 312     private void fillInCldsModel(CldsModel model) {
 313         if (model.getTemplateName() != null) {
 314             CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 315             if (template != null) {
 316                 model.setTemplateId(template.getId());
 317                 model.setDocText(template.getPropText());
 318                 // This is to provide the Bpmn XML when Template part in UI
 319                 // is
 320                 // disabled
 321                 model.setBpmnText(template.getBpmnText());
 322             }
 323         }
 324     }
 325
 326     /**
 327      * REST service that saves and processes an action for a CLDS model by name.
 328      *
 329      * @param action
 330      * @param modelName
 331      * @param validateFlag
 332      * @param model
 333      * @return
 334      * @throws TransformerException
 335      *         In case of issues when doing the XSLT of the BPMN flow
 336      * @throws ParseException
 337      *         In case of issues when parsing the JSON
 338      * @throws GeneralSecurityException
 339      *         In case of issues when decrypting the password
 340      * @throws DecoderException
 341      *         In case of issues with the Hex String decoding
 342      */
 343     public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
 344         throws TransformerException, ParseException {
 345         util.entering(request, "CldsService: Process model action");
 346         Date startTime = new Date();
 347         CldsModel retrievedModel = null;
 348         Boolean errorCase = false;
 349         try {
 350             String actionCd = action.toUpperCase();
 351             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 352                 cldsPermissionInstance, actionCd);
 353             isAuthorized(permisionManage);
 354             isAuthorizedForVf(model);
 355             String userId = getUserId();
 356             logger.info("PUT actionCd={}", actionCd);
 357             logger.info("PUT modelName={}", modelName);
 358             logger.info("PUT test={}", test);
 359             logger.info("PUT bpmnText={}", model.getBpmnText());
 360             logger.info("PUT propText={}", model.getPropText());
 361             logger.info("PUT userId={}", userId);
 362             logger.info("PUT getTypeId={}", model.getTypeId());
 363             logger.info("PUT deploymentId={}", model.getDeploymentId());
 364             this.fillInCldsModel(model);
 365             // save model to db
 366             model.setName(modelName);
 367             updateAndInsertNewEvent(modelName, model.getControlNamePrefix(), model.getEvent(), CldsEvent.ACTION_SUBMIT);
 368             model.save(cldsDao, getUserId());
 369             // get vars and format if necessary
 370             String prop = model.getPropText();
 371             String bpmn = model.getBpmnText();
 372             String docText = model.getDocText();
 373             String controlName = model.getControlName();
 374             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
 375             logger.info("PUT bpmnJson={}", bpmnJson);
 376             // Flag indicates whether it is triggered by Validation Test button
 377             // from
 378             // UI
 379             boolean isTest = Boolean.parseBoolean(test);
 380             if (!isTest) {
 381                 String actionTestOverride = refProp.getStringValue("action.test.override");
 382                 if (Boolean.parseBoolean(actionTestOverride)) {
 383                     logger.info("PUT actionTestOverride={}", actionTestOverride);
 384                     logger.info("PUT override test indicator and setting it to true");
 385                     isTest = true;
 386                 }
 387             }
 388             logger.info("PUT isTest={}", isTest);
 389             String insertTestEvent = refProp.getStringValue("action.insert.test.event");
 390             boolean isInsertTestEvent = Boolean.parseBoolean(insertTestEvent);
 391
 392             logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
 393             // determine if requested action is permitted
 394             model.validateAction(actionCd);
 395             logger.info("modelProp - " + prop);
 396             logger.info("docText - " + docText);
 397             try {
 398                 String result = camelProxy.submit(actionCd, prop, bpmnJson, modelName, controlName, docText, isTest,
 399                     userId, isInsertTestEvent, model.getEvent().getActionCd());
 400                 logger.info("Starting Camel flow on request, result is: ", result);
 401             } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
 402                 errorCase = true;
 403                 logger.error("Exception occured during invoking Camel process", e);
 404             }
 405             if (!actionCd.equalsIgnoreCase(CldsEvent.ACTION_DELETE)) {
 406                 // refresh model info from db (get fresh event info)
 407                 retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
 408             }
 409             if (retrievedModel != null) {
 410                 if (!isTest && !errorCase
 411                     && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
 412                         || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
 413                         || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
 414                     if (retrievedModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
 415                         // SDC artifact case
 416                         logger
 417                         .info("Skipping DCAE inventory call as closed loop has been created from SDC notification");
 418                         DcaeEvent dcaeEvent = new DcaeEvent();
 419                         dcaeEvent.setArtifactName(retrievedModel.getControlName() + ".yml");
 420                         dcaeEvent.setEvent(DcaeEvent.EVENT_DISTRIBUTION);
 421                         CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userId, dcaeEvent.getCldsActionCd(),
 422                             CldsEvent.ACTION_STATE_RECEIVED, null);
 423                     } else {
 424                         // This should be done only when the call to DCAE
 425                         // has not yet been done. When CL comes from SDC
 426                         // this is not required as the DCAE inventory call is done
 427                         // during the CL deployment.
 428                         dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
 429                     }
 430                     retrievedModel.save(cldsDao, getUserId());
 431                 }
 432                 // audit log
 433                 LoggingUtils.setTimeContext(startTime, new Date());
 434                 auditLogger.info("Process model action completed");
 435             } else {
 436                 logger.error("CldsModel not found in database with modelName: " + modelName);
 437                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(),
 438                     "CldsModel not found in database with modelName " + "modelName", Level.INFO,
 439                     ONAPLogConstants.ResponseStatus.ERROR);
 440                 return new ResponseEntity<String>("CldsModel not found in database with modelName: \" + modelName",
 441                     HttpStatus.INTERNAL_SERVER_ERROR);
 442             }
 443         } catch (Exception e) {
 444             errorCase = true;
 445             logger.error("Exception occured during putModelAndProcessAction", e);
 446         }
 447         if (errorCase) {
 448             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
 449                 ONAPLogConstants.ResponseStatus.ERROR);
 450             return new ResponseEntity<>(retrievedModel, HttpStatus.INTERNAL_SERVER_ERROR);
 451         }
 452         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 453         return new ResponseEntity<>(retrievedModel, HttpStatus.OK);
 454     }
 455
 456     /**
 457      * REST service that accepts events for a model.
 458      *
 459      * @param test
 460      * @param dcaeEvent
 461      */
 462     public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
 463         util.entering(request, "CldsService: Post dcae event");
 464         Date startTime = new Date();
 465         String userid = null;
 466         // TODO: allow auth checking to be turned off by removing the permission
 467         // type property
 468         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 469             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 470                 cldsPermissionInstance, dcaeEvent.getEvent());
 471             isAuthorized(permissionEvent);
 472             userid = getUserId();
 473         }
 474         // Flag indicates whether it is triggered by Validation Test button from
 475         // UI
 476         boolean isTest = Boolean.parseBoolean(test);
 477         int instanceCount = 0;
 478         if (dcaeEvent.getInstances() != null) {
 479             instanceCount = dcaeEvent.getInstances().size();
 480         }
 481         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 482         + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
 483         + " instance count=" + instanceCount + " isTest=" + isTest;
 484         logger.info("POST dcae event {}", msgInfo);
 485         if (isTest) {
 486             logger.warn("Ignorning test event from DCAE");
 487         } else {
 488             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 489                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 490             } else {
 491                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 492                     CldsEvent.ACTION_STATE_RECEIVED, null);
 493             }
 494         }
 495         // audit log
 496         LoggingUtils.setTimeContext(startTime, new Date());
 497         auditLogger.info("Post dcae event completed");
 498         util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 499         return msgInfo;
 500     }
 501
 502     /**
 503      * REST service that retrieves sdc services
 504      *
 505      * @throws GeneralSecurityException
 506      *         In case of issue when decryting the SDC password
 507      * @throws DecoderException
 508      *         In case of issues with the decoding of the Hex String
 509      */
 510     public String getSdcServices() throws GeneralSecurityException, DecoderException {
 511         util.entering(request, "CldsService: GET sdc services");
 512         Date startTime = new Date();
 513         String retStr;
 514         try {
 515             retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
 516         } catch (IOException e) {
 517             logger.error("IOException during SDC communication", e);
 518             throw new SdcCommunicationException("IOException during SDC communication", e);
 519         }
 520         logger.info("value of sdcServices : {}", retStr);
 521         // audit log
 522         LoggingUtils.setTimeContext(startTime, new Date());
 523         auditLogger.info("GET sdc services completed");
 524         util.exiting("200", "Get sdc services success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 525         return retStr;
 526     }
 527
 528     /**
 529      * REST service that retrieves total properties required by UI
 530      *
 531      * @throws IOException
 532      *         In case of issues
 533      */
 534     public String getSdcProperties() throws IOException {
 535         return createPropertiesObjectByUUID("{}");
 536     }
 537
 538     /**
 539      * REST service that retrieves total properties by using invariantUUID based on
 540      * refresh and non refresh
 541      *
 542      * @throws GeneralSecurityException
 543      *         In case of issues with the decryting the encrypted password
 544      * @throws DecoderException
 545      *         In case of issues with the decoding of the Hex String
 546      * @throws IOException
 547      *         In case of issue to convert CldsServiceCache to InputStream
 548      */
 549     public String getSdcPropertiesByServiceUUIDForRefresh(String serviceInvariantUUID, Boolean refresh)
 550         throws GeneralSecurityException, DecoderException, IOException {
 551         util.entering(request, "CldsService: GET sdc properties by uuid");
 552         Date startTime = new Date();
 553         CldsServiceData cldsServiceData = new CldsServiceData();
 554         cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
 555         if (!Optional.ofNullable(refresh).orElse(false)) {
 556             cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
 557         }
 558         if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
 559             cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
 560             cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
 561         }
 562         // filter out VFs the user is not authorized for
 563         cldsServiceData.filterVfs(this);
 564         // format retrieved data into properties json
 565         String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
 566         // audit log
 567         LoggingUtils.setTimeContext(startTime, new Date());
 568         auditLogger.info("GET sdc properties by uuid completed");
 569         util.exiting("200", "Get sdc properties by uuid success", Level.INFO,
 570             ONAPLogConstants.ResponseStatus.COMPLETED);
 571         return sdcProperties;
 572     }
 573
 574     /**
 575      * Determine if the user is authorized for a particular VF by its invariant
 576      * UUID.
 577      *
 578      * @param vfInvariantUuid
 579      * @throws NotAuthorizedException
 580      * @return
 581      */
 582     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 583         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 584             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 585                 cldsPermissionInstance, vfInvariantUuid);
 586             return isAuthorized(permission);
 587         } else {
 588             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 589             // VF filtering is turned off
 590             logger.warn("VF filtering turned off");
 591             return true;
 592         }
 593     }
 594
 595     /**
 596      * Determine if the user is authorized for a particular VF by its invariant
 597      * UUID. If not authorized, then NotAuthorizedException is thrown.
 598      *
 599      * @param model
 600      * @return
 601      */
 602     private boolean isAuthorizedForVf(CldsModel model) {
 603         String vf = ModelProperties.getVf(model);
 604         if (vf == null || vf.length() == 0) {
 605             logger.info("VF not found in model");
 606             return true;
 607         } else {
 608             return isAuthorizedForVf(vf);
 609         }
 610     }
 611
 612     private String createUiServiceFormatJson(String responseStr) throws IOException {
 613         if (StringUtils.isBlank(responseStr)) {
 614             return "";
 615         }
 616         ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
 617         List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
 618             objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
 619         ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
 620         ObjectNode serviceNode = objectMapper.createObjectNode();
 621         logger.info("value of cldsserviceiNfolist: {}", rawList);
 622         if (rawList != null && !rawList.isEmpty()) {
 623             List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
 624             for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
 625                 if (currCldsSdcServiceInfo != null) {
 626                     invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
 627                         currCldsSdcServiceInfo.getName());
 628                 }
 629             }
 630             serviceNode.putPOJO("service", invariantIdServiceNode);
 631         }
 632         return serviceNode.toString();
 633     }
 634
 635     private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
 636         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 637         SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
 638         ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
 639         if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
 640             /**
 641              * to create json with vf, alarm and locations
 642              */
 643             ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
 644             ObjectNode vfObjectNode = mapper.createObjectNode();
 645             /**
 646              * to create json with vf and vfresourceId
 647              */
 648             createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
 649             serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
 650             ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
 651             byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
 652             /**
 653              * to create json with VFC Node
 654              */
 655             ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
 656             byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
 657             globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
 658             logger.info("valuie of objNode: {}", globalPropsJson);
 659         }
 660         return globalPropsJson.toString();
 661     }
 662
 663     private ObjectNode createEmptyVfAlarmObject() {
 664         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 665         ObjectNode emptyObjectNode = mapper.createObjectNode();
 666         emptyObjectNode.put("", "");
 667         ObjectNode vfObjectNode = mapper.createObjectNode();
 668         vfObjectNode.putPOJO("vf", emptyObjectNode);
 669         vfObjectNode.putPOJO("location", emptyObjectNode);
 670         vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
 671         ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
 672         emptyServiceObjectNode.putPOJO("", vfObjectNode);
 673         return emptyServiceObjectNode;
 674     }
 675
 676     private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
 677         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 678         ObjectNode vfNode = mapper.createObjectNode();
 679         vfNode.put("", "");
 680         // To remove repeated resource instance name from
 681         // resourceInstanceList
 682         List<SdcResource> cldsSdcResourceList = sdcCatalogServices
 683             .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
 684         /**
 685          * Creating vf resource node using cldsSdcResource Object
 686          */
 687         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 688             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 689                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 690                     vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
 691                 }
 692             }
 693         }
 694         vfObjectNode2.putPOJO("vf", vfNode);
 695         /**
 696          * creating location json object using properties file value
 697          */
 698         ObjectNode locationJsonNode;
 699         try {
 700             locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
 701                 JsonNode.class);
 702         } catch (IOException e) {
 703             logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
 704             throw new CldsConfigException(
 705                 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
 706         }
 707         vfObjectNode2.putPOJO("location", locationJsonNode);
 708         /**
 709          * creating alarm json object using properties file value
 710          */
 711         String alarmStringValue = refProp.getStringValue("ui.alarm.default");
 712         logger.info("value of alarm: {}", alarmStringValue);
 713         ObjectNode alarmStringJsonNode;
 714         try {
 715             alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
 716         } catch (IOException e) {
 717             logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
 718             throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
 719                 e);
 720         }
 721         vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
 722     }
 723
 724     private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
 725         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 726         ObjectNode emptyObjectNode = mapper.createObjectNode();
 727         ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
 728         ObjectNode vfCObjectNode = mapper.createObjectNode();
 729         vfCObjectNode.putPOJO("vfC", emptyObjectNode);
 730         ObjectNode subVfCObjectNode = mapper.createObjectNode();
 731         subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
 732         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 733             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 734                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 735                     vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
 736                 }
 737             }
 738         }
 739         emptyvfcobjectNode.putPOJO("", vfCObjectNode);
 740         return emptyvfcobjectNode;
 741     }
 742
 743     public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
 744         util.entering(request, "CldsService: Deploy model");
 745         Date startTime = new Date();
 746         Boolean errorCase = false;
 747         try {
 748             fillInCldsModel(model);
 749             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
 750             logger.info("PUT bpmnJson={}", bpmnJson);
 751             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 752                 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
 753             isAuthorized(permisionManage);
 754             isAuthorizedForVf(model);
 755             ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
 756                 false, bpmnJson, model.getPropText());
 757             checkForDuplicateServiceVf(modelName, model.getPropText());
 758             String deploymentId = "";
 759             // If model is already deployed then pass same deployment id
 760             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 761                 deploymentId = model.getDeploymentId();
 762             } else {
 763                 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
 764             }
 765             String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
 766                 model.getTypeId(), modelProp.getGlobal().getDeployParameters());
 767             String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(createNewDeploymentStatusUrl);
 768             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 769                 String artifactName = model.getControlName();
 770                 if (artifactName != null) {
 771                     artifactName = artifactName + ".yml";
 772                 }
 773                 DcaeEvent dcaeEvent = new DcaeEvent();
 774                 /* set dcae events */
 775                 dcaeEvent.setArtifactName(artifactName);
 776                 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
 777                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 778                     CldsEvent.ACTION_STATE_RECEIVED, null);
 779                 model.setDeploymentId(deploymentId);
 780                 model.save(cldsDao, getUserId());
 781             } else {
 782                 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 783                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
 784                     ONAPLogConstants.ResponseStatus.ERROR);
 785                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 786                     "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 787             }
 788             logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
 789             // audit log
 790             LoggingUtils.setTimeContext(startTime, new Date());
 791             auditLogger.info("Deploy model completed");
 792         } catch (Exception e) {
 793             errorCase = true;
 794             logger.error("Exception occured during deployModel", e);
 795         }
 796         if (errorCase) {
 797             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
 798                 ONAPLogConstants.ResponseStatus.ERROR);
 799             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 800         }
 801         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 802         return new ResponseEntity<>(model, HttpStatus.OK);
 803     }
 804
 805     public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
 806         util.entering(request, "CldsService: Undeploy model");
 807         Date startTime = new Date();
 808         Boolean errorCase = false;
 809         try {
 810             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 811                 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
 812             isAuthorized(permisionManage);
 813             isAuthorizedForVf(model);
 814             String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
 815                 model.getTypeId());
 816             String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(operationStatusUndeployUrl);
 817             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 818                 String artifactName = model.getControlName();
 819                 if (artifactName != null) {
 820                     artifactName = artifactName + ".yml";
 821                 }
 822                 DcaeEvent dcaeEvent = new DcaeEvent();
 823                 // set dcae events
 824                 dcaeEvent.setArtifactName(artifactName);
 825                 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
 826                 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 827                     CldsEvent.ACTION_STATE_RECEIVED, null);
 828                 model.setDeploymentId(null);
 829                 model.save(cldsDao, getUserId());
 830             } else {
 831                 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 832                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
 833                     ONAPLogConstants.ResponseStatus.ERROR);
 834                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 835                     "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 836             }
 837             logger.info("Undeploy model (" + modelName + ") succeeded.");
 838             // audit log
 839             LoggingUtils.setTimeContext(startTime, new Date());
 840             auditLogger.info("Undeploy model completed");
 841         } catch (Exception e) {
 842             errorCase = true;
 843             logger.error("Exception occured during unDeployModel", e);
 844         }
 845         if (errorCase) {
 846             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
 847                 ONAPLogConstants.ResponseStatus.ERROR);
 848             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 849         }
 850         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 851         return new ResponseEntity<>(model, HttpStatus.OK);
 852     }
 853
 854     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 855         JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
 856         String service = AbstractModelElement.getValueByName(globalNode, "service");
 857         List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
 858         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 859             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 860             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 861                 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
 862                     .get("global");
 863                 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
 864                 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
 865                 if (currentVf != null && !currentVf.isEmpty()) {
 866                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 867                         && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 868                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 869                         + " model, please select different Service/VF.");
 870                     }
 871                 }
 872             }
 873         }
 874     }
 875
 876     private void updateAndInsertNewEvent(String cldsModelName, String cldsControlNamePrfx, CldsEvent event,
 877         String newAction) {
 878         // If model action is in submit/resubmit/distributed and user try
 879         // to save then we are changing action back to create.
 880         if (event != null && (CldsEvent.ACTION_SUBMIT.equalsIgnoreCase(event.getActionCd())
 881             || CldsEvent.ACTION_RESUBMIT.equalsIgnoreCase(event.getActionCd())
 882             || CldsEvent.ACTION_DISTRIBUTE.equalsIgnoreCase(event.getActionCd()))) {
 883             CldsEvent newEvent = new CldsEvent();
 884             newEvent.setUserid(getUserId());
 885             newEvent.setActionCd(newAction);
 886             newEvent.setActionStateCd(CldsEvent.ACTION_STATE_COMPLETED);
 887             cldsDao.insEvent(cldsModelName, cldsControlNamePrfx, null, newEvent);
 888         }
 889     }
 890
 891     // Created for the integration test
 892     public void setLoggingUtil(LoggingUtils utilP) {
 893         util = utilP;
 894     }
 895 }