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