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