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     @Autowired
 122     public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
 123         SdcCatalogServices sdcCatalogServices, DcaeDispatcherServices dcaeDispatcherServices,
 124         DcaeInventoryServices dcaeInventoryServices,
 125         @Value("${clamp.config.security.permission.type.cl:permission-type-cl}") String cldsPersmissionTypeCl,
 126         @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}") String cldsPermissionTypeClManage,
 127         @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}") String cldsPermissionTypeClEvent,
 128         @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}") String cldsPermissionTypeFilterVf,
 129         @Value("${clamp.config.security.permission.type.template:permission-type-template}") String cldsPermissionTypeTemplate,
 130             @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}") String cldsPermissionTypeTosca,
 131         @Value("${clamp.config.security.permission.instance:dev}") String cldsPermissionInstance) {
 132         this.cldsDao = cldsDao;
 133         this.cldsBpmnTransformer = cldsBpmnTransformer;
 134         this.refProp = refProp;
 135         this.sdcCatalogServices = sdcCatalogServices;
 136         this.dcaeDispatcherServices = dcaeDispatcherServices;
 137         this.dcaeInventoryServices = dcaeInventoryServices;
 138         this.cldsPersmissionTypeCl = cldsPersmissionTypeCl;
 139         this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
 140         this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
 141         this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
 142         this.cldsPermissionTypeTemplate = cldsPermissionTypeTemplate;
 143         this.cldsPermissionInstance = cldsPermissionInstance;
 144         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 145         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 146         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 147             "read");
 148         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 149             "update");
 150         permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
 151         permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
 152                 "update");
 153     }
 154
 155     /*
 156      * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
 157      * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
 158      * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
 159      * from the DCAE application when the ClosedLoop is submitted
 160      * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
 161      * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
 162      * used to generate the ClosedLoop model. ACTION_CD | Current state of the
 163      * ClosedLoop in CLDS application.
 164      */
 165     public List<CldsMonitoringDetails> getCLDSDetails() {
 166         util.entering(request, "CldsService: GET model details");
 167         Date startTime = new Date();
 168         List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCLDSMonitoringDetails();
 169         // audit log
 170         LoggingUtils.setTimeContext(startTime, new Date());
 171         auditLogger.info("GET cldsDetails completed");
 172         util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 173         return cldsMonitoringDetailsList;
 174     }
 175
 176     /*
 177      * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
 178      * is currently installed from pom.xml file 3. User permissions
 179      */
 180     public CldsInfo getCldsInfo() {
 181         util.entering(request, "CldsService: GET cldsInfo");
 182         Date startTime = new Date();
 183         LoggingUtils.setTimeContext(startTime, new Date());
 184
 185         CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
 186         CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
 187
 188         // audit log
 189         LoggingUtils.setTimeContext(startTime, new Date());
 190         securityLogger.info("GET cldsInfo completed");
 191         util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 192         return cldsInfo;
 193     }
 194
 195     /**
 196      * REST service that retrieves BPMN for a CLDS model name from the database.
 197      * This is subset of the json getModel. This is only expected to be used for
 198      * testing purposes, not by the UI.
 199      *
 200      * @param modelName
 201      * @return bpmn xml text - content of bpmn given name
 202      */
 203     public String getBpmnXml(String modelName) {
 204         util.entering(request, "CldsService: GET model bpmn");
 205         Date startTime = new Date();
 206         isAuthorized(permissionReadCl);
 207         logger.info("GET bpmnText for modelName={}", modelName);
 208         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 209         // audit log
 210         LoggingUtils.setTimeContext(startTime, new Date());
 211         auditLogger.info("GET model bpmn completed");
 212         util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 213         return model.getBpmnText();
 214     }
 215
 216     /**
 217      * REST service that retrieves image for a CLDS model name from the database.
 218      * This is subset of the json getModel. This is only expected to be used for
 219      * testing purposes, not by the UI.
 220      *
 221      * @param modelName
 222      * @return image xml text - content of image given name
 223      */
 224     public String getImageXml(String modelName) {
 225         util.entering(request, "CldsService: GET model image");
 226         Date startTime = new Date();
 227         isAuthorized(permissionReadCl);
 228         logger.info("GET imageText for modelName={}", modelName);
 229         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 230         // audit log
 231         LoggingUtils.setTimeContext(startTime, new Date());
 232         auditLogger.info("GET model image completed");
 233         util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 234         return model.getImageText();
 235     }
 236
 237     /**
 238      * REST service that retrieves a CLDS model by name from the database.
 239      *
 240      * @param modelName
 241      * @return clds model - clds model for the given model name
 242      */
 243     public CldsModel getModel(String modelName) {
 244         util.entering(request, "CldsService: GET model");
 245         Date startTime = new Date();
 246         isAuthorized(permissionReadCl);
 247         logger.debug("GET model for  modelName={}", modelName);
 248         CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
 249         isAuthorizedForVf(cldsModel);
 250         // Checking condition whether our CLDS model can call Inventory Method
 251         if (cldsModel.canInventoryCall()) {
 252             try {
 253                 // Method to call dcae inventory and invoke insert event method
 254                 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
 255             } catch (Exception e) {
 256                 LoggingUtils.setErrorContext("900", "Set event inventory error");
 257                 logger.error("getModel set event Inventory error:" + e);
 258             }
 259         }
 260         // audit log
 261         LoggingUtils.setTimeContext(startTime, new Date());
 262         auditLogger.info("GET model completed");
 263         util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 264         return cldsModel;
 265     }
 266
 267     /**
 268      * REST service that saves a CLDS model by name in the database.
 269      *
 270      * @param modelName
 271      */
 272     public CldsModel putModel(String modelName, CldsModel cldsModel) {
 273         util.entering(request, "CldsService: PUT model");
 274         Date startTime = new Date();
 275         isAuthorized(permissionUpdateCl);
 276         isAuthorizedForVf(cldsModel);
 277         logger.info("PUT model for  modelName={}", modelName);
 278         logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
 279         logger.info("PUT propText={}", cldsModel.getPropText());
 280         logger.info("PUT imageText={}", cldsModel.getImageText());
 281         cldsModel.setName(modelName);
 282         fillInCldsModel(cldsModel);
 283         updateAndInsertNewEvent(cldsModel.getName(), cldsModel.getControlNamePrefix(), cldsModel.getEvent(),
 284             CldsEvent.ACTION_MODIFY);
 285         cldsModel.save(cldsDao, getUserId());
 286         // audit log
 287         LoggingUtils.setTimeContext(startTime, new Date());
 288         auditLogger.info("PUT model completed");
 289         util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 290         return cldsModel;
 291     }
 292
 293     /**
 294      * REST service that retrieves a list of CLDS model names.
 295      *
 296      * @return model names in JSON
 297      */
 298     public List<ValueItem> getModelNames() {
 299         util.entering(request, "CldsService: GET model names");
 300         Date startTime = new Date();
 301         isAuthorized(permissionReadCl);
 302         logger.info("GET list of model names");
 303         List<ValueItem> names = cldsDao.getModelNames();
 304         // audit log
 305         LoggingUtils.setTimeContext(startTime, new Date());
 306         auditLogger.info("GET model names completed");
 307         util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 308         return names;
 309     }
 310
 311     private void fillInCldsModel(CldsModel model) {
 312         if (model.getTemplateName() != null) {
 313             CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 314             if (template != null) {
 315                 model.setTemplateId(template.getId());
 316                 model.setDocText(template.getPropText());
 317                 // This is to provide the Bpmn XML when Template part in UI
 318                 // is
 319                 // disabled
 320                 model.setBpmnText(template.getBpmnText());
 321             }
 322         }
 323     }
 324
 325     /**
 326      * REST service that saves and processes an action for a CLDS model by name.
 327      *
 328      * @param action
 329      * @param modelName
 330      * @param validateFlag
 331      * @param model
 332      * @return
 333      * @throws TransformerException
 334      *         In case of issues when doing the XSLT of the BPMN flow
 335      * @throws ParseException
 336      *         In case of issues when parsing the JSON
 337      * @throws GeneralSecurityException
 338      *         In case of issues when decrypting the password
 339      * @throws DecoderException
 340      *         In case of issues with the Hex String decoding
 341      */
 342     public ResponseEntity<?> putModelAndProcessAction(String action,
 343         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_MODIFY);
 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.valueOf(test);
 380             if (!isTest) {
 381                 String actionTestOverride = refProp.getStringValue("action.test.override");
 382                 if (Boolean.valueOf(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.valueOf(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 && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
 411                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
 412                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
 413                     if (retrievedModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
 414                         // SDC artifact case
 415                         logger.info("Skipping DCAE inventory call as closed loop has been created from SDC notification");
 416                         DcaeEvent dcaeEvent = new DcaeEvent();
 417                         dcaeEvent.setArtifactName(retrievedModel.getControlName() + ".yml");
 418                         dcaeEvent.setEvent(DcaeEvent.EVENT_DISTRIBUTION);
 419                         CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userId, dcaeEvent.getCldsActionCd(),
 420                             CldsEvent.ACTION_STATE_RECEIVED, null);
 421                     } else {
 422                         // This should be done only when the call to DCAE
 423                         // has not yet been done. When CL comes from SDC
 424                         // this is not required as the DCAE inventory call is done
 425                         // during the CL deployment.
 426                         dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
 427                     }
 428                     retrievedModel.save(cldsDao, getUserId());
 429                 }
 430                 // audit log
 431                 LoggingUtils.setTimeContext(startTime, new Date());
 432                 auditLogger.info("Process model action completed");
 433             } else {
 434                 logger.error("CldsModel not found in database with modelName: " + modelName);
 435                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "CldsModel not found in database with modelName " + "modelName", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 436                 return new ResponseEntity<String>("CldsModel not found in database with modelName: \" + modelName", HttpStatus.INTERNAL_SERVER_ERROR);
 437             }
 438         } catch (Exception e) {
 439             errorCase = true;
 440             logger.error("Exception occured during putModelAndProcessAction", e);
 441         }
 442         if (errorCase) {
 443             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 444             return new ResponseEntity<>(retrievedModel, HttpStatus.INTERNAL_SERVER_ERROR);
 445         }
 446         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 447         return new ResponseEntity<>(retrievedModel, HttpStatus.OK);
 448     }
 449
 450     /**
 451      * REST service that accepts events for a model.
 452      *
 453      * @param test
 454      * @param dcaeEvent
 455      */
 456     public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
 457         util.entering(request, "CldsService: Post dcae event");
 458         Date startTime = new Date();
 459         String userid = null;
 460         // TODO: allow auth checking to be turned off by removing the permission
 461         // type property
 462         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 463             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 464                 cldsPermissionInstance, dcaeEvent.getEvent());
 465             isAuthorized(permissionEvent);
 466             userid = getUserId();
 467         }
 468         // Flag indicates whether it is triggered by Validation Test button from
 469         // UI
 470         boolean isTest = Boolean.valueOf(test);
 471         int instanceCount = 0;
 472         if (dcaeEvent.getInstances() != null) {
 473             instanceCount = dcaeEvent.getInstances().size();
 474         }
 475         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 476         + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
 477         + " instance count=" + instanceCount + " isTest=" + isTest;
 478         logger.info("POST dcae event {}", msgInfo);
 479         if (isTest) {
 480             logger.warn("Ignorning test event from DCAE");
 481         } else {
 482             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 483                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 484             } else {
 485                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 486                     CldsEvent.ACTION_STATE_RECEIVED, null);
 487             }
 488         }
 489         // audit log
 490         LoggingUtils.setTimeContext(startTime, new Date());
 491         auditLogger.info("Post dcae event completed");
 492         util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 493         return msgInfo;
 494     }
 495
 496     /**
 497      * REST service that retrieves sdc services
 498      *
 499      * @throws GeneralSecurityException
 500      *         In case of issue when decryting the SDC password
 501      * @throws DecoderException
 502      *         In case of issues with the decoding of the Hex String
 503      */
 504     public String getSdcServices() throws GeneralSecurityException, DecoderException {
 505         util.entering(request, "CldsService: GET sdc services");
 506         Date startTime = new Date();
 507         String retStr;
 508         try {
 509             retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
 510         } catch (IOException e) {
 511             logger.error("IOException during SDC communication", e);
 512             throw new SdcCommunicationException("IOException during SDC communication", e);
 513         }
 514         logger.info("value of sdcServices : {}", retStr);
 515         // audit log
 516         LoggingUtils.setTimeContext(startTime, new Date());
 517         auditLogger.info("GET sdc services completed");
 518         util.exiting("200", "Get sdc services success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 519         return retStr;
 520     }
 521
 522     /**
 523      * REST service that retrieves total properties required by UI
 524      *
 525      * @throws IOException
 526      *         In case of issues
 527      */
 528     public String getSdcProperties() throws IOException {
 529         return createPropertiesObjectByUUID("{}");
 530     }
 531
 532     /**
 533      * REST service that retrieves total properties by using invariantUUID based on
 534      * refresh and non refresh
 535      *
 536      * @throws GeneralSecurityException
 537      *         In case of issues with the decryting the encrypted password
 538      * @throws DecoderException
 539      *         In case of issues with the decoding of the Hex String
 540      * @throws IOException
 541      *         In case of issue to convert CldsServiceCache to InputStream
 542      */
 543     public String getSdcPropertiesByServiceUUIDForRefresh(
 544         String serviceInvariantUUID, Boolean refresh)
 545             throws GeneralSecurityException, DecoderException, IOException {
 546         util.entering(request, "CldsService: GET sdc properties by uuid");
 547         Date startTime = new Date();
 548         CldsServiceData cldsServiceData = new CldsServiceData();
 549         cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
 550         if (!Optional.ofNullable(refresh).orElse(false)) {
 551             cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
 552         }
 553         if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
 554             cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
 555             cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
 556         }
 557         // filter out VFs the user is not authorized for
 558         cldsServiceData.filterVfs(this);
 559         // format retrieved data into properties json
 560         String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
 561         // audit log
 562         LoggingUtils.setTimeContext(startTime, new Date());
 563         auditLogger.info("GET sdc properties by uuid completed");
 564         util.exiting("200", "Get sdc properties by uuid success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 565         return sdcProperties;
 566     }
 567
 568     /**
 569      * Determine if the user is authorized for a particular VF by its invariant
 570      * UUID.
 571      *
 572      * @param vfInvariantUuid
 573      * @throws NotAuthorizedException
 574      * @return
 575      */
 576     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 577         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 578             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 579                 cldsPermissionInstance, vfInvariantUuid);
 580             return isAuthorized(permission);
 581         } else {
 582             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 583             // VF filtering is turned off
 584             logger.warn("VF filtering turned off");
 585             return true;
 586         }
 587     }
 588
 589     /**
 590      * Determine if the user is authorized for a particular VF by its invariant
 591      * UUID. If not authorized, then NotAuthorizedException is thrown.
 592      *
 593      * @param model
 594      * @return
 595      */
 596     private boolean isAuthorizedForVf(CldsModel model) {
 597         String vf = ModelProperties.getVf(model);
 598         if (vf == null || vf.length() == 0) {
 599             logger.info("VF not found in model");
 600             return true;
 601         } else {
 602             return isAuthorizedForVf(vf);
 603         }
 604     }
 605
 606     private String createUiServiceFormatJson(String responseStr) throws IOException {
 607         if (StringUtils.isBlank(responseStr)) {
 608             return "";
 609         }
 610         ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
 611         List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
 612             objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
 613         ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
 614         ObjectNode serviceNode = objectMapper.createObjectNode();
 615         logger.info("value of cldsserviceiNfolist: {}", rawList);
 616         if (rawList != null && !rawList.isEmpty()) {
 617             List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
 618             for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
 619                 if (currCldsSdcServiceInfo != null) {
 620                     invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
 621                         currCldsSdcServiceInfo.getName());
 622                 }
 623             }
 624             serviceNode.putPOJO("service", invariantIdServiceNode);
 625         }
 626         return serviceNode.toString();
 627     }
 628
 629     private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
 630         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 631         SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
 632         ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
 633         if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
 634             /**
 635              * to create json with vf, alarm and locations
 636              */
 637             ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
 638             ObjectNode vfObjectNode = mapper.createObjectNode();
 639             /**
 640              * to create json with vf and vfresourceId
 641              */
 642             createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
 643             serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
 644             ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
 645             byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
 646             /**
 647              * to create json with VFC Node
 648              */
 649             ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
 650             byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
 651             globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
 652             logger.info("valuie of objNode: {}", globalPropsJson);
 653         }
 654         return globalPropsJson.toString();
 655     }
 656
 657     private ObjectNode createEmptyVfAlarmObject() {
 658         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 659         ObjectNode emptyObjectNode = mapper.createObjectNode();
 660         emptyObjectNode.put("", "");
 661         ObjectNode vfObjectNode = mapper.createObjectNode();
 662         vfObjectNode.putPOJO("vf", emptyObjectNode);
 663         vfObjectNode.putPOJO("location", emptyObjectNode);
 664         vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
 665         ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
 666         emptyServiceObjectNode.putPOJO("", vfObjectNode);
 667         return emptyServiceObjectNode;
 668     }
 669
 670     private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
 671         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 672         ObjectNode vfNode = mapper.createObjectNode();
 673         vfNode.put("", "");
 674         // To remove repeated resource instance name from
 675         // resourceInstanceList
 676         List<SdcResource> cldsSdcResourceList = sdcCatalogServices
 677             .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
 678         /**
 679          * Creating vf resource node using cldsSdcResource Object
 680          */
 681         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 682             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 683                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 684                     vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
 685                 }
 686             }
 687         }
 688         vfObjectNode2.putPOJO("vf", vfNode);
 689         /**
 690          * creating location json object using properties file value
 691          */
 692         ObjectNode locationJsonNode;
 693         try {
 694             locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
 695                 JsonNode.class);
 696         } catch (IOException e) {
 697             logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
 698             throw new CldsConfigException(
 699                 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
 700         }
 701         vfObjectNode2.putPOJO("location", locationJsonNode);
 702         /**
 703          * creating alarm json object using properties file value
 704          */
 705         String alarmStringValue = refProp.getStringValue("ui.alarm.default");
 706         logger.info("value of alarm: {}", alarmStringValue);
 707         ObjectNode alarmStringJsonNode;
 708         try {
 709             alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
 710         } catch (IOException e) {
 711             logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
 712             throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
 713                 e);
 714         }
 715         vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
 716     }
 717
 718     private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
 719         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 720         ObjectNode emptyObjectNode = mapper.createObjectNode();
 721         ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
 722         ObjectNode vfCObjectNode = mapper.createObjectNode();
 723         vfCObjectNode.putPOJO("vfC", emptyObjectNode);
 724         ObjectNode subVfCObjectNode = mapper.createObjectNode();
 725         subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
 726         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 727             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 728                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 729                     vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
 730                 }
 731             }
 732         }
 733         emptyvfcobjectNode.putPOJO("", vfCObjectNode);
 734         return emptyvfcobjectNode;
 735     }
 736
 737     public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
 738         util.entering(request, "CldsService: Deploy model");
 739         Date startTime = new Date();
 740         Boolean errorCase = false;
 741         try {
 742             fillInCldsModel(model);
 743             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
 744             logger.info("PUT bpmnJson={}", bpmnJson);
 745             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 746                 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
 747             isAuthorized(permisionManage);
 748             isAuthorizedForVf(model);
 749             ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
 750                 false, bpmnJson, model.getPropText());
 751             checkForDuplicateServiceVf(modelName, model.getPropText());
 752             String deploymentId = "";
 753             // If model is already deployed then pass same deployment id
 754             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 755                 deploymentId = model.getDeploymentId();
 756             } else {
 757                 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
 758             }
 759             String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
 760                 model.getTypeId(), modelProp.getGlobal().getDeployParameters());
 761             String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(createNewDeploymentStatusUrl);
 762             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 763                 String artifactName = model.getControlName();
 764                 if (artifactName != null) {
 765                     artifactName = artifactName + ".yml";
 766                 }
 767                 DcaeEvent dcaeEvent = new DcaeEvent();
 768                 /* set dcae events */
 769                 dcaeEvent.setArtifactName(artifactName);
 770                 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
 771                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 772                     CldsEvent.ACTION_STATE_RECEIVED, null);
 773                 model.setDeploymentId(deploymentId);
 774                 model.save(cldsDao, getUserId());
 775             } else {
 776                 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 777                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 778                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 779                     "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 780             }
 781             logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
 782             // audit log
 783             LoggingUtils.setTimeContext(startTime, new Date());
 784             auditLogger.info("Deploy model completed");
 785         } catch (Exception e) {
 786             errorCase = true;
 787             logger.error("Exception occured during deployModel", e);
 788         }
 789         if (errorCase) {
 790                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 791             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 792         }
 793         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 794         return new ResponseEntity<>(model, HttpStatus.OK);
 795     }
 796
 797     public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
 798         util.entering(request, "CldsService: Undeploy model");
 799         Date startTime = new Date();
 800         Boolean errorCase = false;
 801         try {
 802             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 803                 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
 804             isAuthorized(permisionManage);
 805             isAuthorizedForVf(model);
 806             String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
 807                 model.getTypeId());
 808             String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(operationStatusUndeployUrl);
 809             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 810                 String artifactName = model.getControlName();
 811                 if (artifactName != null) {
 812                     artifactName = artifactName + ".yml";
 813                 }
 814                 DcaeEvent dcaeEvent = new DcaeEvent();
 815                 // set dcae events
 816                 dcaeEvent.setArtifactName(artifactName);
 817                 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
 818                 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 819                     CldsEvent.ACTION_STATE_RECEIVED, null);
 820                 model.setDeploymentId(null);
 821                 model.save(cldsDao, getUserId());
 822             } else {
 823                 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 824                 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 825                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 826                     "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 827             }
 828             logger.info("Undeploy model (" + modelName + ") succeeded.");
 829             // audit log
 830             LoggingUtils.setTimeContext(startTime, new Date());
 831             auditLogger.info("Undeploy model completed");
 832         } catch (Exception e) {
 833             errorCase = true;
 834             logger.error("Exception occured during unDeployModel", e);
 835         }
 836         if (errorCase) {
 837             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 838             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 839         }
 840         util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 841         return new ResponseEntity<>(model, HttpStatus.OK);
 842     }
 843
 844     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 845         JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
 846         String service = AbstractModelElement.getValueByName(globalNode, "service");
 847         List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
 848         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 849             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 850             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 851                 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
 852                     .get("global");
 853                 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
 854                 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
 855                 if (currentVf != null && !currentVf.isEmpty()) {
 856                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 857                         && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 858                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 859                         + " model, please select different Service/VF.");
 860                     }
 861                 }
 862             }
 863         }
 864     }
 865
 866     private void updateAndInsertNewEvent(String cldsModelName, String cldsControlNamePrfx, CldsEvent event,
 867         String newAction) {
 868         // If model action is in submit/resubmit/distributed and user try
 869         // to save then we are changing action back to create.
 870         if (event != null && (CldsEvent.ACTION_SUBMIT.equalsIgnoreCase(event.getActionCd())
 871             || CldsEvent.ACTION_RESUBMIT.equalsIgnoreCase(event.getActionCd())
 872             || CldsEvent.ACTION_DISTRIBUTE.equalsIgnoreCase(event.getActionCd()))) {
 873             CldsEvent newEvent = new CldsEvent();
 874             newEvent.setUserid(getUserId());
 875             newEvent.setActionCd(newAction);
 876             newEvent.setActionStateCd(CldsEvent.ACTION_STATE_COMPLETED);
 877             cldsDao.insEvent(cldsModelName, cldsControlNamePrfx, null, newEvent);
 878         }
 879     }
 880
 881     // Created for the integration test
 882     public void setLoggingUtil (LoggingUtils utilP) {
 883         util =  utilP;
 884     }
 885 }