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

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