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