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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Modifications Copyright (c) 2019 Samsung
   9  * ================================================================================
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  * ============LICENSE_END============================================
  22  * Modifications copyright (c) 2018 Nokia
  23  * ===================================================================
  24  *
  25  */
  26
  27 package org.onap.clamp.clds.service;
  28
  29 import com.att.eelf.configuration.EELFLogger;
  30 import com.att.eelf.configuration.EELFManager;
  31 import com.google.gson.JsonElement;
  32 import com.google.gson.JsonObject;
  33 import com.google.gson.reflect.TypeToken;
  34 import java.io.IOException;
  35 import java.lang.reflect.Type;
  36 import java.util.Date;
  37 import java.util.List;
  38 import java.util.UUID;
  39 import javax.servlet.http.HttpServletRequest;
  40 import javax.ws.rs.BadRequestException;
  41 import javax.xml.transform.TransformerException;
  42 import org.apache.camel.Produce;
  43 import org.json.simple.parser.ParseException;
  44 import org.onap.clamp.clds.camel.CamelProxy;
  45 import org.onap.clamp.clds.client.DcaeDispatcherServices;
  46 import org.onap.clamp.clds.client.DcaeInventoryServices;
  47 import org.onap.clamp.clds.config.ClampProperties;
  48 import org.onap.clamp.clds.dao.CldsDao;
  49 import org.onap.clamp.clds.exception.policy.PolicyClientException;
  50 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
  51 import org.onap.clamp.clds.model.CldsEvent;
  52 import org.onap.clamp.clds.model.CldsInfo;
  53 import org.onap.clamp.clds.model.CldsModel;
  54 import org.onap.clamp.clds.model.CldsModelProp;
  55 import org.onap.clamp.clds.model.CldsMonitoringDetails;
  56 import org.onap.clamp.clds.model.CldsTemplate;
  57 import org.onap.clamp.clds.model.DcaeEvent;
  58 import org.onap.clamp.clds.model.ValueItem;
  59 import org.onap.clamp.clds.model.properties.ModelProperties;
  60 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
  61 import org.onap.clamp.clds.sdc.controller.installer.CsarInstaller;
  62 import org.onap.clamp.clds.transform.XslTransformer;
  63 import org.onap.clamp.clds.util.JsonUtils;
  64 import org.onap.clamp.clds.util.LoggingUtils;
  65 import org.onap.clamp.clds.util.ONAPLogConstants;
  66 import org.slf4j.event.Level;
  67 import org.springframework.beans.factory.annotation.Autowired;
  68 import org.springframework.beans.factory.annotation.Value;
  69 import org.springframework.http.HttpStatus;
  70 import org.springframework.http.ResponseEntity;
  71 import org.springframework.stereotype.Component;
  72 import org.springframework.web.client.HttpClientErrorException;
  73
  74 /**
  75  * Service to save and retrieve the CLDS model attributes.
  76  */
  77 @Component
  78 public class CldsService extends SecureServiceBase {
  79
  80     /**
  81      * The constant LIST_OF_SDC_SERVICE_INFO_TYPE.
  82      */
  83     public static final Type LIST_OF_SDC_SERVICE_INFO_TYPE = new TypeToken<List<SdcServiceInfo>>() {
  84         }.getType();
  85     @Produce(uri = "direct:processSubmit")
  86     private CamelProxy camelProxy;
  87     /**
  88      * The constant securityLogger.
  89      */
  90     protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
  91     /**
  92      * The constant logger.
  93      */
  94     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
  95
  96     /**
  97      * The constant GLOBAL_PROPERTIES_KEY.
  98      */
  99     public static final String GLOBAL_PROPERTIES_KEY = "files.globalProperties";
 100     private final String cldsPermissionTypeClManage;
 101     private final String cldsPermissionTypeClEvent;
 102     private final String cldsPermissionTypeFilterVf;
 103     private final String cldsPermissionInstance;
 104     /**
 105      * The Permission read cl.
 106      */
 107     final SecureServicePermission permissionReadCl;
 108     /**
 109      * The Permission update cl.
 110      */
 111     final SecureServicePermission permissionUpdateCl;
 112     /**
 113      * The Permission read template.
 114      */
 115     final SecureServicePermission permissionReadTemplate;
 116     /**
 117      * The Permission update template.
 118      */
 119     final SecureServicePermission permissionUpdateTemplate;
 120     /**
 121      * The Permission read tosca.
 122      */
 123     final SecureServicePermission permissionReadTosca;
 124     /**
 125      * The Permission update tosca.
 126      */
 127     final SecureServicePermission permissionUpdateTosca;
 128
 129     private final CldsDao cldsDao;
 130     private final XslTransformer cldsBpmnTransformer;
 131     private final ClampProperties refProp;
 132     private final DcaeDispatcherServices dcaeDispatcherServices;
 133     private final DcaeInventoryServices dcaeInventoryServices;
 134     private LoggingUtils util = new LoggingUtils(logger);
 135
 136     @Autowired
 137     private HttpServletRequest request;
 138
 139     /**
 140      * Instantiates a new Clds service.
 141      *
 142      * @param cldsDao                    the clds dao
 143      * @param cldsBpmnTransformer        the clds bpmn transformer
 144      * @param refProp                    the ref prop
 145      * @param dcaeDispatcherServices     the dcae dispatcher services
 146      * @param dcaeInventoryServices      the dcae inventory services
 147      * @param cldsPersmissionTypeCl      the clds persmission type cl
 148      * @param cldsPermissionTypeClManage the clds permission type cl manage
 149      * @param cldsPermissionTypeClEvent  the clds permission type cl event
 150      * @param cldsPermissionTypeFilterVf the clds permission type filter vf
 151      * @param cldsPermissionTypeTemplate the clds permission type template
 152      * @param cldsPermissionTypeTosca    the clds permission type tosca
 153      * @param cldsPermissionInstance     the clds permission instance
 154      */
 155     @Autowired
 156     public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
 157         DcaeDispatcherServices dcaeDispatcherServices,
 158         DcaeInventoryServices dcaeInventoryServices,
 159         @Value("${clamp.config.security.permission.type.cl:permission-type-cl}")
 160                                    String cldsPersmissionTypeCl,
 161         @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}")
 162                                    String cldsPermissionTypeClManage,
 163         @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}")
 164                                    String cldsPermissionTypeClEvent,
 165         @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}")
 166                                    String cldsPermissionTypeFilterVf,
 167         @Value("${clamp.config.security.permission.type.template:permission-type-template}")
 168                                    String cldsPermissionTypeTemplate,
 169         @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}")
 170                                    String cldsPermissionTypeTosca,
 171         @Value("${clamp.config.security.permission.instance:dev}")
 172                                    String cldsPermissionInstance) {
 173         this.cldsDao = cldsDao;
 174         this.cldsBpmnTransformer = cldsBpmnTransformer;
 175         this.refProp = refProp;
 176         this.dcaeDispatcherServices = dcaeDispatcherServices;
 177         this.dcaeInventoryServices = dcaeInventoryServices;
 178         this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
 179         this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
 180         this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
 181         this.cldsPermissionInstance = cldsPermissionInstance;
 182         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 183         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 184         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 185             "read");
 186         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 187             "update");
 188         permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
 189         permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
 190             "update");
 191     }
 192
 193     /**
 194      * Gets clds details.
 195      * list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
 196      * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
 197      * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
 198      * from the DCAE application when the ClosedLoop is submitted
 199      * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
 200      * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
 201      * used to generate the ClosedLoop model. ACTION_CD | Current state of the
 202      * ClosedLoop in CLDS application.
 203      * @return the clds details
 204      */
 205     public List<CldsMonitoringDetails> getCldsDetails() {
 206         util.entering(request, "CldsService: GET model details");
 207
 208         final Date startTime = new Date();
 209         List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCldsMonitoringDetails();
 210
 211         // audit log
 212         LoggingUtils.setTimeContext(startTime, new Date());
 213         auditLogger.info("GET cldsDetails completed");
 214         util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 215         return cldsMonitoringDetailsList;
 216     }
 217
 218     /**
 219      * Gets clds info.
 220      * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
 221      * is currently installed from pom.xml file 3. User permissions
 222      * @return the clds info
 223      */
 224     public CldsInfo getCldsInfo() {
 225         util.entering(request, "CldsService: GET cldsInfo");
 226         final Date startTime = new Date();
 227         LoggingUtils.setTimeContext(startTime, new Date());
 228
 229         CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
 230         final CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
 231
 232         // audit log
 233         LoggingUtils.setTimeContext(startTime, new Date());
 234         securityLogger.info("GET cldsInfo completed");
 235         util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 236         return cldsInfo;
 237     }
 238
 239     /**
 240      * REST service that retrieves BPMN for a CLDS model name from the database.
 241      * This is subset of the json getModel. This is only expected to be used for
 242      * testing purposes, not by the UI.
 243      *
 244      * @param modelName the model name
 245      * @return bpmn xml text - content of bpmn given name
 246      */
 247     public String getBpmnXml(String modelName) {
 248         util.entering(request, "CldsService: GET model bpmn");
 249         final Date startTime = new Date();
 250         isAuthorized(permissionReadCl);
 251         logger.info("GET bpmnText for modelName={}", modelName);
 252         final CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 253         // audit log
 254         LoggingUtils.setTimeContext(startTime, new Date());
 255         auditLogger.info("GET model bpmn completed");
 256         util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 257         return model.getBpmnText();
 258     }
 259
 260     /**
 261      * REST service that retrieves image for a CLDS model name from the database.
 262      * This is subset of the json getModel. This is only expected to be used for
 263      * testing purposes, not by the UI.
 264      *
 265      * @param modelName the model name
 266      * @return image xml text - content of image given name
 267      */
 268     public String getImageXml(String modelName) {
 269         util.entering(request, "CldsService: GET model image");
 270         final Date startTime = new Date();
 271         isAuthorized(permissionReadCl);
 272         logger.info("GET imageText for modelName={}", modelName);
 273         final CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 274         // audit log
 275         LoggingUtils.setTimeContext(startTime, new Date());
 276         auditLogger.info("GET model image completed");
 277         util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 278         return model.getImageText();
 279     }
 280
 281     /**
 282      * REST service that retrieves a CLDS model by name from the database.
 283      *
 284      * @param modelName the model name
 285      * @return clds model - clds model for the given model name
 286      */
 287     public CldsModel getModel(String modelName) {
 288         util.entering(request, "CldsService: GET model");
 289         final Date startTime = new Date();
 290         isAuthorized(permissionReadCl);
 291         logger.debug("GET model for  modelName={}", modelName);
 292         CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
 293         isAuthorizedForVf(cldsModel);
 294         // Try an update for DCAE status
 295         // Checking condition whether our CLDS model can call Inventory Method
 296         try {
 297             // Method to call dcae inventory and invoke insert event method
 298             if (cldsModel.canDcaeInventoryCall()
 299                 && !cldsModel.getTemplateName().startsWith(CsarInstaller.TEMPLATE_NAME_PREFIX)) {
 300                 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
 301             }
 302             // This is a blocking call
 303             if (cldsModel.getEvent().isActionCd(CldsEvent.ACTION_DEPLOY)
 304                 && !CldsModel.STATUS_ACTIVE.equals(cldsModel.getStatus()) && cldsModel.getDeploymentId() != null
 305                 && cldsModel.getDeploymentStatusUrl() != null) {
 306                 checkDcaeDeploymentStatus(cldsModel, CldsEvent.ACTION_DEPLOY, false);
 307                 // Refresh the model object in any cases for new event
 308                 cldsModel = CldsModel.retrieve(cldsDao, cldsModel.getName(), false);
 309             }
 310         } catch (Exception e) {
 311             LoggingUtils.setErrorContext("900", "Set event inventory error");
 312             logger.error("getModel set event Inventory error:" + e);
 313         }
 314         // audit log
 315         LoggingUtils.setTimeContext(startTime, new Date());
 316         auditLogger.info("GET model completed");
 317         util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 318         return cldsModel;
 319     }
 320
 321     /**
 322      * REST service that saves a CLDS model by name in the database.
 323      *
 324      * @param modelName the model name
 325      * @param cldsModel the clds model
 326      * @return the clds model
 327      */
 328     public CldsModel putModel(String modelName, CldsModel cldsModel) {
 329         util.entering(request, "CldsService: PUT model");
 330         final Date startTime = new Date();
 331         isAuthorized(permissionUpdateCl);
 332         isAuthorizedForVf(cldsModel);
 333         logger.info("PUT model for  modelName={}", modelName);
 334         logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
 335         logger.info("PUT propText={}", cldsModel.getPropText());
 336         logger.info("PUT imageText={}", cldsModel.getImageText());
 337         fillInCldsModel(cldsModel);
 338         cldsModel.save(cldsDao, getUserId());
 339         // audit log
 340         LoggingUtils.setTimeContext(startTime, new Date());
 341         auditLogger.info("PUT model completed");
 342         util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 343         return cldsModel;
 344     }
 345
 346     /**
 347      * REST service that retrieves a list of CLDS model names.
 348      *
 349      * @return model names in JSON
 350      */
 351     public List<ValueItem> getModelNames() {
 352         util.entering(request, "CldsService: GET model names");
 353         final Date startTime = new Date();
 354         isAuthorized(permissionReadCl);
 355         logger.info("GET list of model names");
 356         final List<ValueItem> names = cldsDao.getModelNames();
 357         // audit log
 358         LoggingUtils.setTimeContext(startTime, new Date());
 359         auditLogger.info("GET model names completed");
 360         util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 361         return names;
 362     }
 363
 364     private void fillInCldsModel(CldsModel model) {
 365         if (model.getTemplateName() != null) {
 366             CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 367             if (template != null) {
 368                 model.setTemplateId(template.getId());
 369                 model.setDocText(template.getPropText());
 370                 // This is to provide the Bpmn XML when Template part in UI
 371                 // is
 372                 // disabled
 373                 model.setBpmnText(template.getBpmnText());
 374             }
 375         }
 376     }
 377
 378     /**
 379      * REST service that saves and processes an action for a CLDS model by name.
 380      *
 381      * @param action    the action
 382      * @param modelName the model name
 383      * @param test      the test
 384      * @param model     the model
 385      * @return response entity
 386      * @throws TransformerException In case of issues when doing the XSLT of the BPMN flow
 387      * @throws ParseException       In case of issues when parsing the JSON
 388      */
 389     public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
 390         throws TransformerException, ParseException {
 391         util.entering(request, "CldsService: Process model action");
 392         final Date startTime = new Date();
 393         String errorMessage = "";
 394         String actionCd = "";
 395         try {
 396             actionCd = action.toUpperCase();
 397             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 398                 cldsPermissionInstance, actionCd);
 399             isAuthorized(permisionManage);
 400             isAuthorizedForVf(model);
 401             String userId = getUserId();
 402             logger.info("PUT actionCd={}", actionCd);
 403             logger.info("PUT modelName={}", modelName);
 404             logger.info("PUT test={}", test);
 405             logger.info("PUT bpmnText={}", model.getBpmnText());
 406             logger.info("PUT propText={}", model.getPropText());
 407             logger.info("PUT userId={}", userId);
 408             logger.info("PUT getTypeId={}", model.getTypeId());
 409             logger.info("PUT deploymentId={}", model.getDeploymentId());
 410             this.fillInCldsModel(model);
 411             // save model to db just in case
 412             model.save(cldsDao, getUserId());
 413
 414             // get vars and format if necessary
 415             final String prop = model.getPropText();
 416             final String bpmn = model.getBpmnText();
 417             final String docText = model.getDocText();
 418             final String controlName = model.getControlName();
 419             final String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
 420             logger.info("PUT bpmnJson={}", bpmnJson);
 421             // Test flag coming from UI or from Clamp config
 422             boolean isTest = Boolean.parseBoolean(test)
 423                 || Boolean.parseBoolean(refProp.getStringValue("action.test.override"));
 424             logger.info("PUT isTest={}", isTest);
 425             boolean isInsertTestEvent = Boolean.parseBoolean(refProp.getStringValue("action.insert.test.event"));
 426             logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
 427             // determine if requested action is permitted
 428             model.validateAction(actionCd);
 429             logger.info("modelProp - " + prop);
 430             logger.info("docText - " + docText);
 431             try {
 432                 String result = camelProxy.executeAction(actionCd, prop, bpmnJson, modelName, controlName, docText,
 433                     isTest, userId, isInsertTestEvent, model.getEvent().getActionCd());
 434                 logger.info("Starting Camel flow on request, result is: ", result);
 435             } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
 436                 logger.error("Exception occured during invoking Camel process", e);
 437                 errorMessage = e.getMessage();
 438             }
 439             // audit log
 440             LoggingUtils.setTimeContext(startTime, new Date());
 441             auditLogger.info("Process model action completed");
 442         } catch (Exception e) {
 443             logger.error("Exception occured during putModelAndProcessAction", e);
 444             errorMessage = e.getMessage();
 445         }
 446
 447         if (null == errorMessage || (null != errorMessage && !errorMessage.isEmpty())) {
 448             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), actionCd, CldsEvent.ACTION_STATE_ERROR,
 449                 null);
 450             // Need a refresh as new events have been inserted
 451             model = CldsModel.retrieve(cldsDao, modelName, false);
 452             if (null == errorMessage) {
 453                 errorMessage = "No response from Policy";
 454             }
 455             model.setErrorMessageForUi(errorMessage);
 456             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
 457                 ONAPLogConstants.ResponseStatus.ERROR);
 458             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 459         } else {
 460             // Need a refresh as new events have been inserted, could have been deleted so
 461             // not blocking call
 462             model = CldsModel.retrieve(cldsDao, modelName, true);
 463             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 464             return new ResponseEntity<>(model, HttpStatus.OK);
 465         }
 466     }
 467
 468     /**
 469      * REST service that accepts events for a model.
 470      *
 471      * @param test      the test
 472      * @param dcaeEvent the dcae event
 473      * @return the string
 474      */
 475     public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
 476         util.entering(request, "CldsService: Post dcae event");
 477         final Date startTime = new Date();
 478         String userid = null;
 479         // TODO: allow auth checking to be turned off by removing the permission
 480         // type property
 481         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 482             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 483                 cldsPermissionInstance, dcaeEvent.getEvent());
 484             isAuthorized(permissionEvent);
 485             userid = getUserId();
 486         }
 487         // Flag indicates whether it is triggered by Validation Test button from
 488         // UI
 489         boolean isTest = Boolean.parseBoolean(test);
 490         int instanceCount = 0;
 491         if (dcaeEvent.getInstances() != null) {
 492             instanceCount = dcaeEvent.getInstances().size();
 493         }
 494         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 495             + " resourceUUID=" + dcaeEvent.getResourceUUID()
 496                 + " artifactName=" + dcaeEvent.getArtifactName()
 497             + " instance count=" + instanceCount + " isTest=" + isTest;
 498         logger.info("POST dcae event {}", msgInfo);
 499         if (isTest) {
 500             logger.warn("Ignorning test event from DCAE");
 501         } else {
 502             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 503                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 504             } else {
 505                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 506                     CldsEvent.ACTION_STATE_RECEIVED, null);
 507             }
 508         }
 509         // audit log
 510         LoggingUtils.setTimeContext(startTime, new Date());
 511         auditLogger.info("Post dcae event completed");
 512         util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 513         return msgInfo;
 514     }
 515
 516     /**
 517      * REST service that retrieves total properties required by UI.
 518      *
 519      * @return the sdc properties
 520      * @throws IOException In case of issues
 521      */
 522     public String getSdcProperties() throws IOException {
 523         return refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY).toString();
 524     }
 525
 526
 527     /**
 528      * Determine if the user is authorized for a particular VF by its invariant
 529      * UUID.
 530      *
 531      * @param vfInvariantUuid the vf invariant uuid
 532      * @return boolean or throws NotAuthorizedException
 533      */
 534     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 535         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 536             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 537                 cldsPermissionInstance, vfInvariantUuid);
 538             return isAuthorized(permission);
 539         } else {
 540             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 541             // VF filtering is turned off
 542             logger.warn("VF filtering turned off");
 543             return true;
 544         }
 545     }
 546
 547     /**
 548      * Determine if the user is authorized for a particular VF by its invariant
 549      * UUID. If not authorized, then NotAuthorizedException is thrown.
 550      *
 551      * @param model The clds model
 552      * @return boolean or throws NotAuthorizedException
 553      */
 554     private boolean isAuthorizedForVf(CldsModel model) {
 555         String vf = ModelProperties.getVf(model);
 556         if (vf == null || vf.length() == 0) {
 557             logger.info("VF not found in model");
 558             return true;
 559         } else {
 560             return isAuthorizedForVf(vf);
 561         }
 562     }
 563
 564     /**
 565      * Deploy model response entity.
 566      *
 567      * @param modelName the model name
 568      * @param model     the model
 569      * @return the response entity
 570      */
 571     public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
 572         util.entering(request, "CldsService: Deploy model");
 573         final Date startTime = new Date();
 574         String errorMessage = "";
 575         try {
 576             fillInCldsModel(model);
 577             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
 578             logger.info("PUT bpmnJson={}", bpmnJson);
 579             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 580                 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
 581             isAuthorized(permisionManage);
 582             isAuthorizedForVf(model);
 583             ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
 584                 false, bpmnJson, model.getPropText());
 585             checkForDuplicateServiceVf(modelName, model.getPropText());
 586             String deploymentId = "";
 587             // If model is already deployed then pass same deployment id
 588             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 589                 deploymentId = model.getDeploymentId();
 590             } else {
 591                 model.setDeploymentId(deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId");
 592             }
 593             model.setDeploymentStatusUrl(dcaeDispatcherServices.createNewDeployment(deploymentId, model.getTypeId(),
 594                 modelProp.getGlobal().getDeployParameters()));
 595             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_DEPLOY,
 596                 CldsEvent.ACTION_STATE_INITIATED, null);
 597             model.save(cldsDao, getUserId());
 598             // This is a blocking call
 599             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_DEPLOY, true);
 600             // Refresh the model object in any cases for new event
 601             model = CldsModel.retrieve(cldsDao, model.getName(), false);
 602             // audit log
 603             LoggingUtils.setTimeContext(startTime, new Date());
 604             auditLogger.info("Deploy model completed");
 605         } catch (Exception e) {
 606             errorMessage = e.getMessage();
 607             logger.error("Exception occured during deployModel", e);
 608         }
 609         if (!errorMessage.isEmpty()) {
 610             model.setErrorMessageForUi(errorMessage);
 611             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
 612                 ONAPLogConstants.ResponseStatus.ERROR);
 613             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 614         } else {
 615             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 616             return new ResponseEntity<>(model, HttpStatus.OK);
 617         }
 618     }
 619
 620     /**
 621      * Un deploy model response entity.
 622      *
 623      * @param modelName the model name
 624      * @param model     the model
 625      * @return the response entity
 626      */
 627     public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
 628         util.entering(request, "CldsService: Undeploy model");
 629         final Date startTime = new Date();
 630         String errorMessage = "";
 631         try {
 632             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 633                 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
 634             isAuthorized(permisionManage);
 635             isAuthorizedForVf(model);
 636             model.setDeploymentStatusUrl(
 637                 dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(), model.getTypeId()));
 638             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_UNDEPLOY,
 639                 CldsEvent.ACTION_STATE_INITIATED, null);
 640             // clean the deployment ID
 641             model.setDeploymentId(null);
 642             model.save(cldsDao, getUserId());
 643             // This is a blocking call
 644             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_UNDEPLOY, true);
 645             // Refresh the model object in any cases for new event
 646             model = CldsModel.retrieve(cldsDao, model.getName(), false);
 647             // audit log
 648             LoggingUtils.setTimeContext(startTime, new Date());
 649             auditLogger.info("Undeploy model completed");
 650         } catch (Exception e) {
 651             errorMessage = e.getMessage();
 652             logger.error("Exception occured during unDeployModel", e);
 653         }
 654         if (!errorMessage.isEmpty()) {
 655             model.setErrorMessageForUi(errorMessage);
 656             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
 657                 ONAPLogConstants.ResponseStatus.ERROR);
 658             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 659         } else {
 660             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 661             return new ResponseEntity<>(model, HttpStatus.OK);
 662         }
 663     }
 664
 665     private void checkDcaeDeploymentStatus(CldsModel model, String cldsEvent, boolean withRetry)
 666         throws InterruptedException {
 667         String operationStatus = withRetry
 668             ? dcaeDispatcherServices.getOperationStatusWithRetry(model.getDeploymentStatusUrl())
 669             : dcaeDispatcherServices.getOperationStatus(model.getDeploymentStatusUrl());
 670         if ("succeeded".equalsIgnoreCase(operationStatus)) {
 671             logger.info(cldsEvent + " model (" + model.getName() + ") succeeded...Deployment Id is - "
 672                 + model.getDeploymentId());
 673             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent,
 674                 CldsEvent.ACTION_STATE_COMPLETED, null);
 675         } else {
 676             String info = "DCAE " + cldsEvent + " (" + model.getName() + ") failed...Operation Status is - "
 677                 + operationStatus;
 678             logger.info(info);
 679             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent, CldsEvent.ACTION_STATE_ERROR,
 680                 null);
 681             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DCAE operation(" + cldsEvent + ") failed",
 682                 Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 683             throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR, info);
 684         }
 685     }
 686
 687     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 688         JsonElement globalNode = JsonUtils.GSON.fromJson(modelPropText, JsonObject.class).get("global");
 689         String service = JsonUtils.getStringValueByName(globalNode, "service");
 690         List<String> resourceVf = JsonUtils.getStringValuesByName(globalNode, "vf");
 691         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 692             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 693             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 694                 JsonElement currentNode = JsonUtils.GSON
 695                     .fromJson(cldsModelProp.getPropText(), JsonObject.class)
 696                     .get("global");
 697                 String currentService = JsonUtils.getStringValueByName(currentNode, "service");
 698                 List<String> currentVf = JsonUtils.getStringValuesByName(currentNode, "vf");
 699                 if (currentVf != null && !currentVf.isEmpty()) {
 700                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 701                         && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 702                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 703                             + " model, please select different Service/VF.");
 704                     }
 705                 }
 706             }
 707         }
 708     }
 709
 710     /**
 711      * Sets logging util.
 712      *
 713      * @param utilP the util p
 714      */
 715     // Created for the integration test
 716     public void setLoggingUtil(LoggingUtils utilP) {
 717         util = utilP;
 718     }
 719 }