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.att.eelf.configuration.EELFLogger;
28 import com.att.eelf.configuration.EELFManager;
29 import com.fasterxml.jackson.databind.JsonNode;
30 import com.fasterxml.jackson.databind.ObjectMapper;
31 import com.fasterxml.jackson.databind.node.ObjectNode;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.security.GeneralSecurityException;
36 import java.util.Date;
37 import java.util.HashMap;
38 import java.util.List;
40 import java.util.Properties;
41 import java.util.UUID;
42 import java.util.concurrent.TimeUnit;
44 import javax.annotation.PostConstruct;
45 import javax.ws.rs.BadRequestException;
46 import javax.ws.rs.Consumes;
47 import javax.ws.rs.DefaultValue;
48 import javax.ws.rs.GET;
49 import javax.ws.rs.NotAuthorizedException;
50 import javax.ws.rs.POST;
51 import javax.ws.rs.PUT;
52 import javax.ws.rs.Path;
53 import javax.ws.rs.PathParam;
54 import javax.ws.rs.Produces;
55 import javax.ws.rs.QueryParam;
56 import javax.ws.rs.core.MediaType;
57 import javax.xml.transform.TransformerException;
59 import org.apache.commons.lang3.StringUtils;
60 import org.camunda.bpm.engine.RuntimeService;
61 import org.camunda.bpm.engine.runtime.ProcessInstance;
62 import org.json.simple.parser.ParseException;
63 import org.onap.clamp.clds.client.DcaeDispatcherServices;
64 import org.onap.clamp.clds.client.DcaeInventoryServices;
65 import org.onap.clamp.clds.client.SdcCatalogServices;
66 import org.onap.clamp.clds.dao.CldsDao;
67 import org.onap.clamp.clds.exception.CldsConfigException;
68 import org.onap.clamp.clds.exception.SdcCommunicationException;
69 import org.onap.clamp.clds.exception.policy.PolicyClientException;
70 import org.onap.clamp.clds.model.CldsDBServiceCache;
71 import org.onap.clamp.clds.model.CldsEvent;
72 import org.onap.clamp.clds.model.CldsHealthCheck;
73 import org.onap.clamp.clds.model.CldsInfo;
74 import org.onap.clamp.clds.model.CldsModel;
75 import org.onap.clamp.clds.model.CldsModelProp;
76 import org.onap.clamp.clds.model.CldsSdcResource;
77 import org.onap.clamp.clds.model.CldsSdcServiceDetail;
78 import org.onap.clamp.clds.model.CldsSdcServiceInfo;
79 import org.onap.clamp.clds.model.CldsServiceData;
80 import org.onap.clamp.clds.model.CldsTemplate;
81 import org.onap.clamp.clds.model.DcaeEvent;
82 import org.onap.clamp.clds.model.ValueItem;
83 import org.onap.clamp.clds.model.prop.AbstractModelElement;
84 import org.onap.clamp.clds.model.prop.ModelProperties;
85 import org.onap.clamp.clds.model.refprop.RefProp;
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.web.client.HttpClientErrorException;
94 import io.swagger.annotations.Api;
95 import io.swagger.annotations.ApiOperation;
98 * Service to save and retrieve the CLDS model attributes.
101 @Api(value = "/clds")
103 public class CldsService extends SecureServiceBase {
104 protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
106 private ApplicationContext appContext;
107 private static final String RESOURCE_NAME = "clds-version.properties";
108 @Value("${CLDS_PERMISSION_TYPE_CL:permission-type-cl}")
109 private String cldsPersmissionTypeCl;
110 @Value("${CLDS_PERMISSION_TYPE_CL_MANAGE:permission-type-cl-manage}")
111 private String cldsPermissionTypeClManage;
112 @Value("${CLDS_PERMISSION_TYPE_CL_EVENT:permission-type-cl-event}")
113 private String cldsPermissionTypeClEvent;
114 @Value("${CLDS_PERMISSION_TYPE_FILTER_VF:permission-type-filter-vf}")
115 private String cldsPermissionTypeFilterVf;
116 @Value("${CLDS_PERMISSION_TYPE_TEMPLATE:permission-type-template}")
117 private String cldsPermissionTypeTemplate;
118 @Value("${CLDS_PERMISSION_INSTANCE:dev}")
119 private String cldsPermissionInstance;
120 private SecureServicePermission permissionReadCl;
121 private SecureServicePermission permissionUpdateCl;
122 private SecureServicePermission permissionReadTemplate;
123 private SecureServicePermission permissionUpdateTemplate;
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,
131 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
135 @Value("${org.onap.clamp.config.files.globalClds:'classpath:/clds/globalClds.properties'}")
136 private String globalClds;
137 private Properties globalCldsProperties;
139 private CldsDao cldsDao;
141 private RuntimeService runtimeService;
143 private XslTransformer cldsBpmnTransformer;
145 private RefProp refProp;
147 private SdcCatalogServices sdcCatalogServices;
149 private DcaeDispatcherServices dcaeDispatcherServices;
151 private DcaeInventoryServices dcaeInventoryServices;
153 public CldsService() {
156 public CldsService(RefProp refProp) {
157 this.refProp = refProp;
162 * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version
163 * that is currently installed from pom.xml file 3. User permissions
168 @Produces(MediaType.APPLICATION_JSON)
169 public CldsInfo getCldsInfo() {
170 CldsInfo cldsInfo = new CldsInfo();
171 Date startTime = new Date();
172 LoggingUtils.setRequestContext("CldsService: GET cldsInfo", getPrincipalName());
173 LoggingUtils.setTimeContext(startTime, new Date());
175 cldsInfo.setUserName(getUserName());
176 // Get CLDS application version
177 String cldsVersion = "";
178 Properties props = new Properties();
179 ClassLoader loader = Thread.currentThread().getContextClassLoader();
180 try (InputStream resourceStream = loader.getResourceAsStream(RESOURCE_NAME)) {
181 props.load(resourceStream);
182 cldsVersion = props.getProperty("clds.version");
183 } catch (Exception ex) {
184 logger.error("Exception caught during the clds.version reading", ex);
186 cldsInfo.setCldsVersion(cldsVersion);
187 // Get the user list of permissions
188 cldsInfo.setPermissionReadCl(isAuthorizedNoException(permissionReadCl));
189 cldsInfo.setPermissionUpdateCl(isAuthorizedNoException(permissionUpdateCl));
190 cldsInfo.setPermissionReadTemplate(isAuthorizedNoException(permissionReadTemplate));
191 cldsInfo.setPermissionUpdateTemplate(isAuthorizedNoException(permissionUpdateTemplate));
193 LoggingUtils.setTimeContext(startTime, new Date());
194 LoggingUtils.setResponseContext("0", "Get cldsInfo success", this.getClass().getName());
195 securityLogger.info("GET cldsInfo completed");
200 * REST service that retrieves clds healthcheck information.
202 * @return CldsHealthCheck class containing healthcheck info
205 @Path("/healthcheck")
206 @Produces(MediaType.APPLICATION_JSON)
207 public CldsHealthCheck gethealthcheck() {
208 CldsHealthCheck cldsHealthCheck = new CldsHealthCheck();
209 Date startTime = new Date();
210 LoggingUtils.setRequestContext("CldsService: GET healthcheck", getPrincipalName());
211 LoggingUtils.setTimeContext(startTime, new Date());
213 cldsDao.doHealthCheck();
214 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
215 cldsHealthCheck.setHealthCheckStatus("UP");
216 cldsHealthCheck.setDescription("OK");
217 } catch (Exception e) {
218 logger.error("CLAMP application DB Error", e);
219 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
220 cldsHealthCheck.setHealthCheckStatus("DOWN");
221 cldsHealthCheck.setDescription("NOT-OK");
224 LoggingUtils.setTimeContext(startTime, new Date());
225 LoggingUtils.setResponseContext("0", "Get healthcheck success", this.getClass().getName());
226 securityLogger.info("GET healthcheck completed");
227 return cldsHealthCheck;
231 * REST service that retrieves BPMN for a CLDS model name from the database.
232 * This is subset of the json getModel. This is only expected to be used for
233 * testing purposes, not by the UI.
236 * @return bpmn xml text - content of bpmn given name
238 @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)
240 @Path("/model/bpmn/{modelName}")
241 @Produces(MediaType.TEXT_XML)
242 public String getBpmnXml(@PathParam("modelName") String modelName) {
243 Date startTime = new Date();
244 LoggingUtils.setRequestContext("CldsService: GET model bpmn", getPrincipalName());
245 isAuthorized(permissionReadCl);
246 logger.info("GET bpmnText for modelName={}", modelName);
247 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
249 LoggingUtils.setTimeContext(startTime, new Date());
250 LoggingUtils.setResponseContext("0", "Get model bpmn success", this.getClass().getName());
251 auditLogger.info("GET model bpmn completed");
252 return model.getBpmnText();
256 * REST service that retrieves image for a CLDS model name from the
257 * database. This is subset of the json getModel. This is only expected to
258 * be used for testing purposes, not by the UI.
261 * @return image xml text - content of image given name
263 @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)
265 @Path("/model/image/{modelName}")
266 @Produces(MediaType.TEXT_XML)
267 public String getImageXml(@PathParam("modelName") String modelName) {
268 Date startTime = new Date();
269 LoggingUtils.setRequestContext("CldsService: GET model image", getPrincipalName());
270 isAuthorized(permissionReadCl);
271 logger.info("GET imageText for modelName={}", modelName);
272 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
274 LoggingUtils.setTimeContext(startTime, new Date());
275 LoggingUtils.setResponseContext("0", "Get model image success", this.getClass().getName());
276 auditLogger.info("GET model image completed");
277 return model.getImageText();
281 * REST service that retrieves a CLDS model by name from the database.
284 * @return clds model - clds model for the given model name
286 @ApiOperation(value = "Retrieves a CLDS model by name from the database", notes = "", response = String.class)
288 @Path("/model/{modelName}")
289 @Produces(MediaType.APPLICATION_JSON)
290 public CldsModel getModel(@PathParam("modelName") String modelName) {
291 Date startTime = new Date();
292 LoggingUtils.setRequestContext("CldsService: GET model", getPrincipalName());
293 isAuthorized(permissionReadCl);
294 logger.debug("GET model for modelName={}", modelName);
295 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
296 isAuthorizedForVf(cldsModel);
297 cldsModel.setUserAuthorizedToUpdate(isAuthorizedNoException(permissionUpdateCl));
299 * Checking condition whether our CLDS model can call INventory Method
301 if (cldsModel.canInventoryCall()) {
304 * Below is the method to for inventory call and DB insert for
307 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
308 } catch (Exception e) {
309 LoggingUtils.setErrorContext("900", "Set event inventory error");
310 logger.error("getModel set event Inventory error:" + e);
314 LoggingUtils.setTimeContext(startTime, new Date());
315 LoggingUtils.setResponseContext("0", "Get model success", this.getClass().getName());
316 auditLogger.info("GET model completed");
321 * REST service that saves a CLDS model by name in the database.
325 @ApiOperation(value = "Saves a CLDS model by name in the database", notes = "", response = String.class)
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);
341 duplicateCheckforServiceVf(modelName, cldsModel.getPropText());
342 } catch (IOException | BadRequestException e) {
343 logger.error("Exception occured during duplicate check for service and VF", e);
344 throw new CldsConfigException(e.getMessage(), e);
346 if (cldsModel.getTemplateName() != null) {
347 CldsTemplate template = cldsDao.getTemplate(cldsModel.getTemplateName());
348 if (template != null) {
349 cldsModel.setTemplateId(template.getId());
350 cldsModel.setDocText(template.getPropText());
351 cldsModel.setDocId(template.getPropId());
354 cldsModel.save(cldsDao, getUserId());
356 LoggingUtils.setTimeContext(startTime, new Date());
357 LoggingUtils.setResponseContext("0", "Put model success", this.getClass().getName());
358 auditLogger.info("PUT model completed");
363 * REST service that retrieves a list of CLDS model names.
365 * @return model names in JSON
367 @ApiOperation(value = "Retrieves a list of CLDS model names", notes = "", response = String.class)
369 @Path("/model-names")
370 @Produces(MediaType.APPLICATION_JSON)
371 public List<ValueItem> getModelNames() {
372 Date startTime = new Date();
373 LoggingUtils.setRequestContext("CldsService: GET model names", getPrincipalName());
374 isAuthorized(permissionReadCl);
375 logger.info("GET list of model names");
376 List<ValueItem> names = cldsDao.getBpmnNames();
378 LoggingUtils.setTimeContext(startTime, new Date());
379 LoggingUtils.setResponseContext("0", "Get model names success", this.getClass().getName());
380 auditLogger.info("GET model names completed");
385 * REST service that saves and processes an action for a CLDS model by name.
392 * @throws TransformerException
393 * @throws ParseException
394 * @throws GeneralSecurityException
396 @ApiOperation(value = "Saves and processes an action for a CLDS model by name", notes = "", response = String.class)
398 @Path("/action/{action}/{modelName}")
399 @Consumes(MediaType.APPLICATION_JSON)
400 @Produces(MediaType.APPLICATION_JSON)
401 public CldsModel putModelAndProcessAction(@PathParam("action") String action,
402 @PathParam("modelName") String modelName, @QueryParam("test") String test, CldsModel model)
403 throws TransformerException, ParseException, GeneralSecurityException {
404 Date startTime = new Date();
405 LoggingUtils.setRequestContext("CldsService: Process model action", getPrincipalName());
406 String actionCd = action.toUpperCase();
407 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
408 cldsPermissionInstance, actionCd);
409 isAuthorized(permisionManage);
410 isAuthorizedForVf(model);
411 String userid = getUserId();
412 String actionStateCd = CldsEvent.ACTION_STATE_INITIATED;
413 String processDefinitionKey = "clds-process-action-wf";
414 logger.info("PUT actionCd={}", actionCd);
415 logger.info("PUT actionStateCd={}", actionStateCd);
416 logger.info("PUT processDefinitionKey={}", processDefinitionKey);
417 logger.info("PUT modelName={}", modelName);
418 logger.info("PUT test={}", test);
419 logger.info("PUT bpmnText={}", model.getBpmnText());
420 logger.info("PUT propText={}", model.getPropText());
421 logger.info("PUT userid={}", userid);
422 logger.info("PUT getTypeId={}", model.getTypeId());
423 logger.info("PUT deploymentId={}", model.getDeploymentId());
424 if (model.getTemplateName() != null) {
425 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
426 if (template != null) {
427 model.setTemplateId(template.getId());
428 model.setDocText(template.getPropText());
429 model.setDocId(template.getPropId());
433 model.setName(modelName);
434 model.save(cldsDao, getUserId());
435 // get vars and format if necessary
436 String prop = model.getPropText();
437 String bpmn = model.getBpmnText();
438 String docText = model.getDocText();
439 String controlName = model.getControlName();
440 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
441 logger.info("PUT bpmnJson={}", bpmnJson);
442 // Flag indicates whether it is triggered by Validation Test button from
444 boolean isTest = false;
445 if (test != null && test.equalsIgnoreCase("true")) {
448 String actionTestOverride = refProp.getStringValue("action.test.override");
449 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
450 logger.info("PUT actionTestOverride={}", actionTestOverride);
451 logger.info("PUT override test indicator and setting it to true");
455 logger.info("PUT isTest={}", isTest);
456 boolean isInsertTestEvent = false;
457 String insertTestEvent = refProp.getStringValue("action.insert.test.event");
458 if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
459 isInsertTestEvent = true;
461 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
462 // determine if requested action is permitted
463 model.validateAction(actionCd);
464 // input variables to camunda process
465 Map<String, Object> variables = new HashMap<>();
466 variables.put("actionCd", actionCd);
467 variables.put("modelProp", prop.getBytes());
468 variables.put("modelBpmnProp", bpmnJson);
469 variables.put("modelName", modelName);
470 variables.put("controlName", controlName);
471 variables.put("docText", docText.getBytes());
472 variables.put("isTest", isTest);
473 variables.put("userid", userid);
474 variables.put("isInsertTestEvent", isInsertTestEvent);
475 logger.info("modelProp - " + prop);
476 logger.info("docText - " + docText);
478 // start camunda process
479 ProcessInstance pi = runtimeService.startProcessInstanceByKey(processDefinitionKey, variables);
481 logger.info("Started processDefinitionId={}, processInstanceId={}", pi.getProcessDefinitionId(),
482 pi.getProcessInstanceId());
483 } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
484 logger.error("Exception occured during invoking bpmn process", e);
485 throw new CldsConfigException(e.getMessage(), e);
487 // refresh model info from db (get fresh event info)
488 CldsModel retreivedModel = CldsModel.retrieve(cldsDao, modelName, false);
489 if (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
490 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)) {
491 // To verify inventory status and modify model status to distribute
492 dcaeInventoryServices.setEventInventory(retreivedModel, getUserId());
493 retreivedModel.save(cldsDao, getUserId());
496 LoggingUtils.setTimeContext(startTime, new Date());
497 LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
498 auditLogger.info("Process model action completed");
499 return retreivedModel;
503 * REST service that accepts events for a model.
508 @ApiOperation(value = "Accepts events for a model", notes = "", response = String.class)
511 @Consumes(MediaType.APPLICATION_JSON)
512 @Produces(MediaType.APPLICATION_JSON)
513 public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
514 Date startTime = new Date();
515 LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
516 String userid = null;
517 // TODO: allow auth checking to be turned off by removing the permission
519 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
520 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
521 cldsPermissionInstance, dcaeEvent.getEvent());
522 isAuthorized(permissionEvent);
523 userid = getUserId();
525 // Flag indicates whether it is triggered by Validation Test button from
527 boolean isTest = false;
528 if (test != null && test.equalsIgnoreCase("true")) {
531 int instanceCount = 0;
532 if (dcaeEvent.getInstances() != null) {
533 instanceCount = dcaeEvent.getInstances().size();
535 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
536 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
537 + " instance count=" + instanceCount + " isTest=" + isTest;
538 logger.info("POST dcae event {}", msgInfo);
540 logger.warn("Ignorning test event from DCAE");
542 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
543 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
545 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
546 CldsEvent.ACTION_STATE_RECEIVED, null);
550 LoggingUtils.setTimeContext(startTime, new Date());
551 LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
552 auditLogger.info("Post dcae event completed");
557 * REST service that retrieves sdc services
559 * @throws GeneralSecurityException
560 * In case of issue when decryting the SDC password
563 @ApiOperation(value = "Retrieves sdc services", notes = "", response = String.class)
565 @Path("/sdc/services")
566 @Produces(MediaType.APPLICATION_JSON)
567 public String getSdcServices() throws GeneralSecurityException {
568 Date startTime = new Date();
569 LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
571 String responseStr = sdcCatalogServices.getSdcServicesInformation(null);
573 retStr = createUiServiceFormatJson(responseStr);
574 } catch (IOException e) {
575 logger.error("IOException during SDC communication", e);
576 throw new SdcCommunicationException("IOException during SDC communication", e);
578 logger.info("value of sdcServices : {}", retStr);
580 LoggingUtils.setTimeContext(startTime, new Date());
581 LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
582 auditLogger.info("GET sdc services completed");
587 * REST service that retrieves total properties required by UI
589 * @throws IOException
593 @ApiOperation(value = "Retrieves total properties required by UI", notes = "", response = String.class)
596 @Produces(MediaType.APPLICATION_JSON)
597 public String getSdcProperties() throws IOException {
598 return createPropertiesObjectByUUID(getGlobalCldsString(), "{}");
602 * REST service that retrieves total properties by using invariantUUID based
603 * on refresh and non refresh
605 * @throws GeneralSecurityException
606 * In case of issue when decryting the SDC password
609 @ApiOperation(value = "Retrieves total properties by using invariantUUID based on refresh and non refresh", notes = "", response = String.class)
611 @Path("/properties/{serviceInvariantUUID}")
612 @Produces(MediaType.APPLICATION_JSON)
613 public String getSdcPropertiesByServiceUUIDForRefresh(
614 @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
615 @DefaultValue("false") @QueryParam("refresh") String refresh) throws GeneralSecurityException {
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 boolean isCldsSdcDataExpired = true;
621 // To getcldsService information from database cache using invariantUUID
622 // only when refresh = false
623 if (refresh != null && refresh.equalsIgnoreCase("false")) {
624 cldsServiceData = cldsServiceData.getCldsServiceCache(cldsDao, serviceInvariantUUID);
625 // If cldsService is available in database Cache , verify is data
627 if (cldsServiceData != null) {
628 isCldsSdcDataExpired = sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData);
631 // If user Requested for refresh or database cache expired , get all
632 // data from sdc api.
633 if ((refresh != null && refresh.equalsIgnoreCase("true")) || isCldsSdcDataExpired) {
634 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
635 CldsDBServiceCache cldsDBServiceCache = sdcCatalogServices
636 .getCldsDbServiceCacheUsingCldsServiceData(cldsServiceData);
637 if (cldsDBServiceCache != null && cldsDBServiceCache.getInvariantId() != null
638 && cldsDBServiceCache.getServiceId() != null) {
639 cldsServiceData.setCldsServiceCache(cldsDao, cldsDBServiceCache);
642 // filter out VFs the user is not authorized for
643 cldsServiceData.filterVfs(this);
644 // format retrieved data into properties json
645 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(getGlobalCldsString(), cldsServiceData);
647 LoggingUtils.setTimeContext(startTime, new Date());
648 LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
649 auditLogger.info("GET sdc properties by uuid completed");
650 return sdcProperties;
654 * Determine if the user is authorized for a particular VF by its invariant
657 * @param vfInvariantUuid
658 * @throws NotAuthorizedException
661 public boolean isAuthorizedForVf(String vfInvariantUuid) {
662 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
663 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
664 cldsPermissionInstance, vfInvariantUuid);
665 return isAuthorized(permission);
667 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
668 // VF filtering is turned off
669 logger.warn("VF filtering turned off");
675 * Determine if the user is authorized for a particular VF by its invariant
676 * UUID. If not authorized, then NotAuthorizedException is thrown.
681 private boolean isAuthorizedForVf(CldsModel model) {
682 String vf = ModelProperties.getVf(model);
683 if (vf == null || vf.length() == 0) {
684 logger.info("VF not found in model");
687 return isAuthorizedForVf(vf);
691 private String createUiServiceFormatJson(String responseStr) throws IOException {
692 if (StringUtils.isBlank(responseStr)) {
695 ObjectMapper objectMapper = new ObjectMapper();
696 List<CldsSdcServiceInfo> rawList = objectMapper.readValue(responseStr,
697 objectMapper.getTypeFactory().constructCollectionType(List.class, CldsSdcServiceInfo.class));
698 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
699 ObjectNode serviceNode = objectMapper.createObjectNode();
700 logger.info("value of cldsserviceiNfolist: {}", rawList);
701 if (rawList != null && !rawList.isEmpty()) {
702 List<CldsSdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
703 for (CldsSdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
704 if (currCldsSdcServiceInfo != null) {
705 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
706 currCldsSdcServiceInfo.getName());
709 serviceNode.putPOJO("service", invariantIdServiceNode);
711 return serviceNode.toString();
714 private String createPropertiesObjectByUUID(String globalProps, String cldsResponseStr) throws IOException {
715 ObjectMapper mapper = new ObjectMapper();
716 CldsSdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, CldsSdcServiceDetail.class);
717 ObjectNode globalPropsJson = null;
718 if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
720 * to create json with vf, alarm and locations
722 ObjectNode serviceObjectNode = createEmptyVfAlarmObject(mapper);
723 ObjectNode vfObjectNode = mapper.createObjectNode();
725 * to create json with vf and vfresourceId
727 createVfObjectNode(vfObjectNode, mapper, cldsSdcServiceDetail.getResources());
728 serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
729 ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
730 byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
732 * to create json with VFC Node
734 ObjectNode emptyvfcobjectNode = createByVFCObjectNode(mapper, cldsSdcServiceDetail.getResources());
735 byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
736 globalPropsJson = (ObjectNode) mapper.readValue(globalProps, JsonNode.class);
737 globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
738 logger.info("valuie of objNode: {}", globalPropsJson);
741 * to create json with total properties when no serviceUUID passed
743 globalPropsJson = (ObjectNode) mapper.readValue(globalProps, JsonNode.class);
745 return globalPropsJson.toString();
748 private ObjectNode createEmptyVfAlarmObject(ObjectMapper mapper) {
749 ObjectNode emptyObjectNode = mapper.createObjectNode();
750 emptyObjectNode.put("", "");
751 ObjectNode vfObjectNode = mapper.createObjectNode();
752 vfObjectNode.putPOJO("vf", emptyObjectNode);
753 vfObjectNode.putPOJO("location", emptyObjectNode);
754 vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
755 ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
756 emptyServiceObjectNode.putPOJO("", vfObjectNode);
757 return emptyServiceObjectNode;
760 private void createVfObjectNode(ObjectNode vfObjectNode2, ObjectMapper mapper,
761 List<CldsSdcResource> rawCldsSdcResourceList) {
762 ObjectNode vfNode = mapper.createObjectNode();
764 // To remove repeated resource instance name from
765 // resourceInstanceList
766 List<CldsSdcResource> cldsSdcResourceList = sdcCatalogServices
767 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
769 * Creating vf resource node using cldsSdcResource Object
771 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
772 for (CldsSdcResource cldsSdcResource : cldsSdcResourceList) {
773 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
774 vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
778 vfObjectNode2.putPOJO("vf", vfNode);
780 * creating location json object using properties file value
782 ObjectNode locationJsonNode;
784 locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
786 } catch (IOException e) {
787 logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
788 throw new CldsConfigException(
789 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
791 vfObjectNode2.putPOJO("location", locationJsonNode);
793 * creating alarm json object using properties file value
795 String alarmStringValue = refProp.getStringValue("ui.alarm.default");
796 logger.info("value of alarm: {}", alarmStringValue);
797 ObjectNode alarmStringJsonNode;
799 alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
800 } catch (IOException e) {
801 logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
802 throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
805 vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
808 private ObjectNode createByVFCObjectNode(ObjectMapper mapper, List<CldsSdcResource> cldsSdcResourceList) {
809 ObjectNode emptyObjectNode = mapper.createObjectNode();
810 ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
811 ObjectNode vfCObjectNode = mapper.createObjectNode();
812 vfCObjectNode.putPOJO("vfC", emptyObjectNode);
813 ObjectNode subVfCObjectNode = mapper.createObjectNode();
814 subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
815 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
816 for (CldsSdcResource cldsSdcResource : cldsSdcResourceList) {
817 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
818 vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
822 emptyvfcobjectNode.putPOJO("", vfCObjectNode);
823 return emptyvfcobjectNode;
827 @Path("/deploy/{modelName}")
828 @Consumes(MediaType.APPLICATION_JSON)
829 @Produces(MediaType.APPLICATION_JSON)
830 public CldsModel deployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
831 @QueryParam("test") String test, CldsModel model) throws IOException {
832 Date startTime = new Date();
833 LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
834 String deploymentId = "";
835 // If model is already deployed then pass same deployment id
836 if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
837 deploymentId = model.getDeploymentId();
839 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
841 String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
843 String operationStatus = "processing";
844 long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
845 while ("processing".equalsIgnoreCase(operationStatus)) {
846 // Break the loop if waiting for more than 10 mins
847 if (waitingTime < System.nanoTime()) {
850 operationStatus = dcaeDispatcherServices.getOperationStatus(createNewDeploymentStatusUrl);
852 if ("succeeded".equalsIgnoreCase(operationStatus)) {
853 String artifactName = model.getControlName();
854 if (artifactName != null) {
855 artifactName = artifactName + ".yml";
857 DcaeEvent dcaeEvent = new DcaeEvent();
858 /* set dcae events */
859 dcaeEvent.setArtifactName(artifactName);
860 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
861 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
862 CldsEvent.ACTION_STATE_RECEIVED, null);
863 model.setDeploymentId(deploymentId);
864 model.save(cldsDao, getUserId());
866 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
867 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
868 "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
870 logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
872 LoggingUtils.setTimeContext(startTime, new Date());
873 LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
874 auditLogger.info("Deploy model completed");
879 @Path("/undeploy/{modelName}")
880 @Consumes(MediaType.APPLICATION_JSON)
881 @Produces(MediaType.APPLICATION_JSON)
882 public CldsModel unDeployModel(@PathParam("action") String action, @PathParam("modelName") String modelName,
883 @QueryParam("test") String test, CldsModel model) throws IOException {
884 Date startTime = new Date();
885 LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
886 String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
888 String operationStatus = "processing";
889 long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
890 while ("processing".equalsIgnoreCase(operationStatus)) {
891 if (waitingTime < System.nanoTime()) {
894 operationStatus = dcaeDispatcherServices.getOperationStatus(operationStatusUndeployUrl);
896 if ("succeeded".equalsIgnoreCase(operationStatus)) {
897 String artifactName = model.getControlName();
898 if (artifactName != null) {
899 artifactName = artifactName + ".yml";
901 DcaeEvent dcaeEvent = new DcaeEvent();
903 dcaeEvent.setArtifactName(artifactName);
904 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
905 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
906 CldsEvent.ACTION_STATE_RECEIVED, null);
907 model.setDeploymentId(null);
908 model.save(cldsDao, getUserId());
910 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
911 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
912 "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
914 logger.info("Undeploy model (" + modelName + ") succeeded.");
916 LoggingUtils.setTimeContext(startTime, new Date());
917 LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
918 auditLogger.info("Undeploy model completed");
922 private String getGlobalCldsString() {
924 if (null == globalCldsProperties) {
925 globalCldsProperties = new Properties();
926 globalCldsProperties.load(appContext.getResource(globalClds).getInputStream());
928 return (String) globalCldsProperties.get("globalCldsProps");
929 } catch (IOException e) {
930 logger.error("Unable to load the globalClds due to an exception", e);
931 throw new CldsConfigException("Unable to load the globalClds due to an exception", e);
935 private void duplicateCheckforServiceVf(String modelName, String modelPropText) throws IOException {
936 JsonNode modelJson = new ObjectMapper().readTree(modelPropText);
937 JsonNode globalNode = modelJson.get("global");
938 String service = AbstractModelElement.getValueByName(globalNode, "service");
939 List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
940 if (resourceVf != null && !resourceVf.isEmpty()) {
941 List<CldsModelProp> cldsModelPropList = cldsDao.getAllModelProperties();
942 for (CldsModelProp cldsModelProp : cldsModelPropList) {
943 JsonNode currentJson = new ObjectMapper().readTree(cldsModelProp.getPropText());
944 JsonNode currentNode = currentJson.get("global");
945 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
946 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
947 if (currentVf != null && !currentVf.isEmpty()) {
948 if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
949 && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
950 throw new BadRequestException("Same service/VF already exists in " + cldsModelProp.getName()
951 + " model, please select different service/VF.");