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  * 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
  30 import com.google.gson.JsonElement;
  31 import com.google.gson.JsonObject;
  32 import com.google.gson.reflect.TypeToken;
  33 import java.io.IOException;
  34 import java.lang.reflect.Type;
  35 import java.util.Date;
  36 import java.util.List;
  37 import java.util.UUID;
  38
  39 import javax.servlet.http.HttpServletRequest;
  40 import javax.ws.rs.BadRequestException;
  41 import javax.xml.transform.TransformerException;
  42
  43 import org.apache.camel.Produce;
  44 import org.json.simple.parser.ParseException;
  45 import org.onap.clamp.clds.camel.CamelProxy;
  46 import org.onap.clamp.clds.client.DcaeDispatcherServices;
  47 import org.onap.clamp.clds.client.DcaeInventoryServices;
  48 import org.onap.clamp.clds.config.ClampProperties;
  49 import org.onap.clamp.clds.dao.CldsDao;
  50 import org.onap.clamp.clds.exception.policy.PolicyClientException;
  51 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
  52 import org.onap.clamp.clds.model.CldsEvent;
  53 import org.onap.clamp.clds.model.CldsInfo;
  54 import org.onap.clamp.clds.model.CldsModel;
  55 import org.onap.clamp.clds.model.CldsModelProp;
  56 import org.onap.clamp.clds.model.CldsMonitoringDetails;
  57 import org.onap.clamp.clds.model.CldsTemplate;
  58 import org.onap.clamp.clds.model.DcaeEvent;
  59 import org.onap.clamp.clds.model.ValueItem;
  60 import org.onap.clamp.clds.model.properties.ModelProperties;
  61 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
  62 import org.onap.clamp.clds.sdc.controller.installer.CsarInstallerImpl;
  63 import org.onap.clamp.clds.transform.XslTransformer;
  64 import org.onap.clamp.clds.util.JsonUtils;
  65 import org.onap.clamp.clds.util.LoggingUtils;
  66 import org.onap.clamp.clds.util.ONAPLogConstants;
  67 import org.slf4j.event.Level;
  68 import org.springframework.beans.factory.annotation.Autowired;
  69 import org.springframework.beans.factory.annotation.Value;
  70 import org.springframework.http.HttpStatus;
  71 import org.springframework.http.ResponseEntity;
  72 import org.springframework.stereotype.Component;
  73 import org.springframework.web.client.HttpClientErrorException;
  74
  75 /**
  76  * Service to save and retrieve the CLDS model attributes.
  77  */
  78 @Component
  79 public class CldsService extends SecureServiceBase {
  80
  81     /**
  82      * The constant LIST_OF_SDC_SERVICE_INFO_TYPE.
  83      */
  84     public static final Type LIST_OF_SDC_SERVICE_INFO_TYPE = new TypeToken<List<SdcServiceInfo>>() {
  85         }.getType();
  86     @Produce(uri = "direct:processSubmit")
  87     private CamelProxy camelProxy;
  88     /**
  89      * The constant securityLogger.
  90      */
  91     protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
  92     /**
  93      * The constant logger.
  94      */
  95     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
  96
  97     /**
  98      * The constant GLOBAL_PROPERTIES_KEY.
  99      */
 100     public static final String GLOBAL_PROPERTIES_KEY = "files.globalProperties";
 101     private final String cldsPermissionTypeClManage;
 102     private final String cldsPermissionTypeClEvent;
 103     private final String cldsPermissionTypeFilterVf;
 104     private final String cldsPermissionInstance;
 105     /**
 106      * The Permission read cl.
 107      */
 108     final SecureServicePermission permissionReadCl;
 109     /**
 110      * The Permission update cl.
 111      */
 112     final SecureServicePermission permissionUpdateCl;
 113     /**
 114      * The Permission read template.
 115      */
 116     final SecureServicePermission permissionReadTemplate;
 117     /**
 118      * The Permission update template.
 119      */
 120     final SecureServicePermission permissionUpdateTemplate;
 121     /**
 122      * The Permission read tosca.
 123      */
 124     final SecureServicePermission permissionReadTosca;
 125     /**
 126      * The Permission update tosca.
 127      */
 128     final SecureServicePermission permissionUpdateTosca;
 129
 130     private final CldsDao cldsDao;
 131     private final XslTransformer cldsBpmnTransformer;
 132     private final ClampProperties refProp;
 133     private final DcaeDispatcherServices dcaeDispatcherServices;
 134     private final DcaeInventoryServices dcaeInventoryServices;
 135     private LoggingUtils util = new LoggingUtils(logger);
 136
 137     @Autowired
 138     private HttpServletRequest request;
 139
 140     /**
 141      * Instantiates a new Clds service.
 142      *
 143      * @param cldsDao                    the clds dao
 144      * @param cldsBpmnTransformer        the clds bpmn transformer
 145      * @param refProp                    the ref prop
 146      * @param dcaeDispatcherServices     the dcae dispatcher services
 147      * @param dcaeInventoryServices      the dcae inventory services
 148      * @param cldsPersmissionTypeCl      the clds persmission type cl
 149      * @param cldsPermissionTypeClManage the clds permission type cl manage
 150      * @param cldsPermissionTypeClEvent  the clds permission type cl event
 151      * @param cldsPermissionTypeFilterVf the clds permission type filter vf
 152      * @param cldsPermissionTypeTemplate the clds permission type template
 153      * @param cldsPermissionTypeTosca    the clds permission type tosca
 154      * @param cldsPermissionInstance     the clds permission instance
 155      */
 156     @Autowired
 157     public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
 158         DcaeDispatcherServices dcaeDispatcherServices,
 159         DcaeInventoryServices dcaeInventoryServices,
 160         @Value("${clamp.config.security.permission.type.cl:permission-type-cl}")
 161                                    String cldsPersmissionTypeCl,
 162         @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}")
 163                                    String cldsPermissionTypeClManage,
 164         @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}")
 165                                    String cldsPermissionTypeClEvent,
 166         @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}")
 167                                    String cldsPermissionTypeFilterVf,
 168         @Value("${clamp.config.security.permission.type.template:permission-type-template}")
 169                                    String cldsPermissionTypeTemplate,
 170         @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}")
 171                                    String cldsPermissionTypeTosca,
 172         @Value("${clamp.config.security.permission.instance:dev}")
 173                                    String cldsPermissionInstance) {
 174         this.cldsDao = cldsDao;
 175         this.cldsBpmnTransformer = cldsBpmnTransformer;
 176         this.refProp = refProp;
 177         this.dcaeDispatcherServices = dcaeDispatcherServices;
 178         this.dcaeInventoryServices = dcaeInventoryServices;
 179         this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
 180         this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
 181         this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
 182         this.cldsPermissionInstance = cldsPermissionInstance;
 183         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 184         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 185         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 186             "read");
 187         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 188             "update");
 189         permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
 190         permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
 191             "update");
 192     }
 193
 194     /**
 195      * Gets clds details.
 196      * list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
 197      * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
 198      * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
 199      * from the DCAE application when the ClosedLoop is submitted
 200      * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
 201      * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
 202      * used to generate the ClosedLoop model. ACTION_CD | Current state of the
 203      * ClosedLoop in CLDS application.
 204      * @return the clds details
 205      */
 206     public List<CldsMonitoringDetails> getCldsDetails() {
 207         util.entering(request, "CldsService: GET model details");
 208         Date startTime = new Date();
 209         List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCldsMonitoringDetails();
 210         // audit log
 211         LoggingUtils.setTimeContext(startTime, new Date());
 212         auditLogger.info("GET cldsDetails completed");
 213         util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 214         return cldsMonitoringDetailsList;
 215     }
 216
 217     /**
 218      * Gets clds info.
 219      * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
 220      * is currently installed from pom.xml file 3. User permissions
 221      * @return the clds info
 222      */
 223     public CldsInfo getCldsInfo() {
 224         util.entering(request, "CldsService: GET cldsInfo");
 225         Date startTime = new Date();
 226         LoggingUtils.setTimeContext(startTime, new Date());
 227
 228         CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
 229         CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
 230
 231         // audit log
 232         LoggingUtils.setTimeContext(startTime, new Date());
 233         securityLogger.info("GET cldsInfo completed");
 234         util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 235         return cldsInfo;
 236     }
 237
 238     /**
 239      * REST service that retrieves BPMN for a CLDS model name from the database.
 240      * This is subset of the json getModel. This is only expected to be used for
 241      * testing purposes, not by the UI.
 242      *
 243      * @param modelName the model name
 244      * @return bpmn xml text - content of bpmn given name
 245      */
 246     public String getBpmnXml(String modelName) {
 247         util.entering(request, "CldsService: GET model bpmn");
 248         Date startTime = new Date();
 249         isAuthorized(permissionReadCl);
 250         logger.info("GET bpmnText for modelName={}", modelName);
 251         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 252         // audit log
 253         LoggingUtils.setTimeContext(startTime, new Date());
 254         auditLogger.info("GET model bpmn completed");
 255         util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 256         return model.getBpmnText();
 257     }
 258
 259     /**
 260      * REST service that retrieves image for a CLDS model name from the database.
 261      * This is subset of the json getModel. This is only expected to be used for
 262      * testing purposes, not by the UI.
 263      *
 264      * @param modelName the model name
 265      * @return image xml text - content of image given name
 266      */
 267     public String getImageXml(String modelName) {
 268         util.entering(request, "CldsService: GET model image");
 269         Date startTime = new Date();
 270         isAuthorized(permissionReadCl);
 271         logger.info("GET imageText for modelName={}", modelName);
 272         CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
 273         // audit log
 274         LoggingUtils.setTimeContext(startTime, new Date());
 275         auditLogger.info("GET model image completed");
 276         util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 277         return model.getImageText();
 278     }
 279
 280     /**
 281      * REST service that retrieves a CLDS model by name from the database.
 282      *
 283      * @param modelName the model name
 284      * @return clds model - clds model for the given model name
 285      */
 286     public CldsModel getModel(String modelName) {
 287         util.entering(request, "CldsService: GET model");
 288         Date startTime = new Date();
 289         isAuthorized(permissionReadCl);
 290         logger.debug("GET model for  modelName={}", modelName);
 291         CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
 292         isAuthorizedForVf(cldsModel);
 293         // Try an update for DCAE status
 294         // Checking condition whether our CLDS model can call Inventory Method
 295         try {
 296             // Method to call dcae inventory and invoke insert event method
 297             if (cldsModel.canDcaeInventoryCall()
 298                 && !cldsModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
 299                 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
 300             }
 301             // This is a blocking call
 302             if (cldsModel.getEvent().isActionCd(CldsEvent.ACTION_DEPLOY)
 303                 && !CldsModel.STATUS_ACTIVE.equals(cldsModel.getStatus()) && cldsModel.getDeploymentId() != null
 304                 && cldsModel.getDeploymentStatusUrl() != null) {
 305                 checkDcaeDeploymentStatus(cldsModel, CldsEvent.ACTION_DEPLOY, false);
 306                 // Refresh the model object in any cases for new event
 307                 cldsModel = CldsModel.retrieve(cldsDao, cldsModel.getName(), false);
 308             }
 309         } catch (Exception e) {
 310             LoggingUtils.setErrorContext("900", "Set event inventory error");
 311             logger.error("getModel set event Inventory error:" + e);
 312         }
 313         // audit log
 314         LoggingUtils.setTimeContext(startTime, new Date());
 315         auditLogger.info("GET model completed");
 316         util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 317         return cldsModel;
 318     }
 319
 320     /**
 321      * REST service that saves a CLDS model by name in the database.
 322      *
 323      * @param modelName the model name
 324      * @param cldsModel the clds model
 325      * @return the clds model
 326      */
 327     public CldsModel putModel(String modelName, CldsModel cldsModel) {
 328         util.entering(request, "CldsService: PUT model");
 329         Date startTime = new Date();
 330         isAuthorized(permissionUpdateCl);
 331         isAuthorizedForVf(cldsModel);
 332         logger.info("PUT model for  modelName={}", modelName);
 333         logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
 334         logger.info("PUT propText={}", cldsModel.getPropText());
 335         logger.info("PUT imageText={}", cldsModel.getImageText());
 336         fillInCldsModel(cldsModel);
 337         cldsModel.save(cldsDao, getUserId());
 338
 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         Date startTime = new Date();
 354         isAuthorized(permissionReadCl);
 355         logger.info("GET list of model names");
 356         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         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             String prop = model.getPropText();
 416             String bpmn = model.getBpmnText();
 417             String docText = model.getDocText();
 418             String controlName = model.getControlName();
 419             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         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() + " artifactName=" + dcaeEvent.getArtifactName()
 496             + " instance count=" + instanceCount + " isTest=" + isTest;
 497         logger.info("POST dcae event {}", msgInfo);
 498         if (isTest) {
 499             logger.warn("Ignorning test event from DCAE");
 500         } else {
 501             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 502                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 503             } else {
 504                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 505                     CldsEvent.ACTION_STATE_RECEIVED, null);
 506             }
 507         }
 508         // audit log
 509         LoggingUtils.setTimeContext(startTime, new Date());
 510         auditLogger.info("Post dcae event completed");
 511         util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 512         return msgInfo;
 513     }
 514
 515     /**
 516      * REST service that retrieves total properties required by UI.
 517      *
 518      * @return the sdc properties
 519      * @throws IOException In case of issues
 520      */
 521     public String getSdcProperties() throws IOException {
 522         return refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY).toString();
 523     }
 524
 525
 526     /**
 527      * Determine if the user is authorized for a particular VF by its invariant
 528      * UUID.
 529      *
 530      * @param vfInvariantUuid the vf invariant uuid
 531      * @return boolean or throws NotAuthorizedException
 532      */
 533     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 534         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 535             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 536                 cldsPermissionInstance, vfInvariantUuid);
 537             return isAuthorized(permission);
 538         } else {
 539             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 540             // VF filtering is turned off
 541             logger.warn("VF filtering turned off");
 542             return true;
 543         }
 544     }
 545
 546     /**
 547      * Determine if the user is authorized for a particular VF by its invariant
 548      * UUID. If not authorized, then NotAuthorizedException is thrown.
 549      *
 550      * @param model The clds model
 551      * @return boolean or throws NotAuthorizedException
 552      */
 553     private boolean isAuthorizedForVf(CldsModel model) {
 554         String vf = ModelProperties.getVf(model);
 555         if (vf == null || vf.length() == 0) {
 556             logger.info("VF not found in model");
 557             return true;
 558         } else {
 559             return isAuthorizedForVf(vf);
 560         }
 561     }
 562
 563     /**
 564      * Deploy model response entity.
 565      *
 566      * @param modelName the model name
 567      * @param model     the model
 568      * @return the response entity
 569      */
 570     public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
 571         util.entering(request, "CldsService: Deploy model");
 572         Date startTime = new Date();
 573         String errorMessage = "";
 574         try {
 575             fillInCldsModel(model);
 576             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
 577             logger.info("PUT bpmnJson={}", bpmnJson);
 578             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 579                 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
 580             isAuthorized(permisionManage);
 581             isAuthorizedForVf(model);
 582             ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
 583                 false, bpmnJson, model.getPropText());
 584             checkForDuplicateServiceVf(modelName, model.getPropText());
 585             String deploymentId = "";
 586             // If model is already deployed then pass same deployment id
 587             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 588                 deploymentId = model.getDeploymentId();
 589             } else {
 590                 model.setDeploymentId(deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId");
 591             }
 592             model.setDeploymentStatusUrl(dcaeDispatcherServices.createNewDeployment(deploymentId, model.getTypeId(),
 593                 modelProp.getGlobal().getDeployParameters()));
 594             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_DEPLOY,
 595                 CldsEvent.ACTION_STATE_INITIATED, null);
 596             model.save(cldsDao, getUserId());
 597             // This is a blocking call
 598             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_DEPLOY, true);
 599             // Refresh the model object in any cases for new event
 600             model = CldsModel.retrieve(cldsDao, model.getName(), false);
 601             // audit log
 602             LoggingUtils.setTimeContext(startTime, new Date());
 603             auditLogger.info("Deploy model completed");
 604         } catch (Exception e) {
 605             errorMessage = e.getMessage();
 606             logger.error("Exception occured during deployModel", e);
 607         }
 608         if (!errorMessage.isEmpty()) {
 609             model.setErrorMessageForUi(errorMessage);
 610             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
 611                 ONAPLogConstants.ResponseStatus.ERROR);
 612             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 613         } else {
 614             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 615             return new ResponseEntity<>(model, HttpStatus.OK);
 616         }
 617     }
 618
 619     /**
 620      * Un deploy model response entity.
 621      *
 622      * @param modelName the model name
 623      * @param model     the model
 624      * @return the response entity
 625      */
 626     public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
 627         util.entering(request, "CldsService: Undeploy model");
 628         Date startTime = new Date();
 629         String errorMessage = "";
 630         try {
 631             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 632                 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
 633             isAuthorized(permisionManage);
 634             isAuthorizedForVf(model);
 635             model.setDeploymentStatusUrl(
 636                 dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(), model.getTypeId()));
 637             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_UNDEPLOY,
 638                 CldsEvent.ACTION_STATE_INITIATED, null);
 639             // clean the deployment ID
 640             model.setDeploymentId(null);
 641             model.save(cldsDao, getUserId());
 642             // This is a blocking call
 643             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_UNDEPLOY, true);
 644             // Refresh the model object in any cases for new event
 645             model = CldsModel.retrieve(cldsDao, model.getName(), false);
 646             // audit log
 647             LoggingUtils.setTimeContext(startTime, new Date());
 648             auditLogger.info("Undeploy model completed");
 649         } catch (Exception e) {
 650             errorMessage = e.getMessage();
 651             logger.error("Exception occured during unDeployModel", e);
 652         }
 653         if (!errorMessage.isEmpty()) {
 654             model.setErrorMessageForUi(errorMessage);
 655             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
 656                 ONAPLogConstants.ResponseStatus.ERROR);
 657             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 658         } else {
 659             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 660             return new ResponseEntity<>(model, HttpStatus.OK);
 661         }
 662     }
 663
 664     private void checkDcaeDeploymentStatus(CldsModel model, String cldsEvent, boolean withRetry)
 665         throws InterruptedException {
 666         String operationStatus = withRetry
 667             ? dcaeDispatcherServices.getOperationStatusWithRetry(model.getDeploymentStatusUrl())
 668             : dcaeDispatcherServices.getOperationStatus(model.getDeploymentStatusUrl());
 669         if ("succeeded".equalsIgnoreCase(operationStatus)) {
 670             logger.info(cldsEvent + " model (" + model.getName() + ") succeeded...Deployment Id is - "
 671                 + model.getDeploymentId());
 672             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent,
 673                 CldsEvent.ACTION_STATE_COMPLETED, null);
 674         } else {
 675             String info = "DCAE " + cldsEvent + " (" + model.getName() + ") failed...Operation Status is - "
 676                 + operationStatus;
 677             logger.info(info);
 678             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent, CldsEvent.ACTION_STATE_ERROR,
 679                 null);
 680             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DCAE operation(" + cldsEvent + ") failed",
 681                 Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 682             throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR, info);
 683         }
 684     }
 685
 686     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 687         JsonElement globalNode = JsonUtils.GSON.fromJson(modelPropText, JsonObject.class).get("global");
 688         String service = JsonUtils.getStringValueByName(globalNode, "service");
 689         List<String> resourceVf = JsonUtils.getStringValuesByName(globalNode, "vf");
 690         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 691             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 692             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 693                 JsonElement currentNode = JsonUtils.GSON
 694                     .fromJson(cldsModelProp.getPropText(), JsonObject.class)
 695                     .get("global");
 696                 String currentService = JsonUtils.getStringValueByName(currentNode, "service");
 697                 List<String> currentVf = JsonUtils.getStringValuesByName(currentNode, "vf");
 698                 if (currentVf != null && !currentVf.isEmpty()) {
 699                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 700                         && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 701                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 702                             + " model, please select different Service/VF.");
 703                     }
 704                 }
 705             }
 706         }
 707     }
 708
 709     /**
 710      * Sets logging util.
 711      *
 712      * @param utilP the util p
 713      */
 714     // Created for the integration test
 715     public void setLoggingUtil(LoggingUtils utilP) {
 716         util = utilP;
 717     }
 718 }