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