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             String processDefinitionKey = "clds-process-action-wf";
 416             logger.info("PUT actionCd={}", actionCd);
 417             logger.info("PUT actionStateCd={}", actionStateCd);
 418             logger.info("PUT processDefinitionKey={}", processDefinitionKey);
 419             logger.info("PUT modelName={}", modelName);
 420             logger.info("PUT test={}", test);
 421             logger.info("PUT bpmnText={}", model.getBpmnText());
 422             logger.info("PUT propText={}", model.getPropText());
 423             logger.info("PUT userId={}", userId);
 424             logger.info("PUT getTypeId={}", model.getTypeId());
 425             logger.info("PUT deploymentId={}", model.getDeploymentId());
 426             if (model.getTemplateName() != null) {
 427                 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
 428                 if (template != null) {
 429                     model.setTemplateId(template.getId());
 430                     model.setDocText(template.getPropText());
 431                     // This is to provide the Bpmn XML when Template part in UI is
 432                     // disabled
 433                     model.setBpmnText(template.getBpmnText());
 434                 }
 435             }
 436             // save model to db
 437             model.setName(modelName);
 438             model.save(cldsDao, getUserId());
 439             // get vars and format if necessary
 440             String prop = model.getPropText();
 441             String bpmn = model.getBpmnText();
 442             String docText = model.getDocText();
 443             String controlName = model.getControlName();
 444             String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
 445             logger.info("PUT bpmnJson={}", bpmnJson);
 446             // Flag indicates whether it is triggered by Validation Test button from
 447             // UI
 448             boolean isTest = false;
 449             if (test != null && test.equalsIgnoreCase("true")) {
 450                 isTest = true;
 451             } else {
 452                 String actionTestOverride = refProp.getStringValue("action.test.override");
 453                 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
 454                     logger.info("PUT actionTestOverride={}", actionTestOverride);
 455                     logger.info("PUT override test indicator and setting it to true");
 456                     isTest = true;
 457                 }
 458             }
 459             logger.info("PUT isTest={}", isTest);
 460             boolean isInsertTestEvent = false;
 461             String insertTestEvent = refProp.getStringValue("action.insert.test.event");
 462             if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
 463                 isInsertTestEvent = true;
 464             }
 465             logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
 466             // determine if requested action is permitted
 467             model.validateAction(actionCd);
 468             logger.info("modelProp - " + prop);
 469             logger.info("docText - " + docText);
 470             try {
 471                 String result = camelProxy.submit(actionCd, prop, bpmnJson, modelName, controlName, docText, isTest, userId,
 472                         isInsertTestEvent);
 473                 logger.info("Starting Camel flow on request, result is: ", result);
 474             } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
 475                 errorCase = true;
 476                 logger.error("Exception occured during invoking Camel process", e);
 477             }
 478             // refresh model info from db (get fresh event info)
 479             retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
 480             if (!isTest && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
 481                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
 482                     || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
 483                 // To verify inventory status and modify model status to distribute
 484                 dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
 485                 retrievedModel.save(cldsDao, getUserId());
 486             }
 487             // audit log
 488             LoggingUtils.setTimeContext(startTime, new Date());
 489             LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
 490             auditLogger.info("Process model action completed");
 491         } catch (Exception e) {
 492             errorCase = true;
 493             logger.error("Exception occured during putModelAndProcessAction", e);
 494         }
 495
 496         if (errorCase) {
 497             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(retrievedModel).build();
 498         }
 499         return Response.status(Response.Status.OK).entity(retrievedModel).build();
 500     }
 501
 502     /**
 503      * REST service that accepts events for a model.
 504      *
 505      * @param test
 506      * @param dcaeEvent
 507      */
 508     @POST
 509     @Path("/dcae/event")
 510     @Consumes(MediaType.APPLICATION_JSON)
 511     @Produces(MediaType.APPLICATION_JSON)
 512     public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
 513         Date startTime = new Date();
 514         LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
 515         String userid = null;
 516         // TODO: allow auth checking to be turned off by removing the permission
 517         // type property
 518         if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
 519             SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
 520                     cldsPermissionInstance, dcaeEvent.getEvent());
 521             isAuthorized(permissionEvent);
 522             userid = getUserId();
 523         }
 524         // Flag indicates whether it is triggered by Validation Test button from
 525         // UI
 526         boolean isTest = false;
 527         if (test != null && test.equalsIgnoreCase("true")) {
 528             isTest = true;
 529         }
 530         int instanceCount = 0;
 531         if (dcaeEvent.getInstances() != null) {
 532             instanceCount = dcaeEvent.getInstances().size();
 533         }
 534         String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
 535                 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
 536                 + " instance count=" + instanceCount + " isTest=" + isTest;
 537         logger.info("POST dcae event {}", msgInfo);
 538         if (isTest) {
 539             logger.warn("Ignorning test event from DCAE");
 540         } else {
 541             if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
 542                 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
 543             } else {
 544                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
 545                         CldsEvent.ACTION_STATE_RECEIVED, null);
 546             }
 547         }
 548         // audit log
 549         LoggingUtils.setTimeContext(startTime, new Date());
 550         LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
 551         auditLogger.info("Post dcae event completed");
 552         return msgInfo;
 553     }
 554
 555     /**
 556      * REST service that retrieves sdc services
 557      *
 558      * @throws GeneralSecurityException
 559      *             In case of issue when decryting the SDC password
 560      * @throws DecoderException
 561      *             In case of issues with the decoding of the Hex String
 562      */
 563     @GET
 564     @Path("/sdc/services")
 565     @Produces(MediaType.APPLICATION_JSON)
 566     public String getSdcServices() throws GeneralSecurityException, DecoderException {
 567         Date startTime = new Date();
 568         LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
 569         String retStr;
 570         String responseStr = sdcCatalogServices.getSdcServicesInformation(null);
 571         try {
 572             retStr = createUiServiceFormatJson(responseStr);
 573         } catch (IOException e) {
 574             logger.error("IOException during SDC communication", e);
 575             throw new SdcCommunicationException("IOException during SDC communication", e);
 576         }
 577         logger.info("value of sdcServices : {}", retStr);
 578         // audit log
 579         LoggingUtils.setTimeContext(startTime, new Date());
 580         LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
 581         auditLogger.info("GET sdc services completed");
 582         return retStr;
 583     }
 584
 585     /**
 586      * REST service that retrieves total properties required by UI
 587      *
 588      * @throws IOException
 589      *             In case of issues
 590      */
 591     @GET
 592     @Path("/properties")
 593     @Produces(MediaType.APPLICATION_JSON)
 594     public String getSdcProperties() throws IOException {
 595         return createPropertiesObjectByUUID("{}");
 596     }
 597
 598     /**
 599      * REST service that retrieves total properties by using invariantUUID based
 600      * on refresh and non refresh
 601      *
 602      * @throws GeneralSecurityException
 603      *             In case of issues with the decryting the encrypted password
 604      * @throws DecoderException
 605      *             In case of issues with the decoding of the Hex String
 606      * @throws IOException
 607      *             In case of issue to convert CldsServiceCache to InputStream
 608      */
 609     @GET
 610     @Path("/properties/{serviceInvariantUUID}")
 611     @Produces(MediaType.APPLICATION_JSON)
 612     public String getSdcPropertiesByServiceUUIDForRefresh(
 613             @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
 614             @DefaultValue("false") @QueryParam("refresh") boolean refresh)
 615             throws GeneralSecurityException, DecoderException, IOException {
 616         Date startTime = new Date();
 617         LoggingUtils.setRequestContext("CldsService: GET sdc properties by uuid", getPrincipalName());
 618         CldsServiceData cldsServiceData = new CldsServiceData();
 619         cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
 620         if (!refresh) {
 621             cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
 622         }
 623         if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
 624             cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
 625             cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
 626         }
 627         // filter out VFs the user is not authorized for
 628         cldsServiceData.filterVfs(this);
 629         // format retrieved data into properties json
 630         String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
 631         // audit log
 632         LoggingUtils.setTimeContext(startTime, new Date());
 633         LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
 634         auditLogger.info("GET sdc properties by uuid completed");
 635         return sdcProperties;
 636     }
 637
 638     /**
 639      * Determine if the user is authorized for a particular VF by its invariant
 640      * UUID.
 641      *
 642      * @param vfInvariantUuid
 643      * @throws NotAuthorizedException
 644      * @return
 645      */
 646     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 647         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 648             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 649                     cldsPermissionInstance, vfInvariantUuid);
 650             return isAuthorized(permission);
 651         } else {
 652             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 653             // VF filtering is turned off
 654             logger.warn("VF filtering turned off");
 655             return true;
 656         }
 657     }
 658
 659     /**
 660      * Determine if the user is authorized for a particular VF by its invariant
 661      * UUID. If not authorized, then NotAuthorizedException is thrown.
 662      *
 663      * @param model
 664      * @return
 665      */
 666     private boolean isAuthorizedForVf(CldsModel model) {
 667         String vf = ModelProperties.getVf(model);
 668         if (vf == null || vf.length() == 0) {
 669             logger.info("VF not found in model");
 670             return true;
 671         } else {
 672             return isAuthorizedForVf(vf);
 673         }
 674     }
 675
 676     private String createUiServiceFormatJson(String responseStr) throws IOException {
 677         if (StringUtils.isBlank(responseStr)) {
 678             return "";
 679         }
 680         ObjectMapper objectMapper = new ObjectMapper();
 681         List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
 682                 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
 683         ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
 684         ObjectNode serviceNode = objectMapper.createObjectNode();
 685         logger.info("value of cldsserviceiNfolist: {}", rawList);
 686         if (rawList != null && !rawList.isEmpty()) {
 687             List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
 688             for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
 689                 if (currCldsSdcServiceInfo != null) {
 690                     invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
 691                             currCldsSdcServiceInfo.getName());
 692                 }
 693             }
 694             serviceNode.putPOJO("service", invariantIdServiceNode);
 695         }
 696         return serviceNode.toString();
 697     }
 698
 699     private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
 700         ObjectMapper mapper = new ObjectMapper();
 701         SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
 702         ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
 703         if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
 704             /**
 705              * to create json with vf, alarm and locations
 706              */
 707             ObjectNode serviceObjectNode = createEmptyVfAlarmObject(mapper);
 708             ObjectNode vfObjectNode = mapper.createObjectNode();
 709             /**
 710              * to create json with vf and vfresourceId
 711              */
 712             createVfObjectNode(vfObjectNode, mapper, cldsSdcServiceDetail.getResources());
 713             serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
 714             ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
 715             byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
 716             /**
 717              * to create json with VFC Node
 718              */
 719             ObjectNode emptyvfcobjectNode = createByVFCObjectNode(mapper, cldsSdcServiceDetail.getResources());
 720             byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
 721             globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
 722             logger.info("valuie of objNode: {}", globalPropsJson);
 723         }
 724         return globalPropsJson.toString();
 725     }
 726
 727     private ObjectNode createEmptyVfAlarmObject(ObjectMapper mapper) {
 728         ObjectNode emptyObjectNode = mapper.createObjectNode();
 729         emptyObjectNode.put("", "");
 730         ObjectNode vfObjectNode = mapper.createObjectNode();
 731         vfObjectNode.putPOJO("vf", emptyObjectNode);
 732         vfObjectNode.putPOJO("location", emptyObjectNode);
 733         vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
 734         ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
 735         emptyServiceObjectNode.putPOJO("", vfObjectNode);
 736         return emptyServiceObjectNode;
 737     }
 738
 739     private void createVfObjectNode(ObjectNode vfObjectNode2, ObjectMapper mapper,
 740             List<SdcResource> rawCldsSdcResourceList) {
 741         ObjectNode vfNode = mapper.createObjectNode();
 742         vfNode.put("", "");
 743         // To remove repeated resource instance name from
 744         // resourceInstanceList
 745         List<SdcResource> cldsSdcResourceList = sdcCatalogServices
 746                 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
 747         /**
 748          * Creating vf resource node using cldsSdcResource Object
 749          */
 750         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 751             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 752                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 753                     vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
 754                 }
 755             }
 756         }
 757         vfObjectNode2.putPOJO("vf", vfNode);
 758         /**
 759          * creating location json object using properties file value
 760          */
 761         ObjectNode locationJsonNode;
 762         try {
 763             locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
 764                     JsonNode.class);
 765         } catch (IOException e) {
 766             logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
 767             throw new CldsConfigException(
 768                     "Unable to load ui.location.default JSON in clds-references.properties properly", e);
 769         }
 770         vfObjectNode2.putPOJO("location", locationJsonNode);
 771         /**
 772          * creating alarm json object using properties file value
 773          */
 774         String alarmStringValue = refProp.getStringValue("ui.alarm.default");
 775         logger.info("value of alarm: {}", alarmStringValue);
 776         ObjectNode alarmStringJsonNode;
 777         try {
 778             alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
 779         } catch (IOException e) {
 780             logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
 781             throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
 782                     e);
 783         }
 784         vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
 785     }
 786
 787     private ObjectNode createByVFCObjectNode(ObjectMapper mapper, List<SdcResource> cldsSdcResourceList) {
 788         ObjectNode emptyObjectNode = mapper.createObjectNode();
 789         ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
 790         ObjectNode vfCObjectNode = mapper.createObjectNode();
 791         vfCObjectNode.putPOJO("vfC", emptyObjectNode);
 792         ObjectNode subVfCObjectNode = mapper.createObjectNode();
 793         subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
 794         if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
 795             for (SdcResource cldsSdcResource : cldsSdcResourceList) {
 796                 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
 797                     vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
 798                 }
 799             }
 800         }
 801         emptyvfcobjectNode.putPOJO("", vfCObjectNode);
 802         return emptyvfcobjectNode;
 803     }
 804
 805     @PUT
 806     @Path("/deploy/{modelName}")
 807     @Consumes(MediaType.APPLICATION_JSON)
 808     @Produces(MediaType.APPLICATION_JSON)
 809     public Response deployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
 810             @QueryParam("test") String test, CldsModel model) {
 811         Date startTime = new Date();
 812         LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
 813         Boolean errorCase = false;
 814         try {
 815             try {
 816                 checkForDuplicateServiceVf(modelName, model.getPropText());
 817             } catch (IOException | BadRequestException e) {
 818                 errorCase = true;
 819                 logger.error("Exception occured during duplicate check for service and VF", e);
 820             }
 821             String deploymentId = "";
 822             // If model is already deployed then pass same deployment id
 823             if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
 824                 deploymentId = model.getDeploymentId();
 825             } else {
 826                 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
 827             }
 828             String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
 829                     model.getTypeId());
 830             String operationStatus = "processing";
 831             long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
 832             while ("processing".equalsIgnoreCase(operationStatus)) {
 833                 // Break the loop if waiting for more than 10 mins
 834                 if (waitingTime < System.nanoTime()) {
 835                     break;
 836                 }
 837                 operationStatus = dcaeDispatcherServices.getOperationStatus(createNewDeploymentStatusUrl);
 838             }
 839             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 840                 String artifactName = model.getControlName();
 841                 if (artifactName != null) {
 842                     artifactName = artifactName + ".yml";
 843                 }
 844                 DcaeEvent dcaeEvent = new DcaeEvent();
 845                 /* set dcae events */
 846                 dcaeEvent.setArtifactName(artifactName);
 847                 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
 848                 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 849                         CldsEvent.ACTION_STATE_RECEIVED, null);
 850                 model.setDeploymentId(deploymentId);
 851                 model.save(cldsDao, getUserId());
 852             } else {
 853                 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 854                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 855                         "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 856             }
 857             logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
 858             // audit log
 859             LoggingUtils.setTimeContext(startTime, new Date());
 860             LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
 861             auditLogger.info("Deploy model completed");
 862         } catch (Exception e) {
 863             errorCase = true;
 864             logger.error("Exception occured during deployModel", e);
 865         }
 866
 867         if (errorCase) {
 868             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
 869         }
 870         return Response.status(Response.Status.OK).entity(model).build();
 871     }
 872
 873     @PUT
 874     @Path("/undeploy/{modelName}")
 875     @Consumes(MediaType.APPLICATION_JSON)
 876     @Produces(MediaType.APPLICATION_JSON)
 877     public Response unDeployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
 878             @QueryParam("test") String test, CldsModel model) {
 879         Date startTime = new Date();
 880         LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
 881
 882         Boolean errorCase = false;
 883         try {
 884             String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
 885                     model.getTypeId());
 886             String operationStatus = "processing";
 887             long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
 888             while ("processing".equalsIgnoreCase(operationStatus)) {
 889                 if (waitingTime < System.nanoTime()) {
 890                     break;
 891                 }
 892                 operationStatus = dcaeDispatcherServices.getOperationStatus(operationStatusUndeployUrl);
 893             }
 894             if ("succeeded".equalsIgnoreCase(operationStatus)) {
 895                 String artifactName = model.getControlName();
 896                 if (artifactName != null) {
 897                     artifactName = artifactName + ".yml";
 898                 }
 899                 DcaeEvent dcaeEvent = new DcaeEvent();
 900                 // set dcae events
 901                 dcaeEvent.setArtifactName(artifactName);
 902                 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
 903                 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
 904                         CldsEvent.ACTION_STATE_RECEIVED, null);
 905                 model.setDeploymentId(null);
 906                 model.save(cldsDao, getUserId());
 907             } else {
 908                 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 909                 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
 910                         "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
 911             }
 912             logger.info("Undeploy model (" + modelName + ") succeeded.");
 913             // audit log
 914             LoggingUtils.setTimeContext(startTime, new Date());
 915             LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
 916             auditLogger.info("Undeploy model completed");
 917         } catch (Exception e) {
 918             errorCase = true;
 919             logger.error("Exception occured during unDeployModel", e);
 920         }
 921
 922         if (errorCase) {
 923             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
 924         }
 925         return Response.status(Response.Status.OK).entity(model).build();
 926     }
 927
 928     private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
 929         JsonNode modelJson = new ObjectMapper().readTree(modelPropText);
 930         JsonNode globalNode = modelJson.get("global");
 931         String service = AbstractModelElement.getValueByName(globalNode, "service");
 932         List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
 933         if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
 934             List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
 935             for (CldsModelProp cldsModelProp : cldsModelPropList) {
 936                 JsonNode currentJson = new ObjectMapper().readTree(cldsModelProp.getPropText());
 937                 JsonNode currentNode = currentJson.get("global");
 938                 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
 939                 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
 940                 if (currentVf != null && !currentVf.isEmpty()) {
 941                     if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
 942                             && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
 943                         throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
 944                                 + " model, please select different Service/VF.");
 945                     }
 946                 }
 947             }
 948         }
 949     }
 950 }