src/main/java/org/onap/clamp/clds/service/CldsService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  * ===================================================================
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23
  24 package org.onap.clamp.clds.service;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28 import com.fasterxml.jackson.databind.JsonNode;
  29 import com.fasterxml.jackson.databind.ObjectMapper;
  30 import com.fasterxml.jackson.databind.node.ObjectNode;
  31
  32 import java.io.IOException;
  33 import java.io.InputStream;
  34 import java.security.GeneralSecurityException;
  35 import java.util.ArrayList;
  36 import java.util.Date;
  37 import java.util.List;
  38 import java.util.Properties;
  39 import java.util.UUID;
  40 import java.util.concurrent.TimeUnit;
  41
  42 import javax.annotation.PostConstruct;
  43 import javax.ws.rs.BadRequestException;
  44 import javax.ws.rs.Consumes;
  45 import javax.ws.rs.DefaultValue;
  46 import javax.ws.rs.GET;
  47 import javax.ws.rs.NotAuthorizedException;
  48 import javax.ws.rs.POST;
  49 import javax.ws.rs.PUT;
  50 import javax.ws.rs.Path;
  51 import javax.ws.rs.PathParam;
  52 import javax.ws.rs.Produces;
  53 import javax.ws.rs.QueryParam;
  54 import javax.ws.rs.core.MediaType;
  55 import javax.ws.rs.core.Response;
  56 import javax.xml.transform.TransformerException;
  57
  58 import org.apache.camel.Produce;
  59 import org.apache.commons.codec.DecoderException;
  60 import org.apache.commons.lang3.StringUtils;
  61 import org.json.simple.parser.ParseException;
  62 import org.onap.clamp.clds.camel.CamelProxy;
  63 import org.onap.clamp.clds.client.DcaeDispatcherServices;
  64 import org.onap.clamp.clds.client.DcaeInventoryServices;
  65 import org.onap.clamp.clds.client.req.sdc.SdcCatalogServices;
  66 import org.onap.clamp.clds.config.ClampProperties;
  67 import org.onap.clamp.clds.dao.CldsDao;
  68 import org.onap.clamp.clds.exception.CldsConfigException;
  69 import org.onap.clamp.clds.exception.policy.PolicyClientException;
  70 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
  71 import org.onap.clamp.clds.model.CldsDbServiceCache;
  72 import org.onap.clamp.clds.model.CldsEvent;
  73 import org.onap.clamp.clds.model.CldsHealthCheck;
  74 import org.onap.clamp.clds.model.CldsInfo;
  75 import org.onap.clamp.clds.model.CldsModel;
  76 import org.onap.clamp.clds.model.CldsModelProp;
  77 import org.onap.clamp.clds.model.CldsMonitoringDetails;
  78 import org.onap.clamp.clds.model.CldsServiceData;
  79 import org.onap.clamp.clds.model.CldsTemplate;
  80 import org.onap.clamp.clds.model.DcaeEvent;
  81 import org.onap.clamp.clds.model.ValueItem;
  82 import org.onap.clamp.clds.model.properties.AbstractModelElement;
  83 import org.onap.clamp.clds.model.properties.ModelProperties;
  84 import org.onap.clamp.clds.model.sdc.SdcResource;
  85 import org.onap.clamp.clds.model.sdc.SdcServiceDetail;
  86 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
  87 import org.onap.clamp.clds.transform.XslTransformer;
  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
 124     @PostConstruct
 125     private final void afterConstruction() {
 126         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 127         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 128         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 129                 "read");
 130         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 131                 "update");
 132     }
 133
 134     @Autowired
 135     private CldsDao cldsDao;
 136     @Autowired
 137     private XslTransformer cldsBpmnTransformer;
 138     @Autowired
 139     private ClampProperties refProp;
 140     @Autowired
 141     private SdcCatalogServices sdcCatalogServices;
 142     @Autowired
 143     private DcaeDispatcherServices dcaeDispatcherServices;
 144     @Autowired
 145     private DcaeInventoryServices dcaeInventoryServices;
 146
 147     /*
 148      * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
 149      * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
 150      * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId
 151      * returned from the DCAE application when the ClosedLoop is submitted
 152      * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID |
 153      * Id generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME |
 154      * Template used to generate the ClosedLoop model. ACTION_CD | Current state
 155      * of the ClosedLoop in CLDS application.
 156      */
 157     @GET
 158     @Path("/cldsDetails")
 159     @Produces(MediaType.APPLICATION_JSON)
 160     public List<CldsMonitoringDetails> getCLDSDetails() {
 161         Date startTime = new Date();
 162         LoggingUtils.setRequestContext("CldsService: GET model details", getPrincipalName());
 163         List<CldsMonitoringDetails> cldsMonitoringDetailsList = new ArrayList<CldsMonitoringDetails>();
 164         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     /**
 380      * REST service that saves and processes an action for a CLDS model by name.
 381      *
 382      * @param action
 383      * @param modelName
 384      * @param test
 385      * @param model
 386      * @return
 387      * @throws TransformerException
 388      *             In case of issues when doing the XSLT of the BPMN flow
 389      * @throws ParseException
 390      *             In case of issues when parsing the JSON
 391      * @throws GeneralSecurityException
 392      *             In case of issues when decrypting the password
 393      * @throws DecoderException
 394      *             In case of issues with the Hex String decoding
 395      */
 396     @PUT
 397     @Path("/action/{action}/{modelName}")
 398     @Consumes(MediaType.APPLICATION_JSON)
 399     @Produces(MediaType.APPLICATION_JSON)
 400     public Response putModelAndProcessAction(@PathParam("action") String action,
 401             @PathParam("modelName") String modelName, @QueryParam("test") String test, CldsModel model)
 402             throws TransformerException, ParseException, GeneralSecurityException, DecoderException {
 403         Date startTime = new Date();
 404         CldsModel retrievedModel = null;
 405         Boolean errorCase = false;
 406         try {
 407             LoggingUtils.setRequestContext("CldsService: Process model action", getPrincipalName());
 408             String actionCd = action.toUpperCase();
 409             SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
 410                     cldsPermissionInstance, actionCd);
 411             isAuthorized(permisionManage);
 412             isAuthorizedForVf(model);
 413             String userId = getUserId();
 414             String actionStateCd = CldsEvent.ACTION_STATE_INITIATED;
 415             logger.info("PUT actionCd={}", actionCd);
 416             logger.info("PUT actionStateCd={}", actionStateCd);
 417             logger.info("PUT modelName={}", modelName);
 418             logger.info("PUT test={}", test);
 419             logger.info("PUT bpmnText={}", model.getBpmnText());
 420             logger.info("PUT propText={}", model.getPropText());
 421             logger.info("PUT userId={}", userId);
 422             logger.info("PUT getTypeId={}", model.getTypeId());
 423             logger.info("PUT deploymentId={}", model.getDeploymentId());
 424             if (model.getTemplateName() != null) {
 425                 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 426                 if (template != null) {
 427                     model.setTemplateId(template.getId());
 428                     model.setDocText(template.getPropText());
 429                     // This is to provide the Bpmn XML when Template part in UI is
 430                     // disabled
 431                     model.setBpmnText(template.getBpmnText());
 432                 }
 433             }
 434             // save model to db
 435             model.setName(modelName);
 436             model.save(cldsDao, getUserId());
 437             // get vars and format if necessary
 438             String prop = model.getPropText();
 439             String bpmn = model.getBpmnText();
 440             String docText = model.getDocText();
 441             String controlName = model.getControlName();
 442             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
 443             logger.info("PUT bpmnJson={}", bpmnJson);
 444             // Flag indicates whether it is triggered by Validation Test button from
 445             // UI
 446             boolean isTest = false;
 447             if (test != null && test.equalsIgnoreCase("true")) {
 448                 isTest = true;
 449             } else {
 450                 String actionTestOverride = refProp.getStringValue("action.test.override");
 451                 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
 452                     logger.info("PUT actionTestOverride={}", actionTestOverride);
 453                     logger.info("PUT override test indicator and setting it to true");
 454                     isTest = true;
 455                 }
 456             }
 457             logger.info("PUT isTest={}", isTest);
 458             boolean isInsertTestEvent = false;
 459             String insertTestEvent = refProp.getStringValue("action.insert.test.event");
 460             if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
 461                 isInsertTestEvent = true;
 462             }
 463             logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
 464             // determine if requested action is permitted
 465             model.validateAction(actionCd);
 466             logger.info("modelProp - " + prop);
 467             logger.info("docText - " + docText);
 468             try {
 469                 String result = camelProxy.submit(actionCd, prop, bpmnJson, modelName, controlName, docText, isTest, userId,
 470                         isInsertTestEvent);
 471                 logger.info("Starting Camel flow on request, result is: ", result);
 472             } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
 473                 errorCase = true;
 474                 logger.error("Exception occured during invoking Camel process", e);
 475             }
 476             // refresh model info from db (get fresh event info)
 477             retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
 478             if (!isTest && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
 479                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
 480                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
 481                 // To verify inventory status and modify model status to distribute
 482                 dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
 483                 retrievedModel.save(cldsDao, getUserId());
 484             }
 485             // audit log
 486             LoggingUtils.setTimeContext(startTime, new Date());
 487             LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
 488             auditLogger.info("Process model action completed");
 489         } catch (Exception e) {
 490             errorCase = true;
 491             logger.error("Exception occured during putModelAndProcessAction", e);
 492         }
 493
 494         if (errorCase) {
 495             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(retrievedModel).build();
 496         }
 497         return Response.status(Response.Status.OK).entity(retrievedModel).build();
 498     }
 499
 500     /**
 501      * REST service that accepts events for a model.
 502      *
 503      * @param test
 504      * @param dcaeEvent
 505      */
 506     @POST
 507     @Path("/dcae/event")
 508     @Consumes(MediaType.APPLICATION_JSON)
 509     @Produces(MediaType.APPLICATION_JSON)
 510     public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
 511         Date startTime = new Date();
 512         LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
 513         String userid = null;
 514         // TODO: allow auth checking to be turned off by removing the permission
 515         // type property
 516         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 517             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 518                     cldsPermissionInstance, dcaeEvent.getEvent());
 519             isAuthorized(permissionEvent);
 520             userid = getUserId();
 521         }
 522         // Flag indicates whether it is triggered by Validation Test button from
 523         // UI
 524         boolean isTest = false;
 525         if (test != null && test.equalsIgnoreCase("true")) {
 526             isTest = true;
 527         }
 528         int instanceCount = 0;
 529         if (dcaeEvent.getInstances() != null) {
 530             instanceCount = dcaeEvent.getInstances().size();
 531         }
 532         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 533                 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
 534                 + " instance count=" + instanceCount + " isTest=" + isTest;
 535         logger.info("POST dcae event {}", msgInfo);
 536         if (isTest) {
 537             logger.warn("Ignorning test event from DCAE");
 538         } else {
 539             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 540                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 541             } else {
 542                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 543                         CldsEvent.ACTION_STATE_RECEIVED, null);
 544             }
 545         }
 546         // audit log
 547         LoggingUtils.setTimeContext(startTime, new Date());
 548         LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
 549         auditLogger.info("Post dcae event completed");
 550         return msgInfo;
 551     }
 552
 553     /**
 554      * REST service that retrieves sdc services
 555      *
 556      * @throws GeneralSecurityException
 557      *             In case of issue when decryting the SDC password
 558      * @throws DecoderException
 559      *             In case of issues with the decoding of the Hex String
 560      */
 561     @GET
 562     @Path("/sdc/services")
 563     @Produces(MediaType.APPLICATION_JSON)
 564     public String getSdcServices() throws GeneralSecurityException, DecoderException {
 565         Date startTime = new Date();
 566         LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
 567         String retStr;
 568         String responseStr = sdcCatalogServices.getSdcServicesInformation(null);
 569         try {
 570             retStr = createUiServiceFormatJson(responseStr);
 571         } catch (IOException e) {
 572             logger.error("IOException during SDC communication", e);
 573             throw new SdcCommunicationException("IOException during SDC communication", e);
 574         }
 575         logger.info("value of sdcServices : {}", retStr);
 576         // audit log
 577         LoggingUtils.setTimeContext(startTime, new Date());
 578         LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
 579         auditLogger.info("GET sdc services completed");
 580         return retStr;
 581     }
 582
 583     /**
 584      * REST service that retrieves total properties required by UI
 585      *
 586      * @throws IOException
 587      *             In case of issues
 588      */
 589     @GET
 590     @Path("/properties")
 591     @Produces(MediaType.APPLICATION_JSON)
 592     public String getSdcProperties() throws IOException {
 593         return createPropertiesObjectByUUID("{}");
 594     }
 595
 596     /**
 597      * REST service that retrieves total properties by using invariantUUID based
 598      * on refresh and non refresh
 599      *
 600      * @throws GeneralSecurityException
 601      *             In case of issues with the decryting the encrypted password
 602      * @throws DecoderException
 603      *             In case of issues with the decoding of the Hex String
 604      * @throws IOException
 605      *             In case of issue to convert CldsServiceCache to InputStream
 606      */
 607     @GET
 608     @Path("/properties/{serviceInvariantUUID}")
 609     @Produces(MediaType.APPLICATION_JSON)
 610     public String getSdcPropertiesByServiceUUIDForRefresh(
 611             @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
 612             @DefaultValue("false") @QueryParam("refresh") boolean refresh)
 613             throws GeneralSecurityException, DecoderException, IOException {
 614         Date startTime = new Date();
 615         LoggingUtils.setRequestContext("CldsService: GET sdc properties by uuid", getPrincipalName());
 616         CldsServiceData cldsServiceData = new CldsServiceData();
 617         cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
 618         if (!refresh) {
 619             cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
 620         }
 621         if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
 622             cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
 623             cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
 624         }
 625         // filter out VFs the user is not authorized for
 626         cldsServiceData.filterVfs(this);
 627         // format retrieved data into properties json
 628         String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
 629         // audit log
 630         LoggingUtils.setTimeContext(startTime, new Date());
 631         LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
 632         auditLogger.info("GET sdc properties by uuid completed");
 633         return sdcProperties;
 634     }
 635
 636     /**
 637      * Determine if the user is authorized for a particular VF by its invariant
 638      * UUID.
 639      *
 640      * @param vfInvariantUuid
 641      * @throws NotAuthorizedException
 642      * @return
 643      */
 644     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 645         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 646             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 647                     cldsPermissionInstance, vfInvariantUuid);
 648             return isAuthorized(permission);
 649         } else {
 650             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 651             // VF filtering is turned off
 652             logger.warn("VF filtering turned off");
 653             return true;
 654         }
 655     }
 656
 657     /**
 658      * Determine if the user is authorized for a particular VF by its invariant
 659      * UUID. If not authorized, then NotAuthorizedException is thrown.
 660      *
 661      * @param model
 662      * @return
 663      */
 664     private boolean isAuthorizedForVf(CldsModel model) {
 665         String vf = ModelProperties.getVf(model);
 666         if (vf == null || vf.length() == 0) {
 667             logger.info("VF not found in model");
 668             return true;
 669         } else {
 670             return isAuthorizedForVf(vf);
 671         }
 672     }
 673
 674     private String createUiServiceFormatJson(String responseStr) throws IOException {
 675         if (StringUtils.isBlank(responseStr)) {
 676             return "";
 677         }
 678         ObjectMapper objectMapper = new ObjectMapper();
 679         List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
 680                 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
 681         ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
 682         ObjectNode serviceNode = objectMapper.createObjectNode();
 683         logger.info("value of cldsserviceiNfolist: {}", rawList);
 684         if (rawList != null && !rawList.isEmpty()) {
 685             List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
 686             for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
 687                 if (currCldsSdcServiceInfo != null) {
 688                     invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
 689                             currCldsSdcServiceInfo.getName());
 690                 }
 691             }
 692             serviceNode.putPOJO("service", invariantIdServiceNode);
 693         }
 694         return serviceNode.toString();
 695     }
 696
 697     private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
 698         ObjectMapper mapper = new ObjectMapper();
 699         SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
 700         ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
 701         if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
 702             /**
 703              * to create json with vf, alarm and locations
 704              */
 705             ObjectNode serviceObjectNode = createEmptyVfAlarmObject(mapper);
 706             ObjectNode vfObjectNode = mapper.createObjectNode();
 707             /**
 708              * to create json with vf and vfresourceId
 709              */
 710             createVfObjectNode(vfObjectNode, mapper, cldsSdcServiceDetail.getResources());
 711             serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
 712             ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
 713             byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
 714             /**
 715              * to create json with VFC Node
 716              */
 717             ObjectNode emptyvfcobjectNode = createByVFCObjectNode(mapper, cldsSdcServiceDetail.getResources());
 718             byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
 719             globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
 720             logger.info("valuie of objNode: {}", globalPropsJson);
 721         }
 722         return globalPropsJson.toString();
 723     }
 724
 725     private ObjectNode createEmptyVfAlarmObject(ObjectMapper mapper) {
 726         ObjectNode emptyObjectNode = mapper.createObjectNode();
 727         emptyObjectNode.put("", "");
 728         ObjectNode vfObjectNode = mapper.createObjectNode();
 729         vfObjectNode.putPOJO("vf", emptyObjectNode);
 730         vfObjectNode.putPOJO("location", emptyObjectNode);
 731         vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
 732         ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
 733         emptyServiceObjectNode.putPOJO("", vfObjectNode);
 734         return emptyServiceObjectNode;
 735     }
 736
 737     private void createVfObjectNode(ObjectNode vfObjectNode2, ObjectMapper mapper,
 738             List<SdcResource> rawCldsSdcResourceList) {
 739         ObjectNode vfNode = mapper.createObjectNode();
 740         vfNode.put("", "");
 741         // To remove repeated resource instance name from
 742         // resourceInstanceList
 743         List<SdcResource> cldsSdcResourceList = sdcCatalogServices
 744                 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
 745         /**
 746          * Creating vf resource node using cldsSdcResource Object
 747          */
 748         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 749             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 750                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 751                     vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
 752                 }
 753             }
 754         }
 755         vfObjectNode2.putPOJO("vf", vfNode);
 756         /**
 757          * creating location json object using properties file value
 758          */
 759         ObjectNode locationJsonNode;
 760         try {
 761             locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
 762                     JsonNode.class);
 763         } catch (IOException e) {
 764             logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
 765             throw new CldsConfigException(
 766                     "Unable to load ui.location.default JSON in clds-references.properties properly", e);
 767         }
 768         vfObjectNode2.putPOJO("location", locationJsonNode);
 769         /**
 770          * creating alarm json object using properties file value
 771          */
 772         String alarmStringValue = refProp.getStringValue("ui.alarm.default");
 773         logger.info("value of alarm: {}", alarmStringValue);
 774         ObjectNode alarmStringJsonNode;
 775         try {
 776             alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
 777         } catch (IOException e) {
 778             logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
 779             throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
 780                     e);
 781         }
 782         vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
 783     }
 784
 785     private ObjectNode createByVFCObjectNode(ObjectMapper mapper, List<SdcResource> cldsSdcResourceList) {
 786         ObjectNode emptyObjectNode = mapper.createObjectNode();
 787         ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
 788         ObjectNode vfCObjectNode = mapper.createObjectNode();
 789         vfCObjectNode.putPOJO("vfC", emptyObjectNode);
 790         ObjectNode subVfCObjectNode = mapper.createObjectNode();
 791         subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
 792         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 793             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 794                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 795                     vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
 796                 }
 797             }
 798         }
 799         emptyvfcobjectNode.putPOJO("", vfCObjectNode);
 800         return emptyvfcobjectNode;
 801     }
 802
 803     @PUT
 804     @Path("/deploy/{modelName}")
 805     @Consumes(MediaType.APPLICATION_JSON)
 806     @Produces(MediaType.APPLICATION_JSON)
 807     public Response deployModel(@PathParam("modelName") String modelName,
 808             CldsModel model) {
 809         Date startTime = new Date();
 810         LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
 811         Boolean errorCase = false;
 812         try {
 813             try {
 814                 checkForDuplicateServiceVf(modelName, model.getPropText());
 815             } catch (IOException | BadRequestException e) {
 816                 errorCase = true;
 817                 logger.error("Exception occured during duplicate check for service and VF", e);
 818             }
 819             String deploymentId = "";
 820             // If model is already deployed then pass same deployment id
 821             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 822                 deploymentId = model.getDeploymentId();
 823             } else {
 824                 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
 825             }
 826             String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
 827                     model.getTypeId());
 828             String operationStatus = "processing";
 829             long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
 830             while ("processing".equalsIgnoreCase(operationStatus)) {
 831                 // Break the loop if waiting for more than 10 mins
 832                 if (waitingTime < System.nanoTime()) {
 833                     break;
 834                 }
 835                 operationStatus = dcaeDispatcherServices.getOperationStatus(createNewDeploymentStatusUrl);
 836             }
 837             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 838                 String artifactName = model.getControlName();
 839                 if (artifactName != null) {
 840                     artifactName = artifactName + ".yml";
 841                 }
 842                 DcaeEvent dcaeEvent = new DcaeEvent();
 843                 /* set dcae events */
 844                 dcaeEvent.setArtifactName(artifactName);
 845                 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
 846                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 847                         CldsEvent.ACTION_STATE_RECEIVED, null);
 848                 model.setDeploymentId(deploymentId);
 849                 model.save(cldsDao, getUserId());
 850             } else {
 851                 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 852                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 853                         "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 854             }
 855             logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
 856             // audit log
 857             LoggingUtils.setTimeContext(startTime, new Date());
 858             LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
 859             auditLogger.info("Deploy model completed");
 860         } catch (Exception e) {
 861             errorCase = true;
 862             logger.error("Exception occured during deployModel", e);
 863         }
 864
 865         if (errorCase) {
 866             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
 867         }
 868         return Response.status(Response.Status.OK).entity(model).build();
 869     }
 870
 871     @PUT
 872     @Path("/undeploy/{modelName}")
 873     @Consumes(MediaType.APPLICATION_JSON)
 874     @Produces(MediaType.APPLICATION_JSON)
 875     public Response unDeployModel(@PathParam("modelName") String modelName,
 876             CldsModel model) {
 877         Date startTime = new Date();
 878         LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
 879
 880         Boolean errorCase = false;
 881         try {
 882             String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
 883                     model.getTypeId());
 884             String operationStatus = "processing";
 885             long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
 886             while ("processing".equalsIgnoreCase(operationStatus)) {
 887                 if (waitingTime < System.nanoTime()) {
 888                     break;
 889                 }
 890                 operationStatus = dcaeDispatcherServices.getOperationStatus(operationStatusUndeployUrl);
 891             }
 892             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 893                 String artifactName = model.getControlName();
 894                 if (artifactName != null) {
 895                     artifactName = artifactName + ".yml";
 896                 }
 897                 DcaeEvent dcaeEvent = new DcaeEvent();
 898                 // set dcae events
 899                 dcaeEvent.setArtifactName(artifactName);
 900                 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
 901                 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 902                         CldsEvent.ACTION_STATE_RECEIVED, null);
 903                 model.setDeploymentId(null);
 904                 model.save(cldsDao, getUserId());
 905             } else {
 906                 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 907                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 908                         "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 909             }
 910             logger.info("Undeploy model (" + modelName + ") succeeded.");
 911             // audit log
 912             LoggingUtils.setTimeContext(startTime, new Date());
 913             LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
 914             auditLogger.info("Undeploy model completed");
 915         } catch (Exception e) {
 916             errorCase = true;
 917             logger.error("Exception occured during unDeployModel", e);
 918         }
 919
 920         if (errorCase) {
 921             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
 922         }
 923         return Response.status(Response.Status.OK).entity(model).build();
 924     }
 925
 926     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 927         JsonNode modelJson = new ObjectMapper().readTree(modelPropText);
 928         JsonNode globalNode = modelJson.get("global");
 929         String service = AbstractModelElement.getValueByName(globalNode, "service");
 930         List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
 931         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 932             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 933             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 934                 JsonNode currentJson = new ObjectMapper().readTree(cldsModelProp.getPropText());
 935                 JsonNode currentNode = currentJson.get("global");
 936                 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
 937                 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
 938                 if (currentVf != null && !currentVf.isEmpty()) {
 939                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 940                             && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 941                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 942                                 + " model, please select different Service/VF.");
 943                     }
 944                 }
 945             }
 946         }
 947     }
 948 }