2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 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 * ===================================================================
24 package org.onap.clamp.clds.service;
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;
32 import java.io.IOException;
33 import java.io.InputStream;
34 import java.security.GeneralSecurityException;
35 import java.util.Date;
36 import java.util.List;
37 import java.util.Properties;
38 import java.util.UUID;
40 import javax.annotation.PostConstruct;
41 import javax.ws.rs.BadRequestException;
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.ws.rs.core.Response;
54 import javax.xml.transform.TransformerException;
56 import org.apache.camel.Produce;
57 import org.apache.commons.codec.DecoderException;
58 import org.apache.commons.lang3.StringUtils;
59 import org.json.simple.parser.ParseException;
60 import org.onap.clamp.clds.camel.CamelProxy;
61 import org.onap.clamp.clds.client.DcaeDispatcherServices;
62 import org.onap.clamp.clds.client.DcaeInventoryServices;
63 import org.onap.clamp.clds.client.req.sdc.SdcCatalogServices;
64 import org.onap.clamp.clds.config.ClampProperties;
65 import org.onap.clamp.clds.dao.CldsDao;
66 import org.onap.clamp.clds.exception.CldsConfigException;
67 import org.onap.clamp.clds.exception.policy.PolicyClientException;
68 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
69 import org.onap.clamp.clds.model.CldsDbServiceCache;
70 import org.onap.clamp.clds.model.CldsEvent;
71 import org.onap.clamp.clds.model.CldsHealthCheck;
72 import org.onap.clamp.clds.model.CldsInfo;
73 import org.onap.clamp.clds.model.CldsModel;
74 import org.onap.clamp.clds.model.CldsModelProp;
75 import org.onap.clamp.clds.model.CldsMonitoringDetails;
76 import org.onap.clamp.clds.model.CldsServiceData;
77 import org.onap.clamp.clds.model.CldsTemplate;
78 import org.onap.clamp.clds.model.DcaeEvent;
79 import org.onap.clamp.clds.model.ValueItem;
80 import org.onap.clamp.clds.model.properties.AbstractModelElement;
81 import org.onap.clamp.clds.model.properties.ModelProperties;
82 import org.onap.clamp.clds.model.sdc.SdcResource;
83 import org.onap.clamp.clds.model.sdc.SdcServiceDetail;
84 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
85 import org.onap.clamp.clds.sdc.controller.installer.CsarInstallerImpl;
86 import org.onap.clamp.clds.transform.XslTransformer;
87 import org.onap.clamp.clds.util.JacksonUtils;
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;
96 * Service to save and retrieve the CLDS model attributes.
100 public class CldsService extends SecureServiceBase {
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;
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,
130 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
135 private CldsDao cldsDao;
137 private XslTransformer cldsBpmnTransformer;
139 private ClampProperties refProp;
141 private SdcCatalogServices sdcCatalogServices;
143 private DcaeDispatcherServices dcaeDispatcherServices;
145 private DcaeInventoryServices dcaeInventoryServices;
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.
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 = cldsDao.getCLDSMonitoringDetails();
165 LoggingUtils.setTimeContext(startTime, new Date());
166 LoggingUtils.setResponseContext("0", "Get cldsDetails success", this.getClass().getName());
167 auditLogger.info("GET cldsDetails completed");
168 return cldsMonitoringDetailsList;
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
177 @Produces(MediaType.APPLICATION_JSON)
178 public CldsInfo getCldsInfo() {
179 CldsInfo cldsInfo = new CldsInfo();
180 Date startTime = new Date();
181 LoggingUtils.setRequestContext("CldsService: GET cldsInfo", getPrincipalName());
182 LoggingUtils.setTimeContext(startTime, new Date());
184 cldsInfo.setUserName(getUserName());
185 // Get CLDS application version
186 String cldsVersion = "";
187 Properties props = new Properties();
188 ClassLoader loader = Thread.currentThread().getContextClassLoader();
189 try (InputStream resourceStream = loader.getResourceAsStream(RESOURCE_NAME)) {
190 props.load(resourceStream);
191 cldsVersion = props.getProperty("clds.version");
192 } catch (Exception ex) {
193 logger.error("Exception caught during the clds.version reading", ex);
195 cldsInfo.setCldsVersion(cldsVersion);
196 // Get the user list of permissions
197 cldsInfo.setPermissionReadCl(isAuthorizedNoException(permissionReadCl));
198 cldsInfo.setPermissionUpdateCl(isAuthorizedNoException(permissionUpdateCl));
199 cldsInfo.setPermissionReadTemplate(isAuthorizedNoException(permissionReadTemplate));
200 cldsInfo.setPermissionUpdateTemplate(isAuthorizedNoException(permissionUpdateTemplate));
202 LoggingUtils.setTimeContext(startTime, new Date());
203 LoggingUtils.setResponseContext("0", "Get cldsInfo success", this.getClass().getName());
204 securityLogger.info("GET cldsInfo completed");
209 * REST service that retrieves clds healthcheck information.
211 * @return CldsHealthCheck class containing healthcheck info
214 @Path("/healthcheck")
215 @Produces(MediaType.APPLICATION_JSON)
216 public Response gethealthcheck() {
217 CldsHealthCheck cldsHealthCheck = new CldsHealthCheck();
218 Date startTime = new Date();
219 LoggingUtils.setRequestContext("CldsService: GET healthcheck", "Clamp-Health-Check");
220 LoggingUtils.setTimeContext(startTime, new Date());
221 boolean healthcheckFailed = false;
223 cldsDao.doHealthCheck();
224 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
225 cldsHealthCheck.setHealthCheckStatus("UP");
226 cldsHealthCheck.setDescription("OK");
227 LoggingUtils.setResponseContext("0", "Get healthcheck success", this.getClass().getName());
228 } catch (Exception e) {
229 healthcheckFailed = true;
230 logger.error("CLAMP application DB Error", e);
231 LoggingUtils.setResponseContext("999", "Get healthcheck failed", this.getClass().getName());
232 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
233 cldsHealthCheck.setHealthCheckStatus("DOWN");
234 cldsHealthCheck.setDescription("NOT-OK");
237 LoggingUtils.setTimeContext(startTime, new Date());
238 logger.info("GET healthcheck completed");
239 if (healthcheckFailed) {
240 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(cldsHealthCheck).build();
242 return Response.status(Response.Status.OK).entity(cldsHealthCheck).build();
247 * REST service that retrieves BPMN for a CLDS model name from the database.
248 * This is subset of the json getModel. This is only expected to be used for
249 * testing purposes, not by the UI.
252 * @return bpmn xml text - content of bpmn given name
255 @Path("/model/bpmn/{modelName}")
256 @Produces(MediaType.TEXT_XML)
257 public String getBpmnXml(@PathParam("modelName") String modelName) {
258 Date startTime = new Date();
259 LoggingUtils.setRequestContext("CldsService: GET model bpmn", getPrincipalName());
260 isAuthorized(permissionReadCl);
261 logger.info("GET bpmnText for modelName={}", modelName);
262 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
264 LoggingUtils.setTimeContext(startTime, new Date());
265 LoggingUtils.setResponseContext("0", "Get model bpmn success", this.getClass().getName());
266 auditLogger.info("GET model bpmn completed");
267 return model.getBpmnText();
271 * REST service that retrieves image for a CLDS model name from the
272 * database. This is subset of the json getModel. This is only expected to
273 * be used for testing purposes, not by the UI.
276 * @return image xml text - content of image given name
279 @Path("/model/image/{modelName}")
280 @Produces(MediaType.TEXT_XML)
281 public String getImageXml(@PathParam("modelName") String modelName) {
282 Date startTime = new Date();
283 LoggingUtils.setRequestContext("CldsService: GET model image", getPrincipalName());
284 isAuthorized(permissionReadCl);
285 logger.info("GET imageText for modelName={}", modelName);
286 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
288 LoggingUtils.setTimeContext(startTime, new Date());
289 LoggingUtils.setResponseContext("0", "Get model image success", this.getClass().getName());
290 auditLogger.info("GET model image completed");
291 return model.getImageText();
295 * REST service that retrieves a CLDS model by name from the database.
298 * @return clds model - clds model for the given model name
301 @Path("/model/{modelName}")
302 @Produces(MediaType.APPLICATION_JSON)
303 public CldsModel getModel(@PathParam("modelName") String modelName) {
304 Date startTime = new Date();
305 LoggingUtils.setRequestContext("CldsService: GET model", getPrincipalName());
306 isAuthorized(permissionReadCl);
307 logger.debug("GET model for modelName={}", modelName);
308 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
309 isAuthorizedForVf(cldsModel);
310 // Checking condition whether our CLDS model can call Inventory Method
311 if (cldsModel.canInventoryCall()) {
313 // Method to call dcae inventory and invoke insert event method
314 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
315 } catch (Exception e) {
316 LoggingUtils.setErrorContext("900", "Set event inventory error");
317 logger.error("getModel set event Inventory error:" + e);
321 LoggingUtils.setTimeContext(startTime, new Date());
322 LoggingUtils.setResponseContext("0", "Get model success", this.getClass().getName());
323 auditLogger.info("GET model completed");
328 * REST service that saves a CLDS model by name in the database.
333 @Path("/model/{modelName}")
334 @Consumes(MediaType.APPLICATION_JSON)
335 @Produces(MediaType.APPLICATION_JSON)
336 public CldsModel putModel(@PathParam("modelName") String modelName, CldsModel cldsModel) {
337 Date startTime = new Date();
338 LoggingUtils.setRequestContext("CldsService: PUT model", getPrincipalName());
339 isAuthorized(permissionUpdateCl);
340 isAuthorizedForVf(cldsModel);
341 logger.info("PUT model for modelName={}", modelName);
342 logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
343 logger.info("PUT propText={}", cldsModel.getPropText());
344 logger.info("PUT imageText={}", cldsModel.getImageText());
345 cldsModel.setName(modelName);
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 // This is to provide the Bpmn XML when Template part in UI is
353 cldsModel.setBpmnText(template.getBpmnText());
356 updateAndInsertNewEvent(cldsModel.getName(), cldsModel.getControlNamePrefix(), cldsModel.getEvent(),
357 CldsEvent.ACTION_MODIFY);
358 cldsModel.save(cldsDao, getUserId());
360 LoggingUtils.setTimeContext(startTime, new Date());
361 LoggingUtils.setResponseContext("0", "Put model success", this.getClass().getName());
362 auditLogger.info("PUT model completed");
367 * REST service that retrieves a list of CLDS model names.
369 * @return model names in JSON
372 @Path("/model-names")
373 @Produces(MediaType.APPLICATION_JSON)
374 public List<ValueItem> getModelNames() {
375 Date startTime = new Date();
376 LoggingUtils.setRequestContext("CldsService: GET model names", getPrincipalName());
377 isAuthorized(permissionReadCl);
378 logger.info("GET list of model names");
379 List<ValueItem> names = cldsDao.getBpmnNames();
381 LoggingUtils.setTimeContext(startTime, new Date());
382 LoggingUtils.setResponseContext("0", "Get model names success", this.getClass().getName());
383 auditLogger.info("GET model names completed");
387 private void fillInCldsModel(CldsModel model) {
388 if (model.getTemplateName() != null) {
389 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
390 if (template != null) {
391 model.setTemplateId(template.getId());
392 model.setDocText(template.getPropText());
393 // This is to provide the Bpmn XML when Template part in UI
396 model.setBpmnText(template.getBpmnText());
402 * REST service that saves and processes an action for a CLDS model by name.
409 * @throws TransformerException
410 * In case of issues when doing the XSLT of the BPMN flow
411 * @throws ParseException
412 * In case of issues when parsing the JSON
413 * @throws GeneralSecurityException
414 * In case of issues when decrypting the password
415 * @throws DecoderException
416 * In case of issues with the Hex String decoding
419 @Path("/action/{action}/{modelName}")
420 @Consumes(MediaType.APPLICATION_JSON)
421 @Produces(MediaType.APPLICATION_JSON)
422 public Response putModelAndProcessAction(@PathParam("action") String action,
423 @PathParam("modelName") String modelName, @QueryParam("test") String test, CldsModel model)
424 throws TransformerException, ParseException {
425 Date startTime = new Date();
426 CldsModel retrievedModel = null;
427 Boolean errorCase = false;
429 LoggingUtils.setRequestContext("CldsService: Process model action", getPrincipalName());
430 String actionCd = action.toUpperCase();
431 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
432 cldsPermissionInstance, actionCd);
433 isAuthorized(permisionManage);
434 isAuthorizedForVf(model);
435 String userId = getUserId();
436 logger.info("PUT actionCd={}", actionCd);
437 logger.info("PUT modelName={}", modelName);
438 logger.info("PUT test={}", test);
439 logger.info("PUT bpmnText={}", model.getBpmnText());
440 logger.info("PUT propText={}", model.getPropText());
441 logger.info("PUT userId={}", userId);
442 logger.info("PUT getTypeId={}", model.getTypeId());
443 logger.info("PUT deploymentId={}", model.getDeploymentId());
444 this.fillInCldsModel(model);
446 model.setName(modelName);
447 updateAndInsertNewEvent(modelName, model.getControlNamePrefix(), model.getEvent(), CldsEvent.ACTION_MODIFY);
448 model.save(cldsDao, getUserId());
449 // get vars and format if necessary
450 String prop = model.getPropText();
451 String bpmn = model.getBpmnText();
452 String docText = model.getDocText();
453 String controlName = model.getControlName();
454 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
455 logger.info("PUT bpmnJson={}", bpmnJson);
456 // Flag indicates whether it is triggered by Validation Test button
459 boolean isTest = false;
460 if (test != null && test.equalsIgnoreCase("true")) {
463 String actionTestOverride = refProp.getStringValue("action.test.override");
464 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
465 logger.info("PUT actionTestOverride={}", actionTestOverride);
466 logger.info("PUT override test indicator and setting it to true");
470 logger.info("PUT isTest={}", isTest);
471 boolean isInsertTestEvent = false;
472 String insertTestEvent = refProp.getStringValue("action.insert.test.event");
473 if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
474 isInsertTestEvent = true;
476 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
477 // determine if requested action is permitted
478 model.validateAction(actionCd);
479 logger.info("modelProp - " + prop);
480 logger.info("docText - " + docText);
482 String result = camelProxy.submit(actionCd, prop, bpmnJson, modelName, controlName, docText, isTest,
483 userId, isInsertTestEvent, model.getEvent().getActionCd());
484 logger.info("Starting Camel flow on request, result is: ", result);
485 } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
487 logger.error("Exception occured during invoking Camel process", e);
489 if (!actionCd.equalsIgnoreCase(CldsEvent.ACTION_DELETE)) {
490 // refresh model info from db (get fresh event info)
491 retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
493 if (!isTest && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
494 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
495 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
496 if (retrievedModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
498 logger.info("Skipping DCAE inventory call as closed loop has been created from SDC notification");
499 DcaeEvent dcaeEvent = new DcaeEvent();
500 dcaeEvent.setArtifactName(retrievedModel.getControlName() + ".yml");
501 dcaeEvent.setEvent(DcaeEvent.EVENT_DISTRIBUTION);
502 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userId, dcaeEvent.getCldsActionCd(),
503 CldsEvent.ACTION_STATE_RECEIVED, null);
505 // This should be done only when the call to DCAE
506 // has not yet been done. When CL comes from SDC
507 // this is not required as the DCAE inventory call is done
508 // during the CL deployment.
509 dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
511 retrievedModel.save(cldsDao, getUserId());
514 LoggingUtils.setTimeContext(startTime, new Date());
515 LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
516 auditLogger.info("Process model action completed");
517 } catch (Exception e) {
519 logger.error("Exception occured during putModelAndProcessAction", e);
522 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(retrievedModel).build();
524 return Response.status(Response.Status.OK).entity(retrievedModel).build();
528 * REST service that accepts events for a model.
535 @Consumes(MediaType.APPLICATION_JSON)
536 @Produces(MediaType.APPLICATION_JSON)
537 public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
538 Date startTime = new Date();
539 LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
540 String userid = null;
541 // TODO: allow auth checking to be turned off by removing the permission
543 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
544 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
545 cldsPermissionInstance, dcaeEvent.getEvent());
546 isAuthorized(permissionEvent);
547 userid = getUserId();
549 // Flag indicates whether it is triggered by Validation Test button from
551 boolean isTest = false;
552 if (test != null && test.equalsIgnoreCase("true")) {
555 int instanceCount = 0;
556 if (dcaeEvent.getInstances() != null) {
557 instanceCount = dcaeEvent.getInstances().size();
559 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
560 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
561 + " instance count=" + instanceCount + " isTest=" + isTest;
562 logger.info("POST dcae event {}", msgInfo);
564 logger.warn("Ignorning test event from DCAE");
566 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
567 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
569 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
570 CldsEvent.ACTION_STATE_RECEIVED, null);
574 LoggingUtils.setTimeContext(startTime, new Date());
575 LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
576 auditLogger.info("Post dcae event completed");
581 * REST service that retrieves sdc services
583 * @throws GeneralSecurityException
584 * In case of issue when decryting the SDC password
585 * @throws DecoderException
586 * In case of issues with the decoding of the Hex String
589 @Path("/sdc/services")
590 @Produces(MediaType.APPLICATION_JSON)
591 public String getSdcServices() throws GeneralSecurityException, DecoderException {
592 Date startTime = new Date();
593 LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
596 retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
597 } catch (IOException e) {
598 logger.error("IOException during SDC communication", e);
599 throw new SdcCommunicationException("IOException during SDC communication", e);
601 logger.info("value of sdcServices : {}", retStr);
603 LoggingUtils.setTimeContext(startTime, new Date());
604 LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
605 auditLogger.info("GET sdc services completed");
610 * REST service that retrieves total properties required by UI
612 * @throws IOException
617 @Produces(MediaType.APPLICATION_JSON)
618 public String getSdcProperties() throws IOException {
619 return createPropertiesObjectByUUID("{}");
623 * REST service that retrieves total properties by using invariantUUID based
624 * on refresh and non refresh
626 * @throws GeneralSecurityException
627 * In case of issues with the decryting the encrypted password
628 * @throws DecoderException
629 * In case of issues with the decoding of the Hex String
630 * @throws IOException
631 * In case of issue to convert CldsServiceCache to InputStream
634 @Path("/properties/{serviceInvariantUUID}")
635 @Produces(MediaType.APPLICATION_JSON)
636 public String getSdcPropertiesByServiceUUIDForRefresh(
637 @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
638 @DefaultValue("false") @QueryParam("refresh") boolean refresh)
639 throws GeneralSecurityException, DecoderException, IOException {
640 Date startTime = new Date();
641 LoggingUtils.setRequestContext("CldsService: GET sdc properties by uuid", getPrincipalName());
642 CldsServiceData cldsServiceData = new CldsServiceData();
643 cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
645 cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
647 if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
648 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
649 cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
651 // filter out VFs the user is not authorized for
652 cldsServiceData.filterVfs(this);
653 // format retrieved data into properties json
654 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
656 LoggingUtils.setTimeContext(startTime, new Date());
657 LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
658 auditLogger.info("GET sdc properties by uuid completed");
659 return sdcProperties;
663 * Determine if the user is authorized for a particular VF by its invariant
666 * @param vfInvariantUuid
667 * @throws NotAuthorizedException
670 public boolean isAuthorizedForVf(String vfInvariantUuid) {
671 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
672 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
673 cldsPermissionInstance, vfInvariantUuid);
674 return isAuthorized(permission);
676 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
677 // VF filtering is turned off
678 logger.warn("VF filtering turned off");
684 * Determine if the user is authorized for a particular VF by its invariant
685 * UUID. If not authorized, then NotAuthorizedException is thrown.
690 private boolean isAuthorizedForVf(CldsModel model) {
691 String vf = ModelProperties.getVf(model);
692 if (vf == null || vf.length() == 0) {
693 logger.info("VF not found in model");
696 return isAuthorizedForVf(vf);
700 private String createUiServiceFormatJson(String responseStr) throws IOException {
701 if (StringUtils.isBlank(responseStr)) {
704 ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
705 List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
706 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
707 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
708 ObjectNode serviceNode = objectMapper.createObjectNode();
709 logger.info("value of cldsserviceiNfolist: {}", rawList);
710 if (rawList != null && !rawList.isEmpty()) {
711 List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
712 for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
713 if (currCldsSdcServiceInfo != null) {
714 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
715 currCldsSdcServiceInfo.getName());
718 serviceNode.putPOJO("service", invariantIdServiceNode);
720 return serviceNode.toString();
723 private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
724 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
725 SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
726 ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
727 if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
729 * to create json with vf, alarm and locations
731 ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
732 ObjectNode vfObjectNode = mapper.createObjectNode();
734 * to create json with vf and vfresourceId
736 createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
737 serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
738 ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
739 byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
741 * to create json with VFC Node
743 ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
744 byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
745 globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
746 logger.info("valuie of objNode: {}", globalPropsJson);
748 return globalPropsJson.toString();
751 private ObjectNode createEmptyVfAlarmObject() {
752 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
753 ObjectNode emptyObjectNode = mapper.createObjectNode();
754 emptyObjectNode.put("", "");
755 ObjectNode vfObjectNode = mapper.createObjectNode();
756 vfObjectNode.putPOJO("vf", emptyObjectNode);
757 vfObjectNode.putPOJO("location", emptyObjectNode);
758 vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
759 ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
760 emptyServiceObjectNode.putPOJO("", vfObjectNode);
761 return emptyServiceObjectNode;
764 private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
765 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
766 ObjectNode vfNode = mapper.createObjectNode();
768 // To remove repeated resource instance name from
769 // resourceInstanceList
770 List<SdcResource> cldsSdcResourceList = sdcCatalogServices
771 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
773 * Creating vf resource node using cldsSdcResource Object
775 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
776 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
777 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
778 vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
782 vfObjectNode2.putPOJO("vf", vfNode);
784 * creating location json object using properties file value
786 ObjectNode locationJsonNode;
788 locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
790 } catch (IOException e) {
791 logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
792 throw new CldsConfigException(
793 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
795 vfObjectNode2.putPOJO("location", locationJsonNode);
797 * creating alarm json object using properties file value
799 String alarmStringValue = refProp.getStringValue("ui.alarm.default");
800 logger.info("value of alarm: {}", alarmStringValue);
801 ObjectNode alarmStringJsonNode;
803 alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
804 } catch (IOException e) {
805 logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
806 throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
809 vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
812 private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
813 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
814 ObjectNode emptyObjectNode = mapper.createObjectNode();
815 ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
816 ObjectNode vfCObjectNode = mapper.createObjectNode();
817 vfCObjectNode.putPOJO("vfC", emptyObjectNode);
818 ObjectNode subVfCObjectNode = mapper.createObjectNode();
819 subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
820 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
821 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
822 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
823 vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
827 emptyvfcobjectNode.putPOJO("", vfCObjectNode);
828 return emptyvfcobjectNode;
832 @Path("/deploy/{modelName}")
833 @Consumes(MediaType.APPLICATION_JSON)
834 @Produces(MediaType.APPLICATION_JSON)
835 public Response deployModel(@PathParam("modelName") String modelName, CldsModel model) {
836 Date startTime = new Date();
837 LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
838 Boolean errorCase = false;
840 fillInCldsModel(model);
841 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
842 logger.info("PUT bpmnJson={}", bpmnJson);
843 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
844 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
845 isAuthorized(permisionManage);
846 isAuthorizedForVf(model);
847 ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
848 false, bpmnJson, model.getPropText());
849 checkForDuplicateServiceVf(modelName, model.getPropText());
850 String deploymentId = "";
851 // If model is already deployed then pass same deployment id
852 if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
853 deploymentId = model.getDeploymentId();
855 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
857 String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
858 model.getTypeId(), modelProp.getGlobal().getDeployParameters());
859 String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(createNewDeploymentStatusUrl);
860 if ("succeeded".equalsIgnoreCase(operationStatus)) {
861 String artifactName = model.getControlName();
862 if (artifactName != null) {
863 artifactName = artifactName + ".yml";
865 DcaeEvent dcaeEvent = new DcaeEvent();
866 /* set dcae events */
867 dcaeEvent.setArtifactName(artifactName);
868 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
869 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
870 CldsEvent.ACTION_STATE_RECEIVED, null);
871 model.setDeploymentId(deploymentId);
872 model.save(cldsDao, getUserId());
874 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
875 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
876 "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
878 logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
880 LoggingUtils.setTimeContext(startTime, new Date());
881 LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
882 auditLogger.info("Deploy model completed");
883 } catch (Exception e) {
885 logger.error("Exception occured during deployModel", e);
888 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
890 return Response.status(Response.Status.OK).entity(model).build();
894 @Path("/undeploy/{modelName}")
895 @Consumes(MediaType.APPLICATION_JSON)
896 @Produces(MediaType.APPLICATION_JSON)
897 public Response unDeployModel(@PathParam("modelName") String modelName, CldsModel model) {
898 Date startTime = new Date();
899 LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
900 Boolean errorCase = false;
902 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
903 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
904 isAuthorized(permisionManage);
905 isAuthorizedForVf(model);
906 String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
908 String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(operationStatusUndeployUrl);
909 if ("succeeded".equalsIgnoreCase(operationStatus)) {
910 String artifactName = model.getControlName();
911 if (artifactName != null) {
912 artifactName = artifactName + ".yml";
914 DcaeEvent dcaeEvent = new DcaeEvent();
916 dcaeEvent.setArtifactName(artifactName);
917 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
918 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
919 CldsEvent.ACTION_STATE_RECEIVED, null);
920 model.setDeploymentId(null);
921 model.save(cldsDao, getUserId());
923 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
924 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
925 "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
927 logger.info("Undeploy model (" + modelName + ") succeeded.");
929 LoggingUtils.setTimeContext(startTime, new Date());
930 LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
931 auditLogger.info("Undeploy model completed");
932 } catch (Exception e) {
934 logger.error("Exception occured during unDeployModel", e);
937 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
939 return Response.status(Response.Status.OK).entity(model).build();
942 private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
943 JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
944 String service = AbstractModelElement.getValueByName(globalNode, "service");
945 List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
946 if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
947 List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
948 for (CldsModelProp cldsModelProp : cldsModelPropList) {
949 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
951 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
952 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
953 if (currentVf != null && !currentVf.isEmpty()) {
954 if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
955 && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
956 throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
957 + " model, please select different Service/VF.");
964 private void updateAndInsertNewEvent(String cldsModelName, String cldsControlNamePrfx, CldsEvent event,
966 // If model action is in submit/resubmit/distributed and user try
967 // to save then we are changing action back to create.
968 if (event != null && (CldsEvent.ACTION_SUBMIT.equalsIgnoreCase(event.getActionCd())
969 || CldsEvent.ACTION_RESUBMIT.equalsIgnoreCase(event.getActionCd())
970 || CldsEvent.ACTION_DISTRIBUTE.equalsIgnoreCase(event.getActionCd()))) {
971 CldsEvent newEvent = new CldsEvent();
972 newEvent.setUserid(getUserId());
973 newEvent.setActionCd(newAction);
974 newEvent.setActionStateCd(CldsEvent.ACTION_STATE_COMPLETED);
975 cldsDao.insEvent(cldsModelName, cldsControlNamePrfx, null, newEvent);