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