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

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