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         // Try an update for DCAE status
 252         // Checking condition whether our CLDS model can call Inventory Method
 253         try {
 254             // Method to call dcae inventory and invoke insert event method
 255             if (cldsModel.canDcaeInventoryCall()
 256                 && !cldsModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
 257                 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
 258             }
 259             // This is a blocking call
 260             if (cldsModel.getEvent().isActionCd(CldsEvent.ACTION_DEPLOY)
 261                 && !CldsModel.STATUS_ACTIVE.equals(cldsModel.getStatus()) && cldsModel.getDeploymentId() != null
 262                 && cldsModel.getDeploymentStatusUrl() != null) {
 263                 checkDcaeDeploymentStatus(cldsModel, CldsEvent.ACTION_DEPLOY, false);
 264                 // refresh because new event may have been added
 265                 cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
 266             }
 267         } catch (Exception e) {
 268             LoggingUtils.setErrorContext("900", "Set event inventory error");
 269             logger.error("getModel set event Inventory error:" + e);
 270         }
 271         // audit log
 272         LoggingUtils.setTimeContext(startTime, new Date());
 273         auditLogger.info("GET model completed");
 274         util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 275         return cldsModel;
 276     }
 277
 278     /**
 279      * REST service that saves a CLDS model by name in the database.
 280      *
 281      * @param modelName
 282      */
 283     public CldsModel putModel(String modelName, CldsModel cldsModel) {
 284         util.entering(request, "CldsService: PUT model");
 285         Date startTime = new Date();
 286         isAuthorized(permissionUpdateCl);
 287         isAuthorizedForVf(cldsModel);
 288         logger.info("PUT model for  modelName={}", modelName);
 289         logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
 290         logger.info("PUT propText={}", cldsModel.getPropText());
 291         logger.info("PUT imageText={}", cldsModel.getImageText());
 292         fillInCldsModel(cldsModel);
 293         cldsModel.save(cldsDao, getUserId());
 294
 295         // audit log
 296         LoggingUtils.setTimeContext(startTime, new Date());
 297         auditLogger.info("PUT model completed");
 298         util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 299         return cldsModel;
 300     }
 301
 302     /**
 303      * REST service that retrieves a list of CLDS model names.
 304      *
 305      * @return model names in JSON
 306      */
 307     public List<ValueItem> getModelNames() {
 308         util.entering(request, "CldsService: GET model names");
 309         Date startTime = new Date();
 310         isAuthorized(permissionReadCl);
 311         logger.info("GET list of model names");
 312         List<ValueItem> names = cldsDao.getModelNames();
 313         // audit log
 314         LoggingUtils.setTimeContext(startTime, new Date());
 315         auditLogger.info("GET model names completed");
 316         util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 317         return names;
 318     }
 319
 320     private void fillInCldsModel(CldsModel model) {
 321         if (model.getTemplateName() != null) {
 322             CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 323             if (template != null) {
 324                 model.setTemplateId(template.getId());
 325                 model.setDocText(template.getPropText());
 326                 // This is to provide the Bpmn XML when Template part in UI
 327                 // is
 328                 // disabled
 329                 model.setBpmnText(template.getBpmnText());
 330             }
 331         }
 332     }
 333
 334     /**
 335      * REST service that saves and processes an action for a CLDS model by name.
 336      *
 337      * @param action
 338      * @param modelName
 339      * @param validateFlag
 340      * @param model
 341      * @return
 342      * @throws TransformerException
 343      *         In case of issues when doing the XSLT of the BPMN flow
 344      * @throws ParseException
 345      *         In case of issues when parsing the JSON
 346      * @throws GeneralSecurityException
 347      *         In case of issues when decrypting the password
 348      * @throws DecoderException
 349      *         In case of issues with the Hex String decoding
 350      */
 351     public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
 352         throws TransformerException, ParseException {
 353         util.entering(request, "CldsService: Process model action");
 354         Date startTime = new Date();
 355         String errorMessage = "";
 356         String actionCd = "";
 357         try {
 358             actionCd = action.toUpperCase();
 359             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 360                 cldsPermissionInstance, actionCd);
 361             isAuthorized(permisionManage);
 362             isAuthorizedForVf(model);
 363             String userId = getUserId();
 364             logger.info("PUT actionCd={}", actionCd);
 365             logger.info("PUT modelName={}", modelName);
 366             logger.info("PUT test={}", test);
 367             logger.info("PUT bpmnText={}", model.getBpmnText());
 368             logger.info("PUT propText={}", model.getPropText());
 369             logger.info("PUT userId={}", userId);
 370             logger.info("PUT getTypeId={}", model.getTypeId());
 371             logger.info("PUT deploymentId={}", model.getDeploymentId());
 372             this.fillInCldsModel(model);
 373             // save model to db just in case
 374             model.save(cldsDao, getUserId());
 375
 376             // get vars and format if necessary
 377             String prop = model.getPropText();
 378             String bpmn = model.getBpmnText();
 379             String docText = model.getDocText();
 380             String controlName = model.getControlName();
 381             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
 382             logger.info("PUT bpmnJson={}", bpmnJson);
 383             // Test flag coming from UI or from Clamp config
 384             boolean isTest = Boolean.parseBoolean(test)
 385                 || Boolean.parseBoolean(refProp.getStringValue("action.test.override"));
 386             logger.info("PUT isTest={}", isTest);
 387             boolean isInsertTestEvent = Boolean.parseBoolean(refProp.getStringValue("action.insert.test.event"));
 388             logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
 389             // determine if requested action is permitted
 390             model.validateAction(actionCd);
 391             logger.info("modelProp - " + prop);
 392             logger.info("docText - " + docText);
 393             try {
 394                 String result = camelProxy.executeAction(actionCd, prop, bpmnJson, modelName, controlName, docText,
 395                     isTest, userId, isInsertTestEvent, model.getEvent().getActionCd());
 396                 logger.info("Starting Camel flow on request, result is: ", result);
 397             } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
 398                 logger.error("Exception occured during invoking Camel process", e);
 399                 errorMessage = e.getMessage();
 400             }
 401             // audit log
 402             LoggingUtils.setTimeContext(startTime, new Date());
 403             auditLogger.info("Process model action completed");
 404         } catch (Exception e) {
 405             logger.error("Exception occured during putModelAndProcessAction", e);
 406             errorMessage = e.getMessage();
 407         }
 408
 409         if (!errorMessage.isEmpty()) {
 410             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), actionCd, CldsEvent.ACTION_STATE_ERROR,
 411                 null);
 412             // Need a refresh as new events have been inserted
 413             model = CldsModel.retrieve(cldsDao, modelName, false);
 414             model.setErrorMessageForUi(errorMessage);
 415             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
 416                 ONAPLogConstants.ResponseStatus.ERROR);
 417             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 418         } else {
 419             // Need a refresh as new events have been inserted, could have been deleted so
 420             // not blocking call
 421             model = CldsModel.retrieve(cldsDao, modelName, true);
 422             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 423             return new ResponseEntity<>(model, HttpStatus.OK);
 424         }
 425     }
 426
 427     /**
 428      * REST service that accepts events for a model.
 429      *
 430      * @param test
 431      * @param dcaeEvent
 432      */
 433     public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
 434         util.entering(request, "CldsService: Post dcae event");
 435         Date startTime = new Date();
 436         String userid = null;
 437         // TODO: allow auth checking to be turned off by removing the permission
 438         // type property
 439         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 440             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 441                 cldsPermissionInstance, dcaeEvent.getEvent());
 442             isAuthorized(permissionEvent);
 443             userid = getUserId();
 444         }
 445         // Flag indicates whether it is triggered by Validation Test button from
 446         // UI
 447         boolean isTest = Boolean.parseBoolean(test);
 448         int instanceCount = 0;
 449         if (dcaeEvent.getInstances() != null) {
 450             instanceCount = dcaeEvent.getInstances().size();
 451         }
 452         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 453             + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
 454             + " instance count=" + instanceCount + " isTest=" + isTest;
 455         logger.info("POST dcae event {}", msgInfo);
 456         if (isTest) {
 457             logger.warn("Ignorning test event from DCAE");
 458         } else {
 459             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 460                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 461             } else {
 462                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 463                     CldsEvent.ACTION_STATE_RECEIVED, null);
 464             }
 465         }
 466         // audit log
 467         LoggingUtils.setTimeContext(startTime, new Date());
 468         auditLogger.info("Post dcae event completed");
 469         util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 470         return msgInfo;
 471     }
 472
 473     /**
 474      * REST service that retrieves sdc services
 475      *
 476      * @throws GeneralSecurityException
 477      *         In case of issue when decryting the SDC password
 478      * @throws DecoderException
 479      *         In case of issues with the decoding of the Hex String
 480      */
 481     public String getSdcServices() throws GeneralSecurityException, DecoderException {
 482         util.entering(request, "CldsService: GET sdc services");
 483         Date startTime = new Date();
 484         String retStr;
 485         try {
 486             retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
 487         } catch (IOException e) {
 488             logger.error("IOException during SDC communication", e);
 489             throw new SdcCommunicationException("IOException during SDC communication", e);
 490         }
 491         logger.info("value of sdcServices : {}", retStr);
 492         // audit log
 493         LoggingUtils.setTimeContext(startTime, new Date());
 494         auditLogger.info("GET sdc services completed");
 495         util.exiting("200", "Get sdc services success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 496         return retStr;
 497     }
 498
 499     /**
 500      * REST service that retrieves total properties required by UI
 501      *
 502      * @throws IOException
 503      *         In case of issues
 504      */
 505     public String getSdcProperties() throws IOException {
 506         return createPropertiesObjectByUUID("{}");
 507     }
 508
 509     /**
 510      * REST service that retrieves total properties by using invariantUUID based on
 511      * refresh and non refresh
 512      *
 513      * @throws GeneralSecurityException
 514      *         In case of issues with the decryting the encrypted password
 515      * @throws DecoderException
 516      *         In case of issues with the decoding of the Hex String
 517      * @throws IOException
 518      *         In case of issue to convert CldsServiceCache to InputStream
 519      */
 520     public String getSdcPropertiesByServiceUUIDForRefresh(String serviceInvariantUUID, Boolean refresh)
 521         throws GeneralSecurityException, DecoderException, IOException {
 522         util.entering(request, "CldsService: GET sdc properties by uuid");
 523         Date startTime = new Date();
 524         CldsServiceData cldsServiceData = new CldsServiceData();
 525         cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
 526         if (!Optional.ofNullable(refresh).orElse(false)) {
 527             cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
 528         }
 529         if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
 530             cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
 531             cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
 532         }
 533         // filter out VFs the user is not authorized for
 534         cldsServiceData.filterVfs(this);
 535         // format retrieved data into properties json
 536         String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
 537         // audit log
 538         LoggingUtils.setTimeContext(startTime, new Date());
 539         auditLogger.info("GET sdc properties by uuid completed");
 540         util.exiting("200", "Get sdc properties by uuid success", Level.INFO,
 541             ONAPLogConstants.ResponseStatus.COMPLETED);
 542         return sdcProperties;
 543     }
 544
 545     /**
 546      * Determine if the user is authorized for a particular VF by its invariant
 547      * UUID.
 548      *
 549      * @param vfInvariantUuid
 550      * @throws NotAuthorizedException
 551      * @return
 552      */
 553     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 554         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 555             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 556                 cldsPermissionInstance, vfInvariantUuid);
 557             return isAuthorized(permission);
 558         } else {
 559             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 560             // VF filtering is turned off
 561             logger.warn("VF filtering turned off");
 562             return true;
 563         }
 564     }
 565
 566     /**
 567      * Determine if the user is authorized for a particular VF by its invariant
 568      * UUID. If not authorized, then NotAuthorizedException is thrown.
 569      *
 570      * @param model
 571      * @return
 572      */
 573     private boolean isAuthorizedForVf(CldsModel model) {
 574         String vf = ModelProperties.getVf(model);
 575         if (vf == null || vf.length() == 0) {
 576             logger.info("VF not found in model");
 577             return true;
 578         } else {
 579             return isAuthorizedForVf(vf);
 580         }
 581     }
 582
 583     private String createUiServiceFormatJson(String responseStr) throws IOException {
 584         if (StringUtils.isBlank(responseStr)) {
 585             return "";
 586         }
 587         ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
 588         List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
 589             objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
 590         ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
 591         ObjectNode serviceNode = objectMapper.createObjectNode();
 592         logger.info("value of cldsserviceiNfolist: {}", rawList);
 593         if (rawList != null && !rawList.isEmpty()) {
 594             List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
 595             for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
 596                 if (currCldsSdcServiceInfo != null) {
 597                     invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
 598                         currCldsSdcServiceInfo.getName());
 599                 }
 600             }
 601             serviceNode.putPOJO("service", invariantIdServiceNode);
 602         }
 603         return serviceNode.toString();
 604     }
 605
 606     private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
 607         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 608         SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
 609         ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
 610         if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
 611             /**
 612              * to create json with vf, alarm and locations
 613              */
 614             ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
 615             ObjectNode vfObjectNode = mapper.createObjectNode();
 616             /**
 617              * to create json with vf and vfresourceId
 618              */
 619             createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
 620             serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
 621             ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
 622             byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
 623             /**
 624              * to create json with VFC Node
 625              */
 626             ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
 627             byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
 628             globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
 629             logger.info("valuie of objNode: {}", globalPropsJson);
 630         }
 631         return globalPropsJson.toString();
 632     }
 633
 634     private ObjectNode createEmptyVfAlarmObject() {
 635         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 636         ObjectNode emptyObjectNode = mapper.createObjectNode();
 637         emptyObjectNode.put("", "");
 638         ObjectNode vfObjectNode = mapper.createObjectNode();
 639         vfObjectNode.putPOJO("vf", emptyObjectNode);
 640         vfObjectNode.putPOJO("location", emptyObjectNode);
 641         vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
 642         ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
 643         emptyServiceObjectNode.putPOJO("", vfObjectNode);
 644         return emptyServiceObjectNode;
 645     }
 646
 647     private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
 648         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 649         ObjectNode vfNode = mapper.createObjectNode();
 650         vfNode.put("", "");
 651         // To remove repeated resource instance name from
 652         // resourceInstanceList
 653         List<SdcResource> cldsSdcResourceList = sdcCatalogServices
 654             .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
 655         /**
 656          * Creating vf resource node using cldsSdcResource Object
 657          */
 658         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 659             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 660                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 661                     vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
 662                 }
 663             }
 664         }
 665         vfObjectNode2.putPOJO("vf", vfNode);
 666         /**
 667          * creating location json object using properties file value
 668          */
 669         ObjectNode locationJsonNode;
 670         try {
 671             locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
 672                 JsonNode.class);
 673         } catch (IOException e) {
 674             logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
 675             throw new CldsConfigException(
 676                 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
 677         }
 678         vfObjectNode2.putPOJO("location", locationJsonNode);
 679         /**
 680          * creating alarm json object using properties file value
 681          */
 682         String alarmStringValue = refProp.getStringValue("ui.alarm.default");
 683         logger.info("value of alarm: {}", alarmStringValue);
 684         ObjectNode alarmStringJsonNode;
 685         try {
 686             alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
 687         } catch (IOException e) {
 688             logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
 689             throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
 690                 e);
 691         }
 692         vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
 693     }
 694
 695     private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
 696         ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
 697         ObjectNode emptyObjectNode = mapper.createObjectNode();
 698         ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
 699         ObjectNode vfCObjectNode = mapper.createObjectNode();
 700         vfCObjectNode.putPOJO("vfC", emptyObjectNode);
 701         ObjectNode subVfCObjectNode = mapper.createObjectNode();
 702         subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
 703         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 704             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 705                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 706                     vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
 707                 }
 708             }
 709         }
 710         emptyvfcobjectNode.putPOJO("", vfCObjectNode);
 711         return emptyvfcobjectNode;
 712     }
 713
 714     public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
 715         util.entering(request, "CldsService: Deploy model");
 716         Date startTime = new Date();
 717         String errorMessage = "";
 718         try {
 719             fillInCldsModel(model);
 720             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
 721             logger.info("PUT bpmnJson={}", bpmnJson);
 722             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 723                 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
 724             isAuthorized(permisionManage);
 725             isAuthorizedForVf(model);
 726             ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
 727                 false, bpmnJson, model.getPropText());
 728             checkForDuplicateServiceVf(modelName, model.getPropText());
 729             String deploymentId = "";
 730             // If model is already deployed then pass same deployment id
 731             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 732                 deploymentId = model.getDeploymentId();
 733             } else {
 734                 model.setDeploymentId(deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId");
 735             }
 736             model.setDeploymentStatusUrl(dcaeDispatcherServices.createNewDeployment(deploymentId, model.getTypeId(),
 737                 modelProp.getGlobal().getDeployParameters()));
 738             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_DEPLOY,
 739                 CldsEvent.ACTION_STATE_INITIATED, null);
 740             // This is a blocking call
 741             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_DEPLOY, true);
 742
 743             model.save(cldsDao, getUserId());
 744             // audit log
 745             LoggingUtils.setTimeContext(startTime, new Date());
 746             auditLogger.info("Deploy model completed");
 747         } catch (Exception e) {
 748             errorMessage = e.getMessage();
 749             logger.error("Exception occured during deployModel", e);
 750         }
 751         if (!errorMessage.isEmpty()) {
 752             model.setErrorMessageForUi(errorMessage);
 753             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
 754                 ONAPLogConstants.ResponseStatus.ERROR);
 755             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 756         } else {
 757             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 758             return new ResponseEntity<>(model, HttpStatus.OK);
 759         }
 760     }
 761
 762     public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
 763         util.entering(request, "CldsService: Undeploy model");
 764         Date startTime = new Date();
 765         String errorMessage = "";
 766         try {
 767             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 768                 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
 769             isAuthorized(permisionManage);
 770             isAuthorizedForVf(model);
 771             model.setDeploymentStatusUrl(
 772                 dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(), model.getTypeId()));
 773             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_UNDEPLOY,
 774                 CldsEvent.ACTION_STATE_INITIATED, null);
 775             // This is a blocking call
 776             checkDcaeDeploymentStatus(model, CldsEvent.ACTION_UNDEPLOY, true);
 777             // clean the deployment ID
 778             model.setDeploymentId(null);
 779             model.save(cldsDao, getUserId());
 780             // audit log
 781             LoggingUtils.setTimeContext(startTime, new Date());
 782             auditLogger.info("Undeploy model completed");
 783         } catch (Exception e) {
 784             errorMessage = e.getMessage();
 785             logger.error("Exception occured during unDeployModel", e);
 786         }
 787         if (!errorMessage.isEmpty()) {
 788             model.setErrorMessageForUi(errorMessage);
 789             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
 790                 ONAPLogConstants.ResponseStatus.ERROR);
 791             return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
 792         } else {
 793             util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 794             return new ResponseEntity<>(model, HttpStatus.OK);
 795         }
 796     }
 797
 798     private void checkDcaeDeploymentStatus(CldsModel model, String cldsEvent, boolean withRetry)
 799         throws InterruptedException {
 800         String operationStatus = withRetry
 801             ? dcaeDispatcherServices.getOperationStatusWithRetry(model.getDeploymentStatusUrl())
 802             : dcaeDispatcherServices.getOperationStatus(model.getDeploymentStatusUrl());
 803         if ("succeeded".equalsIgnoreCase(operationStatus)) {
 804             logger.info(cldsEvent + " model (" + model.getName() + ") succeeded...Deployment Id is - "
 805                 + model.getDeploymentId());
 806             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent,
 807                 CldsEvent.ACTION_STATE_COMPLETED, null);
 808         } else {
 809             String info = "DCAE " + cldsEvent + " (" + model.getName() + ") failed...Operation Status is - "
 810                 + operationStatus;
 811             logger.info(info);
 812             CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent, CldsEvent.ACTION_STATE_ERROR,
 813                 null);
 814             util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DCAE operation(" + cldsEvent + ") failed",
 815                 Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
 816             throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR, info);
 817         }
 818     }
 819
 820     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 821         JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
 822         String service = AbstractModelElement.getValueByName(globalNode, "service");
 823         List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
 824         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 825             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 826             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 827                 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
 828                     .get("global");
 829                 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
 830                 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
 831                 if (currentVf != null && !currentVf.isEmpty()) {
 832                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 833                         && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 834                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 835                             + " model, please select different Service/VF.");
 836                     }
 837                 }
 838             }
 839         }
 840     }
 841
 842     // Created for the integration test
 843     public void setLoggingUtil(LoggingUtils utilP) {
 844         util = utilP;
 845     }
 846 }