2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 package org.onap.clamp.clds.service;
26 import com.att.ajsc.common.AjscService;
27 import com.fasterxml.jackson.databind.JsonNode;
28 import com.fasterxml.jackson.databind.ObjectMapper;
29 import com.fasterxml.jackson.databind.node.ObjectNode;
31 import java.io.IOException;
32 import java.io.InputStream;
33 import java.util.Date;
34 import java.util.HashMap;
35 import java.util.List;
37 import java.util.Properties;
38 import java.util.UUID;
39 import java.util.concurrent.TimeUnit;
41 import javax.annotation.PostConstruct;
42 import javax.ws.rs.Consumes;
43 import javax.ws.rs.DefaultValue;
44 import javax.ws.rs.GET;
45 import javax.ws.rs.NotAuthorizedException;
46 import javax.ws.rs.POST;
47 import javax.ws.rs.PUT;
48 import javax.ws.rs.Path;
49 import javax.ws.rs.PathParam;
50 import javax.ws.rs.Produces;
51 import javax.ws.rs.QueryParam;
52 import javax.ws.rs.core.MediaType;
53 import javax.xml.transform.TransformerException;
55 import org.apache.commons.lang3.StringUtils;
56 import org.camunda.bpm.engine.RuntimeService;
57 import org.camunda.bpm.engine.runtime.ProcessInstance;
58 import org.json.simple.parser.ParseException;
59 import org.onap.clamp.clds.client.DcaeDispatcherServices;
60 import org.onap.clamp.clds.client.DcaeInventoryServices;
61 import org.onap.clamp.clds.client.SdcCatalogServices;
62 import org.onap.clamp.clds.dao.CldsDao;
63 import org.onap.clamp.clds.exception.CldsConfigException;
64 import org.onap.clamp.clds.exception.SdcCommunicationException;
65 import org.onap.clamp.clds.model.CldsDBServiceCache;
66 import org.onap.clamp.clds.model.CldsEvent;
67 import org.onap.clamp.clds.model.CldsHealthCheck;
68 import org.onap.clamp.clds.model.CldsInfo;
69 import org.onap.clamp.clds.model.CldsModel;
70 import org.onap.clamp.clds.model.CldsSdcResource;
71 import org.onap.clamp.clds.model.CldsSdcServiceDetail;
72 import org.onap.clamp.clds.model.CldsSdcServiceInfo;
73 import org.onap.clamp.clds.model.CldsServiceData;
74 import org.onap.clamp.clds.model.CldsTemplate;
75 import org.onap.clamp.clds.model.DcaeEvent;
76 import org.onap.clamp.clds.model.ValueItem;
77 import org.onap.clamp.clds.model.prop.ModelProperties;
78 import org.onap.clamp.clds.model.refprop.RefProp;
79 import org.onap.clamp.clds.transform.XslTransformer;
80 import org.onap.clamp.clds.util.LoggingUtils;
81 import org.springframework.beans.factory.annotation.Autowired;
82 import org.springframework.beans.factory.annotation.Value;
83 import org.springframework.context.ApplicationContext;
84 import org.springframework.http.HttpStatus;
85 import org.springframework.web.client.HttpClientErrorException;
87 import io.swagger.annotations.Api;
88 import io.swagger.annotations.ApiOperation;
91 * Service to save and retrieve the CLDS model attributes.
96 public class CldsService extends SecureServiceBase {
99 private ApplicationContext appContext;
101 private static final String RESOURCE_NAME = "clds-version.properties";
103 @Value("${CLDS_PERMISSION_TYPE_CL:permission-type-cl}")
104 private String cldsPersmissionTypeCl;
106 @Value("${CLDS_PERMISSION_TYPE_CL_MANAGE:permission-type-cl-manage}")
107 private String cldsPermissionTypeClManage;
109 @Value("${CLDS_PERMISSION_TYPE_CL_EVENT:permission-type-cl-event}")
110 private String cldsPermissionTypeClEvent;
112 @Value("${CLDS_PERMISSION_TYPE_FILTER_VF:permission-type-filter-vf}")
113 private String cldsPermissionTypeFilterVf;
115 @Value("${CLDS_PERMISSION_TYPE_TEMPLATE:permission-type-template}")
116 private String cldsPermissionTypeTemplate;
118 @Value("${CLDS_PERMISSION_INSTANCE:dev}")
119 private String cldsPermissionInstance;
121 private SecureServicePermission permissionReadCl;
123 private SecureServicePermission permissionUpdateCl;
125 private SecureServicePermission permissionReadTemplate;
127 private SecureServicePermission permissionUpdateTemplate;
130 private final void afterConstruction() {
131 permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
132 permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
133 permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
135 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
139 @Value("${org.onap.clamp.config.files.globalClds:'classpath:/clds/globalClds.properties'}")
140 private String globalClds;
142 private Properties globalCldsProperties;
145 private CldsDao cldsDao;
147 private RuntimeService runtimeService;
149 private XslTransformer cldsBpmnTransformer;
152 private RefProp refProp;
155 private SdcCatalogServices sdcCatalogServices;
158 private DcaeDispatcherServices dcaeDispatcherServices;
161 private DcaeInventoryServices dcaeInventoryServices;
163 public CldsService() {
166 public CldsService(RefProp refProp) {
167 this.refProp = refProp;
172 * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version
173 * that is currently installed from pom.xml file 3. User permissions
179 @Produces(MediaType.APPLICATION_JSON)
180 public CldsInfo getCldsInfo() {
182 CldsInfo cldsInfo = new CldsInfo();
185 cldsInfo.setUserName(getUserName());
187 // Get CLDS application version
188 String cldsVersion = "";
189 Properties props = new Properties();
191 ClassLoader loader = Thread.currentThread().getContextClassLoader();
193 try (InputStream resourceStream = loader.getResourceAsStream(RESOURCE_NAME)) {
194 props.load(resourceStream);
195 cldsVersion = props.getProperty("clds.version");
196 } catch (Exception ex) {
197 logger.error("Exception caught during the clds.version reading", ex);
199 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));
210 @Path("/healthcheck")
211 @Produces(MediaType.APPLICATION_JSON)
212 public CldsHealthCheck gethealthcheck() {
214 CldsHealthCheck cldsHealthCheck = new CldsHealthCheck();
217 cldsDao.doHealthCheck();
218 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
219 cldsHealthCheck.setHealthCheckStatus("UP");
220 cldsHealthCheck.setDescription("OK");
221 } catch (Exception e) {
222 logger.error("CLAMP application DB Error", e);
223 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
224 cldsHealthCheck.setHealthCheckStatus("DOWN");
225 cldsHealthCheck.setDescription("NOT-OK");
227 return cldsHealthCheck;
232 * REST service that retrieves BPMN for a CLDS model name from the database.
233 * This is subset of the json getModel. This is only expected to be used for
234 * testing purposes, not by the UI.
237 * @return bpmn xml text - content of bpmn given name
239 @ApiOperation(value = "Retrieves BPMN for a CLDS model name from the database", notes = "This is only expected to be used for testing purposes, not by the UI", response = String.class)
241 @Path("/model/bpmn/{modelName}")
242 @Produces(MediaType.TEXT_XML)
243 public String getBpmnXml(@PathParam("modelName") String modelName) {
244 Date startTime = new Date();
245 LoggingUtils.setRequestContext("CldsService: GET model bpmn", getPrincipalName());
246 isAuthorized(permissionReadCl);
247 logger.info("GET bpmnText for modelName={}", modelName);
248 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
250 LoggingUtils.setTimeContext(startTime, new Date());
251 LoggingUtils.setResponseContext("0", "Get model bpmn success", this.getClass().getName());
252 auditLogger.info("GET model bpmn completed");
253 return model.getBpmnText();
257 * REST service that saves BPMN for a CLDS model by name in the database.
258 * This is subset of the json putModel. This is only expected to be used for
259 * testing purposes, not by the UI.
263 @ApiOperation(value = "Saves BPMN for a CLDS model by name in the database", notes = "This is only expected to be used for testing purposes, not by the UI", response = String.class)
265 @Path("/model/bpmn/{modelName}")
266 @Consumes(MediaType.TEXT_XML)
267 public String putBpmnXml(@PathParam("modelName") String modelName, String bpmnText) {
268 LoggingUtils.setRequestContext("CldsService: PUT model bpmn", getPrincipalName());
269 isAuthorized(permissionUpdateCl);
270 logger.info("PUT bpmnText for modelName={}", modelName);
271 logger.info("PUT bpmnText={}", bpmnText);
272 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, true);
273 cldsModel.setBpmnText(bpmnText);
274 cldsModel.save(cldsDao, getUserId());
276 LoggingUtils.setTimeContext(new Date(), new Date());
277 LoggingUtils.setResponseContext("0", "Put model bpmn success", this.getClass().getName());
278 auditLogger.info("PUT model bpmn completed");
279 return "wrote bpmnText for modelName=" + modelName;
283 * REST service that retrieves image for a CLDS model name from the
284 * database. This is subset of the json getModel. This is only expected to
285 * be used for testing purposes, not by the UI.
288 * @return image xml text - content of image given name
290 @ApiOperation(value = "Retrieves image for a CLDS model name from the database", notes = "This is only expected to be used for testing purposes, not by the UI", response = String.class)
292 @Path("/model/image/{modelName}")
293 @Produces(MediaType.TEXT_XML)
294 public String getImageXml(@PathParam("modelName") String modelName) {
295 Date startTime = new Date();
296 LoggingUtils.setRequestContext("CldsService: GET model image", getPrincipalName());
297 isAuthorized(permissionReadCl);
298 logger.info("GET imageText for modelName={}", modelName);
299 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
301 LoggingUtils.setTimeContext(startTime, new Date());
302 LoggingUtils.setResponseContext("0", "Get model image success", this.getClass().getName());
303 auditLogger.info("GET model image completed");
304 return model.getImageText();
308 * REST service that saves image for a CLDS model by name in the database.
309 * This is subset of the json putModel. This is only expected to be used for
310 * testing purposes, not by the UI.
314 @ApiOperation(value = "Saves image for a CLDS model by name in the database", notes = "This is only expected to be used for testing purposes, not by the UI", response = String.class)
316 @Path("/model/image/{modelName}")
317 @Consumes(MediaType.TEXT_XML)
318 public String putImageXml(@PathParam("modelName") String modelName, String imageText) {
319 Date startTime = new Date();
320 LoggingUtils.setRequestContext("CldsService: PUT model image", getPrincipalName());
321 isAuthorized(permissionUpdateCl);
322 logger.info("PUT iamgeText for modelName={}", modelName);
323 logger.info("PUT imageText={}", imageText);
324 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, true);
325 cldsModel.setImageText(imageText);
326 cldsModel.save(cldsDao, getUserId());
328 LoggingUtils.setTimeContext(startTime, new Date());
329 LoggingUtils.setResponseContext("0", "Put model image success", this.getClass().getName());
330 auditLogger.info("PUT model image completed");
331 return "wrote imageText for modelName=" + modelName;
335 * REST service that retrieves a CLDS model by name from the database.
338 * @return clds model - clds model for the given model name
340 @ApiOperation(value = "Retrieves a CLDS model by name from the database", notes = "", response = String.class)
342 @Path("/model/{modelName}")
343 @Produces(MediaType.APPLICATION_JSON)
344 public CldsModel getModel(@PathParam("modelName") String modelName) {
345 Date startTime = new Date();
346 LoggingUtils.setRequestContext("CldsService: GET model", getPrincipalName());
347 isAuthorized(permissionReadCl);
348 logger.debug("GET model for modelName={}", modelName);
349 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
350 isAuthorizedForVf(cldsModel);
351 cldsModel.setUserAuthorizedToUpdate(isAuthorizedNoException(permissionUpdateCl));
354 * Checking condition whether our CLDS model can call INventory Method
356 if (cldsModel.canInventoryCall()) {
359 * Below is the method to for inventory call and DB insert for
362 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
363 } catch (Exception e) {
364 LoggingUtils.setErrorContext("900", "Set event inventory error");
365 logger.error("getModel set event Inventory error:" + e);
369 LoggingUtils.setTimeContext(startTime, new Date());
370 LoggingUtils.setResponseContext("0", "Get model success", this.getClass().getName());
371 auditLogger.info("GET model completed");
376 * REST service that saves a CLDS model by name in the database.
380 @ApiOperation(value = "Saves a CLDS model by name in the database", notes = "", response = String.class)
382 @Path("/model/{modelName}")
383 @Consumes(MediaType.APPLICATION_JSON)
384 @Produces(MediaType.APPLICATION_JSON)
385 public CldsModel putModel(@PathParam("modelName") String modelName, CldsModel cldsModel) {
386 Date startTime = new Date();
387 LoggingUtils.setRequestContext("CldsService: PUT model", getPrincipalName());
388 isAuthorized(permissionUpdateCl);
389 isAuthorizedForVf(cldsModel);
390 logger.info("PUT model for modelName={}", modelName);
391 logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
392 logger.info("PUT propText={}", cldsModel.getPropText());
393 logger.info("PUT imageText={}", cldsModel.getImageText());
394 cldsModel.setName(modelName);
396 if (cldsModel.getTemplateName() != null) {
397 CldsTemplate template = cldsDao.getTemplate(cldsModel.getTemplateName());
398 if (template != null) {
399 cldsModel.setTemplateId(template.getId());
400 cldsModel.setDocText(template.getPropText());
401 cldsModel.setDocId(template.getPropId());
404 cldsModel.save(cldsDao, getUserId());
406 LoggingUtils.setTimeContext(startTime, new Date());
407 LoggingUtils.setResponseContext("0", "Put model success", this.getClass().getName());
408 auditLogger.info("PUT model completed");
413 * REST service that retrieves a list of CLDS model names.
415 * @return model names in JSON
417 @ApiOperation(value = "Retrieves a list of CLDS model names", notes = "", response = String.class)
419 @Path("/model-names")
420 @Produces(MediaType.APPLICATION_JSON)
421 public List<ValueItem> getModelNames() {
422 Date startTime = new Date();
423 LoggingUtils.setRequestContext("CldsService: GET model names", getPrincipalName());
424 isAuthorized(permissionReadCl);
425 logger.info("GET list of model names");
426 List<ValueItem> names = cldsDao.getBpmnNames();
428 LoggingUtils.setTimeContext(startTime, new Date());
429 LoggingUtils.setResponseContext("0", "Get model names success", this.getClass().getName());
430 auditLogger.info("GET model names completed");
435 * REST service that saves and processes an action for a CLDS model by name.
442 * @throws TransformerException
443 * @throws ParseException
445 @ApiOperation(value = "Saves and processes an action for a CLDS model by name", notes = "", response = String.class)
447 @Path("/action/{action}/{modelName}")
448 @Consumes(MediaType.APPLICATION_JSON)
449 @Produces(MediaType.APPLICATION_JSON)
450 public CldsModel putModelAndProcessAction(@PathParam("action") String action,
451 @PathParam("modelName") String modelName, @QueryParam("test") String test, CldsModel model)
452 throws TransformerException, ParseException {
453 Date startTime = new Date();
454 LoggingUtils.setRequestContext("CldsService: Process model action", getPrincipalName());
455 String actionCd = action.toUpperCase();
456 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
457 cldsPermissionInstance, actionCd);
458 isAuthorized(permisionManage);
459 isAuthorizedForVf(model);
460 String userid = getUserId();
461 String actionStateCd = CldsEvent.ACTION_STATE_INITIATED;
462 String processDefinitionKey = "clds-process-action-wf";
464 logger.info("PUT actionCd={}", actionCd);
465 logger.info("PUT actionStateCd={}", actionStateCd);
466 logger.info("PUT processDefinitionKey={}", processDefinitionKey);
467 logger.info("PUT modelName={}", modelName);
468 logger.info("PUT test={}", test);
469 logger.info("PUT bpmnText={}", model.getBpmnText());
470 logger.info("PUT propText={}", model.getPropText());
471 logger.info("PUT userid={}", userid);
472 logger.info("PUT getTypeId={}", model.getTypeId());
473 logger.info("PUT deploymentId={}", model.getDeploymentId());
475 if (model.getTemplateName() != null) {
476 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
477 if (template != null) {
478 model.setTemplateId(template.getId());
479 model.setDocText(template.getPropText());
480 model.setDocId(template.getPropId());
484 model.setName(modelName);
485 model.save(cldsDao, getUserId());
487 // get vars and format if necessary
488 String prop = model.getPropText();
489 String bpmn = model.getBpmnText();
490 String docText = model.getDocText();
491 String controlName = model.getControlName();
493 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
494 logger.info("PUT bpmnJson={}", bpmnJson);
496 // Flag indicates whether it is triggered by Validation Test button from
498 boolean isTest = false;
499 if (test != null && test.equalsIgnoreCase("true")) {
502 String actionTestOverride = refProp.getStringValue("action.test.override");
503 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
504 logger.info("PUT actionTestOverride={}", actionTestOverride);
505 logger.info("PUT override test indicator and setting it to true");
509 logger.info("PUT isTest={}", isTest);
511 boolean isInsertTestEvent = false;
512 String insertTestEvent = refProp.getStringValue("action.insert.test.event");
513 if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
514 isInsertTestEvent = true;
516 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
518 // determine if requested action is permitted
519 model.validateAction(actionCd);
521 // input variables to camunda process
522 Map<String, Object> variables = new HashMap<>();
523 variables.put("actionCd", actionCd);
524 variables.put("modelProp", prop.getBytes());
525 variables.put("modelBpmnProp", bpmnJson);
526 variables.put("modelName", modelName);
527 variables.put("controlName", controlName);
528 variables.put("docText", docText.getBytes());
529 variables.put("isTest", isTest);
530 variables.put("userid", userid);
531 variables.put("isInsertTestEvent", isInsertTestEvent);
532 logger.info("modelProp - " + prop);
533 logger.info("docText - " + docText);
535 // start camunda process
536 ProcessInstance pi = runtimeService.startProcessInstanceByKey(processDefinitionKey, variables);
539 logger.info("Started processDefinitionId={}, processInstanceId={}", pi.getProcessDefinitionId(),
540 pi.getProcessInstanceId());
542 // refresh model info from db (get fresh event info)
543 CldsModel retreivedModel = CldsModel.retrieve(cldsDao, modelName, false);
545 if (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
546 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)) {
547 // To verify inventory status and modify model status to distribute
548 dcaeInventoryServices.setEventInventory(retreivedModel, getUserId());
549 retreivedModel.save(cldsDao, getUserId());
552 LoggingUtils.setTimeContext(startTime, new Date());
553 LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
554 auditLogger.info("Process model action completed");
556 return retreivedModel;
560 * REST service that accepts events for a model.
565 @ApiOperation(value = "Accepts events for a model", notes = "", response = String.class)
568 @Consumes(MediaType.APPLICATION_JSON)
569 @Produces(MediaType.APPLICATION_JSON)
570 public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
571 Date startTime = new Date();
572 LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
573 String userid = null;
574 // TODO: allow auth checking to be turned off by removing the permission
576 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
577 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
578 cldsPermissionInstance, dcaeEvent.getEvent());
579 isAuthorized(permissionEvent);
580 userid = getUserId();
583 // Flag indicates whether it is triggered by Validation Test button from
585 boolean isTest = false;
586 if (test != null && test.equalsIgnoreCase("true")) {
590 int instanceCount = 0;
591 if (dcaeEvent.getInstances() != null) {
592 instanceCount = dcaeEvent.getInstances().size();
594 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
595 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
596 + " instance count=" + instanceCount + " isTest=" + isTest;
597 logger.info("POST dcae event {}", msgInfo);
600 logger.warn("Ignorning test event from DCAE");
602 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
603 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
605 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
606 CldsEvent.ACTION_STATE_RECEIVED, null);
610 LoggingUtils.setTimeContext(startTime, new Date());
611 LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
612 auditLogger.info("Post dcae event completed");
618 * REST service that retrieves sdc services
622 @ApiOperation(value = "Retrieves sdc services", notes = "", response = String.class)
624 @Path("/sdc/services")
625 @Produces(MediaType.APPLICATION_JSON)
626 public String getSdcServices() {
627 Date startTime = new Date();
628 LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
631 String responseStr = sdcCatalogServices.getSdcServicesInformation(null);
633 retStr = createUiServiceFormatJson(responseStr);
634 } catch (IOException e) {
635 logger.error("IOException during SDC communication", e);
636 throw new SdcCommunicationException("IOException during SDC communication", e);
639 logger.info("value of sdcServices : {}", retStr);
641 LoggingUtils.setTimeContext(startTime, new Date());
642 LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
643 auditLogger.info("GET sdc services completed");
648 * REST service that retrieves total properties required by UI
650 * @throws IOException
654 @ApiOperation(value = "Retrieves total properties required by UI", notes = "", response = String.class)
657 @Produces(MediaType.APPLICATION_JSON)
658 public String getSdcProperties() throws IOException {
659 return createPropertiesObjectByUUID(getGlobalCldsString(), "{}");
663 * REST service that retrieves total properties by using invariantUUID based
664 * on refresh and non refresh
667 @ApiOperation(value = "Retrieves total properties by using invariantUUID based on refresh and non refresh", notes = "", response = String.class)
669 @Path("/properties/{serviceInvariantUUID}")
670 @Produces(MediaType.APPLICATION_JSON)
671 public String getSdcPropertiesByServiceUUIDForRefresh(
672 @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
673 @DefaultValue("false") @QueryParam("refresh") String refresh) {
674 Date startTime = new Date();
675 LoggingUtils.setRequestContext("CldsService: GET sdc properties by uuid", getPrincipalName());
676 CldsServiceData cldsServiceData = new CldsServiceData();
677 cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
679 boolean isCldsSdcDataExpired = true;
680 // To getcldsService information from database cache using invariantUUID
681 // only when refresh = false
682 if (refresh != null && refresh.equalsIgnoreCase("false")) {
683 cldsServiceData = cldsServiceData.getCldsServiceCache(cldsDao, serviceInvariantUUID);
684 // If cldsService is available in database Cache , verify is data
686 if (cldsServiceData != null) {
687 isCldsSdcDataExpired = sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData);
690 // If user Requested for refresh or database cache expired , get all
691 // data from sdc api.
692 if ((refresh != null && refresh.equalsIgnoreCase("true")) || isCldsSdcDataExpired) {
693 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
694 CldsDBServiceCache cldsDBServiceCache = sdcCatalogServices
695 .getCldsDbServiceCacheUsingCldsServiceData(cldsServiceData);
696 if (cldsDBServiceCache != null && cldsDBServiceCache.getInvariantId() != null
697 && cldsDBServiceCache.getServiceId() != null) {
698 cldsServiceData.setCldsServiceCache(cldsDao, cldsDBServiceCache);
702 // filter out VFs the user is not authorized for
703 cldsServiceData.filterVfs(this);
705 // format retrieved data into properties json
706 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(getGlobalCldsString(), cldsServiceData);
709 LoggingUtils.setTimeContext(startTime, new Date());
710 LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
711 auditLogger.info("GET sdc properties by uuid completed");
713 return sdcProperties;
717 * Determine if the user is authorized for a particular VF by its invariant
720 * @param vfInvariantUuid
721 * @throws NotAuthorizedException
724 public boolean isAuthorizedForVf(String vfInvariantUuid) {
725 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
726 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
727 cldsPermissionInstance, vfInvariantUuid);
728 return isAuthorized(permission);
730 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
731 // VF filtering is turned off
732 logger.warn("VF filtering turned off");
738 * Determine if the user is authorized for a particular VF by its invariant
739 * UUID. If not authorized, then NotAuthorizedException is thrown.
744 private boolean isAuthorizedForVf(CldsModel model) {
745 String vf = ModelProperties.getVf(model);
746 if (vf == null || vf.length() == 0) {
747 logger.info("VF not found in model");
750 return isAuthorizedForVf(vf);
754 private String createUiServiceFormatJson(String responseStr) throws IOException {
755 if (StringUtils.isBlank(responseStr)) {
758 ObjectMapper objectMapper = new ObjectMapper();
759 List<CldsSdcServiceInfo> rawList = objectMapper.readValue(responseStr,
760 objectMapper.getTypeFactory().constructCollectionType(List.class, CldsSdcServiceInfo.class));
761 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
762 ObjectNode serviceNode = objectMapper.createObjectNode();
763 logger.info("value of cldsserviceiNfolist: {}", rawList);
764 if (rawList != null && !rawList.isEmpty()) {
765 List<CldsSdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
767 for (CldsSdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
768 if (currCldsSdcServiceInfo != null) {
769 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
770 currCldsSdcServiceInfo.getName());
773 serviceNode.putPOJO("service", invariantIdServiceNode);
775 return serviceNode.toString();
778 private String createPropertiesObjectByUUID(String globalProps, String cldsResponseStr) throws IOException {
779 ObjectMapper mapper = new ObjectMapper();
780 CldsSdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, CldsSdcServiceDetail.class);
781 ObjectNode globalPropsJson = null;
782 if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
784 * to create json with vf, alarm and locations
786 ObjectNode serviceObjectNode = createEmptyVfAlarmObject(mapper);
787 ObjectNode vfObjectNode = mapper.createObjectNode();
790 * to create json with vf and vfresourceId
792 createVfObjectNode(vfObjectNode, mapper, cldsSdcServiceDetail.getResources());
793 serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
794 ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
795 byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
798 * to create json with VFC Node
800 ObjectNode emptyvfcobjectNode = createByVFCObjectNode(mapper, cldsSdcServiceDetail.getResources());
801 byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
802 globalPropsJson = (ObjectNode) mapper.readValue(globalProps, JsonNode.class);
803 globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
804 logger.info("valuie of objNode: {}", globalPropsJson);
807 * to create json with total properties when no serviceUUID passed
809 globalPropsJson = (ObjectNode) mapper.readValue(globalProps, JsonNode.class);
811 return globalPropsJson.toString();
814 private ObjectNode createEmptyVfAlarmObject(ObjectMapper mapper) {
815 ObjectNode emptyObjectNode = mapper.createObjectNode();
816 emptyObjectNode.put("", "");
817 ObjectNode vfObjectNode = mapper.createObjectNode();
818 vfObjectNode.putPOJO("vf", emptyObjectNode);
819 vfObjectNode.putPOJO("location", emptyObjectNode);
820 vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
821 ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
822 emptyServiceObjectNode.putPOJO("", vfObjectNode);
823 return emptyServiceObjectNode;
826 private void createVfObjectNode(ObjectNode vfObjectNode2, ObjectMapper mapper,
827 List<CldsSdcResource> rawCldsSdcResourceList) {
828 ObjectNode vfNode = mapper.createObjectNode();
831 // To remove repeated resource instance name from
832 // resourceInstanceList
833 List<CldsSdcResource> cldsSdcResourceList = sdcCatalogServices
834 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
836 * Creating vf resource node using cldsSdcResource Object
838 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
839 for (CldsSdcResource cldsSdcResource : cldsSdcResourceList) {
840 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
841 vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
845 vfObjectNode2.putPOJO("vf", vfNode);
848 * creating location json object using properties file value
850 ObjectNode locationJsonNode;
852 locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
854 } catch (IOException e) {
855 logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
856 throw new CldsConfigException(
857 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
859 vfObjectNode2.putPOJO("location", locationJsonNode);
862 * creating alarm json object using properties file value
864 String alarmStringValue = refProp.getStringValue("ui.alarm.default");
865 logger.info("value of alarm: {}", alarmStringValue);
866 ObjectNode alarmStringJsonNode;
868 alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
869 } catch (IOException e) {
870 logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
871 throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
874 vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
878 private ObjectNode createByVFCObjectNode(ObjectMapper mapper, List<CldsSdcResource> cldsSdcResourceList) {
879 ObjectNode emptyObjectNode = mapper.createObjectNode();
880 ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
881 ObjectNode vfCObjectNode = mapper.createObjectNode();
882 vfCObjectNode.putPOJO("vfC", emptyObjectNode);
883 ObjectNode subVfCObjectNode = mapper.createObjectNode();
884 subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
885 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
886 for (CldsSdcResource cldsSdcResource : cldsSdcResourceList) {
887 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
888 vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
892 emptyvfcobjectNode.putPOJO("", vfCObjectNode);
893 return emptyvfcobjectNode;
897 @Path("/deploy/{modelName}")
898 @Consumes(MediaType.APPLICATION_JSON)
899 @Produces(MediaType.APPLICATION_JSON)
900 public CldsModel deployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
901 @QueryParam("test") String test, CldsModel model) throws IOException {
902 Date startTime = new Date();
903 LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
904 String deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
905 String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
907 String operationStatus = "processing";
908 long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
909 while ("processing".equalsIgnoreCase(operationStatus)) {
910 // Break the loop if waiting for more than 10 mins
911 if (waitingTime < System.nanoTime()) {
914 operationStatus = dcaeDispatcherServices.getOperationStatus(createNewDeploymentStatusUrl);
916 if ("succeeded".equalsIgnoreCase(operationStatus)) {
917 String artifactName = model.getControlName();
918 if (artifactName != null) {
919 artifactName = artifactName + ".yml";
921 DcaeEvent dcaeEvent = new DcaeEvent();
922 /* set dcae events */
923 dcaeEvent.setArtifactName(artifactName);
924 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
925 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
926 CldsEvent.ACTION_STATE_RECEIVED, null);
927 model.setDeploymentId(deploymentId);
928 model.save(cldsDao, getUserId());
930 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
931 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
932 "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
934 logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
936 LoggingUtils.setTimeContext(startTime, new Date());
937 LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
938 auditLogger.info("Deploy model completed");
943 @Path("/undeploy/{modelName}")
944 @Consumes(MediaType.APPLICATION_JSON)
945 @Produces(MediaType.APPLICATION_JSON)
946 public CldsModel unDeployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
947 @QueryParam("test") String test, CldsModel model) throws IOException {
948 Date startTime = new Date();
949 LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
950 String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
952 String operationStatus = "processing";
953 long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
954 while ("processing".equalsIgnoreCase(operationStatus)) {
955 if (waitingTime < System.nanoTime()) {
958 operationStatus = dcaeDispatcherServices.getOperationStatus(operationStatusUndeployUrl);
960 if ("succeeded".equalsIgnoreCase(operationStatus)) {
961 String artifactName = model.getControlName();
962 if (artifactName != null) {
963 artifactName = artifactName + ".yml";
965 DcaeEvent dcaeEvent = new DcaeEvent();
967 dcaeEvent.setArtifactName(artifactName);
968 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
969 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
970 CldsEvent.ACTION_STATE_RECEIVED, null);
971 model.setDeploymentId(null);
972 model.save(cldsDao, getUserId());
974 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
975 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
976 "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
978 logger.info("Undeploy model (" + modelName + ") succeeded.");
980 LoggingUtils.setTimeContext(startTime, new Date());
981 LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
982 auditLogger.info("Undeploy model completed");
986 private String getGlobalCldsString() {
988 if (null == globalCldsProperties) {
989 globalCldsProperties = new Properties();
990 globalCldsProperties.load(appContext.getResource(globalClds).getInputStream());
992 return (String) globalCldsProperties.get("globalCldsProps");
993 } catch (IOException e) {
994 logger.error("Unable to load the globalClds due to an exception", e);
995 throw new CldsConfigException("Unable to load the globalClds due to an exception", e);