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 * Modifications copyright (c) 2018 Nokia
21 * ===================================================================
25 package org.onap.clamp.clds.service;
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.security.GeneralSecurityException;
35 import java.util.Date;
36 import java.util.List;
37 import java.util.Optional;
38 import java.util.UUID;
40 import javax.servlet.http.HttpServletRequest;
41 import javax.ws.rs.BadRequestException;
42 import javax.ws.rs.NotAuthorizedException;
43 import javax.xml.transform.TransformerException;
45 import org.apache.camel.Produce;
46 import org.apache.commons.codec.DecoderException;
47 import org.apache.commons.lang3.StringUtils;
48 import org.json.simple.parser.ParseException;
49 import org.onap.clamp.clds.camel.CamelProxy;
50 import org.onap.clamp.clds.client.DcaeDispatcherServices;
51 import org.onap.clamp.clds.client.DcaeInventoryServices;
52 import org.onap.clamp.clds.client.req.sdc.SdcCatalogServices;
53 import org.onap.clamp.clds.config.ClampProperties;
54 import org.onap.clamp.clds.dao.CldsDao;
55 import org.onap.clamp.clds.exception.CldsConfigException;
56 import org.onap.clamp.clds.exception.policy.PolicyClientException;
57 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
58 import org.onap.clamp.clds.model.CldsDbServiceCache;
59 import org.onap.clamp.clds.model.CldsEvent;
60 import org.onap.clamp.clds.model.CldsInfo;
61 import org.onap.clamp.clds.model.CldsModel;
62 import org.onap.clamp.clds.model.CldsModelProp;
63 import org.onap.clamp.clds.model.CldsMonitoringDetails;
64 import org.onap.clamp.clds.model.CldsServiceData;
65 import org.onap.clamp.clds.model.CldsTemplate;
66 import org.onap.clamp.clds.model.DcaeEvent;
67 import org.onap.clamp.clds.model.ValueItem;
68 import org.onap.clamp.clds.model.properties.AbstractModelElement;
69 import org.onap.clamp.clds.model.properties.ModelProperties;
70 import org.onap.clamp.clds.model.sdc.SdcResource;
71 import org.onap.clamp.clds.model.sdc.SdcServiceDetail;
72 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
73 import org.onap.clamp.clds.sdc.controller.installer.CsarInstallerImpl;
74 import org.onap.clamp.clds.transform.XslTransformer;
75 import org.onap.clamp.clds.util.JacksonUtils;
76 import org.onap.clamp.clds.util.LoggingUtils;
77 import org.onap.clamp.clds.util.ONAPLogConstants;
78 import org.slf4j.event.Level;
79 import org.springframework.beans.factory.annotation.Autowired;
80 import org.springframework.beans.factory.annotation.Value;
81 import org.springframework.http.HttpStatus;
82 import org.springframework.http.ResponseEntity;
83 import org.springframework.stereotype.Component;
84 import org.springframework.web.client.HttpClientErrorException;
87 * Service to save and retrieve the CLDS model attributes.
90 public class CldsService extends SecureServiceBase {
92 @Produce(uri = "direct:processSubmit")
93 private CamelProxy camelProxy;
94 protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
95 protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
97 public static final String GLOBAL_PROPERTIES_KEY = "files.globalProperties";
98 private final String cldsPersmissionTypeCl;
99 private final String cldsPermissionTypeClManage;
100 private final String cldsPermissionTypeClEvent;
101 private final String cldsPermissionTypeFilterVf;
102 private final String cldsPermissionTypeTemplate;
103 private final String cldsPermissionInstance;
104 final SecureServicePermission permissionReadCl;
105 final SecureServicePermission permissionUpdateCl;
106 final SecureServicePermission permissionReadTemplate;
107 final SecureServicePermission permissionUpdateTemplate;
108 final SecureServicePermission permissionReadTosca;
109 final SecureServicePermission permissionUpdateTosca;
111 private final CldsDao cldsDao;
112 private final XslTransformer cldsBpmnTransformer;
113 private final ClampProperties refProp;
114 private final SdcCatalogServices sdcCatalogServices;
115 private final DcaeDispatcherServices dcaeDispatcherServices;
116 private final DcaeInventoryServices dcaeInventoryServices;
117 private LoggingUtils util = new LoggingUtils(logger);
120 private HttpServletRequest request;
123 public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
124 SdcCatalogServices sdcCatalogServices, DcaeDispatcherServices dcaeDispatcherServices,
125 DcaeInventoryServices dcaeInventoryServices,
126 @Value("${clamp.config.security.permission.type.cl:permission-type-cl}") String cldsPersmissionTypeCl,
127 @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}") String cldsPermissionTypeClManage,
128 @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}") String cldsPermissionTypeClEvent,
129 @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}") String cldsPermissionTypeFilterVf,
130 @Value("${clamp.config.security.permission.type.template:permission-type-template}") String cldsPermissionTypeTemplate,
131 @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}") String cldsPermissionTypeTosca,
132 @Value("${clamp.config.security.permission.instance:dev}") String cldsPermissionInstance) {
133 this.cldsDao = cldsDao;
134 this.cldsBpmnTransformer = cldsBpmnTransformer;
135 this.refProp = refProp;
136 this.sdcCatalogServices = sdcCatalogServices;
137 this.dcaeDispatcherServices = dcaeDispatcherServices;
138 this.dcaeInventoryServices = dcaeInventoryServices;
139 this.cldsPersmissionTypeCl = cldsPersmissionTypeCl;
140 this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
141 this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
142 this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
143 this.cldsPermissionTypeTemplate = cldsPermissionTypeTemplate;
144 this.cldsPermissionInstance = cldsPermissionInstance;
145 permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
146 permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
147 permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
149 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
151 permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
152 permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
157 * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
158 * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
159 * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
160 * from the DCAE application when the ClosedLoop is submitted
161 * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
162 * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
163 * used to generate the ClosedLoop model. ACTION_CD | Current state of the
164 * ClosedLoop in CLDS application.
166 public List<CldsMonitoringDetails> getCLDSDetails() {
167 util.entering(request, "CldsService: GET model details");
168 Date startTime = new Date();
169 List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCLDSMonitoringDetails();
171 LoggingUtils.setTimeContext(startTime, new Date());
172 auditLogger.info("GET cldsDetails completed");
173 util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
174 return cldsMonitoringDetailsList;
178 * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
179 * is currently installed from pom.xml file 3. User permissions
181 public CldsInfo getCldsInfo() {
182 util.entering(request, "CldsService: GET cldsInfo");
183 Date startTime = new Date();
184 LoggingUtils.setTimeContext(startTime, new Date());
186 CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
187 CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
190 LoggingUtils.setTimeContext(startTime, new Date());
191 securityLogger.info("GET cldsInfo completed");
192 util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
197 * REST service that retrieves BPMN for a CLDS model name from the database.
198 * This is subset of the json getModel. This is only expected to be used for
199 * testing purposes, not by the UI.
202 * @return bpmn xml text - content of bpmn given name
204 public String getBpmnXml(String modelName) {
205 util.entering(request, "CldsService: GET model bpmn");
206 Date startTime = new Date();
207 isAuthorized(permissionReadCl);
208 logger.info("GET bpmnText for modelName={}", modelName);
209 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
211 LoggingUtils.setTimeContext(startTime, new Date());
212 auditLogger.info("GET model bpmn completed");
213 util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
214 return model.getBpmnText();
218 * REST service that retrieves image for a CLDS model name from the database.
219 * This is subset of the json getModel. This is only expected to be used for
220 * testing purposes, not by the UI.
223 * @return image xml text - content of image given name
225 public String getImageXml(String modelName) {
226 util.entering(request, "CldsService: GET model image");
227 Date startTime = new Date();
228 isAuthorized(permissionReadCl);
229 logger.info("GET imageText for modelName={}", modelName);
230 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
232 LoggingUtils.setTimeContext(startTime, new Date());
233 auditLogger.info("GET model image completed");
234 util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
235 return model.getImageText();
239 * REST service that retrieves a CLDS model by name from the database.
242 * @return clds model - clds model for the given model name
244 public CldsModel getModel(String modelName) {
245 util.entering(request, "CldsService: GET model");
246 Date startTime = new Date();
247 isAuthorized(permissionReadCl);
248 logger.debug("GET model for modelName={}", modelName);
249 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
250 isAuthorizedForVf(cldsModel);
251 // Checking condition whether our CLDS model can call Inventory Method
252 if (cldsModel.canInventoryCall()) {
254 // Method to call dcae inventory and invoke insert event method
255 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
256 } catch (Exception e) {
257 LoggingUtils.setErrorContext("900", "Set event inventory error");
258 logger.error("getModel set event Inventory error:" + e);
262 LoggingUtils.setTimeContext(startTime, new Date());
263 auditLogger.info("GET model completed");
264 util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
269 * REST service that saves a CLDS model by name in the database.
273 public CldsModel putModel(String modelName, CldsModel cldsModel) {
274 util.entering(request, "CldsService: PUT model");
275 Date startTime = new Date();
276 isAuthorized(permissionUpdateCl);
277 isAuthorizedForVf(cldsModel);
278 logger.info("PUT model for modelName={}", modelName);
279 logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
280 logger.info("PUT propText={}", cldsModel.getPropText());
281 logger.info("PUT imageText={}", cldsModel.getImageText());
282 cldsModel.setName(modelName);
283 fillInCldsModel(cldsModel);
284 updateAndInsertNewEvent(cldsModel.getName(), cldsModel.getControlNamePrefix(), cldsModel.getEvent(),
285 CldsEvent.ACTION_MODIFY);
286 cldsModel.save(cldsDao, getUserId());
288 LoggingUtils.setTimeContext(startTime, new Date());
289 auditLogger.info("PUT model completed");
290 util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
295 * REST service that retrieves a list of CLDS model names.
297 * @return model names in JSON
299 public List<ValueItem> getModelNames() {
300 util.entering(request, "CldsService: GET model names");
301 Date startTime = new Date();
302 isAuthorized(permissionReadCl);
303 logger.info("GET list of model names");
304 List<ValueItem> names = cldsDao.getModelNames();
306 LoggingUtils.setTimeContext(startTime, new Date());
307 auditLogger.info("GET model names completed");
308 util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
312 private void fillInCldsModel(CldsModel model) {
313 if (model.getTemplateName() != null) {
314 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
315 if (template != null) {
316 model.setTemplateId(template.getId());
317 model.setDocText(template.getPropText());
318 // This is to provide the Bpmn XML when Template part in UI
321 model.setBpmnText(template.getBpmnText());
327 * REST service that saves and processes an action for a CLDS model by name.
331 * @param validateFlag
334 * @throws TransformerException
335 * In case of issues when doing the XSLT of the BPMN flow
336 * @throws ParseException
337 * In case of issues when parsing the JSON
338 * @throws GeneralSecurityException
339 * In case of issues when decrypting the password
340 * @throws DecoderException
341 * In case of issues with the Hex String decoding
343 public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
344 throws TransformerException, ParseException {
345 util.entering(request, "CldsService: Process model action");
346 Date startTime = new Date();
347 CldsModel retrievedModel = null;
348 String errorMessage = "";
350 String actionCd = action.toUpperCase();
351 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
352 cldsPermissionInstance, actionCd);
353 isAuthorized(permisionManage);
354 isAuthorizedForVf(model);
355 String userId = getUserId();
356 logger.info("PUT actionCd={}", actionCd);
357 logger.info("PUT modelName={}", modelName);
358 logger.info("PUT test={}", test);
359 logger.info("PUT bpmnText={}", model.getBpmnText());
360 logger.info("PUT propText={}", model.getPropText());
361 logger.info("PUT userId={}", userId);
362 logger.info("PUT getTypeId={}", model.getTypeId());
363 logger.info("PUT deploymentId={}", model.getDeploymentId());
364 this.fillInCldsModel(model);
366 updateAndInsertNewEvent(modelName, model.getControlNamePrefix(), model.getEvent(), CldsEvent.ACTION_MODIFY);
367 model.save(cldsDao, getUserId());
368 // get vars and format if necessary
369 String prop = model.getPropText();
370 String bpmn = model.getBpmnText();
371 String docText = model.getDocText();
372 String controlName = model.getControlName();
373 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
374 logger.info("PUT bpmnJson={}", bpmnJson);
375 // Test flag coming from UI or from Clamp config
376 boolean isTest = Boolean.parseBoolean(test)
377 || Boolean.parseBoolean(refProp.getStringValue("action.test.override"));
378 logger.info("PUT isTest={}", isTest);
379 boolean isInsertTestEvent = Boolean.parseBoolean(refProp.getStringValue("action.insert.test.event"));
380 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
381 // determine if requested action is permitted
382 model.validateAction(actionCd);
383 logger.info("modelProp - " + prop);
384 logger.info("docText - " + docText);
386 String result = camelProxy.executeAction(actionCd, prop, bpmnJson, modelName, controlName, docText,
387 isTest, userId, isInsertTestEvent, model.getEvent().getActionCd());
388 logger.info("Starting Camel flow on request, result is: ", result);
389 } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
390 logger.error("Exception occured during invoking Camel process", e);
391 errorMessage=e.getMessage();
393 if (actionCd.equalsIgnoreCase(CldsEvent.ACTION_DELETE)) {
394 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO,
395 ONAPLogConstants.ResponseStatus.COMPLETED);
396 return new ResponseEntity<>("", HttpStatus.OK);
398 retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
400 if (!isTest && errorMessage.isEmpty()
401 && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
402 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
403 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
404 if (retrievedModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
406 logger.info("Skipping DCAE inventory call as closed loop has been created from SDC notification");
407 DcaeEvent dcaeEvent = new DcaeEvent();
408 dcaeEvent.setArtifactName(retrievedModel.getControlName() + ".yml");
409 dcaeEvent.setEvent(DcaeEvent.EVENT_DISTRIBUTION);
410 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userId, dcaeEvent.getCldsActionCd(),
411 CldsEvent.ACTION_STATE_RECEIVED, null);
413 // This should be done only when the call to DCAE
414 // has not yet been done. When CL comes from SDC
415 // this is not required as the DCAE inventory call is done
416 // during the CL deployment.
417 dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
419 retrievedModel.save(cldsDao, getUserId());
422 LoggingUtils.setTimeContext(startTime, new Date());
423 auditLogger.info("Process model action completed");
425 } catch (Exception e) {
426 logger.error("Exception occured during putModelAndProcessAction", e);
427 errorMessage=e.getMessage();
429 if (!errorMessage.isEmpty()) {
430 if (retrievedModel != null) {
431 retrievedModel.setErrorMessageForUi(errorMessage);
433 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
434 ONAPLogConstants.ResponseStatus.ERROR);
435 return new ResponseEntity<>(retrievedModel, HttpStatus.INTERNAL_SERVER_ERROR);
437 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
438 return new ResponseEntity<>(retrievedModel, HttpStatus.OK);
442 * REST service that accepts events for a model.
447 public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
448 util.entering(request, "CldsService: Post dcae event");
449 Date startTime = new Date();
450 String userid = null;
451 // TODO: allow auth checking to be turned off by removing the permission
453 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
454 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
455 cldsPermissionInstance, dcaeEvent.getEvent());
456 isAuthorized(permissionEvent);
457 userid = getUserId();
459 // Flag indicates whether it is triggered by Validation Test button from
461 boolean isTest = Boolean.parseBoolean(test);
462 int instanceCount = 0;
463 if (dcaeEvent.getInstances() != null) {
464 instanceCount = dcaeEvent.getInstances().size();
466 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
467 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
468 + " instance count=" + instanceCount + " isTest=" + isTest;
469 logger.info("POST dcae event {}", msgInfo);
471 logger.warn("Ignorning test event from DCAE");
473 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
474 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
476 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
477 CldsEvent.ACTION_STATE_RECEIVED, null);
481 LoggingUtils.setTimeContext(startTime, new Date());
482 auditLogger.info("Post dcae event completed");
483 util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
488 * REST service that retrieves sdc services
490 * @throws GeneralSecurityException
491 * In case of issue when decryting the SDC password
492 * @throws DecoderException
493 * In case of issues with the decoding of the Hex String
495 public String getSdcServices() throws GeneralSecurityException, DecoderException {
496 util.entering(request, "CldsService: GET sdc services");
497 Date startTime = new Date();
500 retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
501 } catch (IOException e) {
502 logger.error("IOException during SDC communication", e);
503 throw new SdcCommunicationException("IOException during SDC communication", e);
505 logger.info("value of sdcServices : {}", retStr);
507 LoggingUtils.setTimeContext(startTime, new Date());
508 auditLogger.info("GET sdc services completed");
509 util.exiting("200", "Get sdc services success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
514 * REST service that retrieves total properties required by UI
516 * @throws IOException
519 public String getSdcProperties() throws IOException {
520 return createPropertiesObjectByUUID("{}");
524 * REST service that retrieves total properties by using invariantUUID based on
525 * refresh and non refresh
527 * @throws GeneralSecurityException
528 * In case of issues with the decryting the encrypted password
529 * @throws DecoderException
530 * In case of issues with the decoding of the Hex String
531 * @throws IOException
532 * In case of issue to convert CldsServiceCache to InputStream
534 public String getSdcPropertiesByServiceUUIDForRefresh(String serviceInvariantUUID, Boolean refresh)
535 throws GeneralSecurityException, DecoderException, IOException {
536 util.entering(request, "CldsService: GET sdc properties by uuid");
537 Date startTime = new Date();
538 CldsServiceData cldsServiceData = new CldsServiceData();
539 cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
540 if (!Optional.ofNullable(refresh).orElse(false)) {
541 cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
543 if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
544 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
545 cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
547 // filter out VFs the user is not authorized for
548 cldsServiceData.filterVfs(this);
549 // format retrieved data into properties json
550 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
552 LoggingUtils.setTimeContext(startTime, new Date());
553 auditLogger.info("GET sdc properties by uuid completed");
554 util.exiting("200", "Get sdc properties by uuid success", Level.INFO,
555 ONAPLogConstants.ResponseStatus.COMPLETED);
556 return sdcProperties;
560 * Determine if the user is authorized for a particular VF by its invariant
563 * @param vfInvariantUuid
564 * @throws NotAuthorizedException
567 public boolean isAuthorizedForVf(String vfInvariantUuid) {
568 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
569 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
570 cldsPermissionInstance, vfInvariantUuid);
571 return isAuthorized(permission);
573 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
574 // VF filtering is turned off
575 logger.warn("VF filtering turned off");
581 * Determine if the user is authorized for a particular VF by its invariant
582 * UUID. If not authorized, then NotAuthorizedException is thrown.
587 private boolean isAuthorizedForVf(CldsModel model) {
588 String vf = ModelProperties.getVf(model);
589 if (vf == null || vf.length() == 0) {
590 logger.info("VF not found in model");
593 return isAuthorizedForVf(vf);
597 private String createUiServiceFormatJson(String responseStr) throws IOException {
598 if (StringUtils.isBlank(responseStr)) {
601 ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
602 List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
603 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
604 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
605 ObjectNode serviceNode = objectMapper.createObjectNode();
606 logger.info("value of cldsserviceiNfolist: {}", rawList);
607 if (rawList != null && !rawList.isEmpty()) {
608 List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
609 for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
610 if (currCldsSdcServiceInfo != null) {
611 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
612 currCldsSdcServiceInfo.getName());
615 serviceNode.putPOJO("service", invariantIdServiceNode);
617 return serviceNode.toString();
620 private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
621 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
622 SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
623 ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
624 if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
626 * to create json with vf, alarm and locations
628 ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
629 ObjectNode vfObjectNode = mapper.createObjectNode();
631 * to create json with vf and vfresourceId
633 createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
634 serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
635 ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
636 byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
638 * to create json with VFC Node
640 ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
641 byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
642 globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
643 logger.info("valuie of objNode: {}", globalPropsJson);
645 return globalPropsJson.toString();
648 private ObjectNode createEmptyVfAlarmObject() {
649 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
650 ObjectNode emptyObjectNode = mapper.createObjectNode();
651 emptyObjectNode.put("", "");
652 ObjectNode vfObjectNode = mapper.createObjectNode();
653 vfObjectNode.putPOJO("vf", emptyObjectNode);
654 vfObjectNode.putPOJO("location", emptyObjectNode);
655 vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
656 ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
657 emptyServiceObjectNode.putPOJO("", vfObjectNode);
658 return emptyServiceObjectNode;
661 private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
662 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
663 ObjectNode vfNode = mapper.createObjectNode();
665 // To remove repeated resource instance name from
666 // resourceInstanceList
667 List<SdcResource> cldsSdcResourceList = sdcCatalogServices
668 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
670 * Creating vf resource node using cldsSdcResource Object
672 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
673 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
674 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
675 vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
679 vfObjectNode2.putPOJO("vf", vfNode);
681 * creating location json object using properties file value
683 ObjectNode locationJsonNode;
685 locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
687 } catch (IOException e) {
688 logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
689 throw new CldsConfigException(
690 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
692 vfObjectNode2.putPOJO("location", locationJsonNode);
694 * creating alarm json object using properties file value
696 String alarmStringValue = refProp.getStringValue("ui.alarm.default");
697 logger.info("value of alarm: {}", alarmStringValue);
698 ObjectNode alarmStringJsonNode;
700 alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
701 } catch (IOException e) {
702 logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
703 throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
706 vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
709 private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
710 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
711 ObjectNode emptyObjectNode = mapper.createObjectNode();
712 ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
713 ObjectNode vfCObjectNode = mapper.createObjectNode();
714 vfCObjectNode.putPOJO("vfC", emptyObjectNode);
715 ObjectNode subVfCObjectNode = mapper.createObjectNode();
716 subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
717 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
718 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
719 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
720 vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
724 emptyvfcobjectNode.putPOJO("", vfCObjectNode);
725 return emptyvfcobjectNode;
728 public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
729 util.entering(request, "CldsService: Deploy model");
730 Date startTime = new Date();
731 String errorMessage="";
733 fillInCldsModel(model);
734 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
735 logger.info("PUT bpmnJson={}", bpmnJson);
736 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
737 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
738 isAuthorized(permisionManage);
739 isAuthorizedForVf(model);
740 ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
741 false, bpmnJson, model.getPropText());
742 checkForDuplicateServiceVf(modelName, model.getPropText());
743 String deploymentId = "";
744 // If model is already deployed then pass same deployment id
745 if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
746 deploymentId = model.getDeploymentId();
748 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
750 String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
751 model.getTypeId(), modelProp.getGlobal().getDeployParameters());
752 String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(createNewDeploymentStatusUrl);
753 if ("succeeded".equalsIgnoreCase(operationStatus)) {
754 String artifactName = model.getControlName();
755 if (artifactName != null) {
756 artifactName = artifactName + ".yml";
758 DcaeEvent dcaeEvent = new DcaeEvent();
759 /* set dcae events */
760 dcaeEvent.setArtifactName(artifactName);
761 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
762 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
763 CldsEvent.ACTION_STATE_RECEIVED, null);
764 model.setDeploymentId(deploymentId);
765 model.save(cldsDao, getUserId());
767 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
768 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
769 ONAPLogConstants.ResponseStatus.ERROR);
770 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
771 "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
773 logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
775 LoggingUtils.setTimeContext(startTime, new Date());
776 auditLogger.info("Deploy model completed");
777 } catch (Exception e) {
778 errorMessage=e.getMessage();
779 logger.error("Exception occured during deployModel", e);
781 if (!errorMessage.isEmpty()) {
782 model.setErrorMessageForUi(errorMessage);
783 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
784 ONAPLogConstants.ResponseStatus.ERROR);
785 return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
787 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
788 return new ResponseEntity<>(model, HttpStatus.OK);
791 public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
792 util.entering(request, "CldsService: Undeploy model");
793 Date startTime = new Date();
794 String errorMessage = "";
796 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
797 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
798 isAuthorized(permisionManage);
799 isAuthorizedForVf(model);
800 String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
802 String operationStatus = dcaeDispatcherServices.getOperationStatusWithRetry(operationStatusUndeployUrl);
803 if ("succeeded".equalsIgnoreCase(operationStatus)) {
804 String artifactName = model.getControlName();
805 if (artifactName != null) {
806 artifactName = artifactName + ".yml";
808 DcaeEvent dcaeEvent = new DcaeEvent();
810 dcaeEvent.setArtifactName(artifactName);
811 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
812 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
813 CldsEvent.ACTION_STATE_RECEIVED, null);
814 model.setDeploymentId(null);
815 model.save(cldsDao, getUserId());
817 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
818 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
819 ONAPLogConstants.ResponseStatus.ERROR);
820 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
821 "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
823 logger.info("Undeploy model (" + modelName + ") succeeded.");
825 LoggingUtils.setTimeContext(startTime, new Date());
826 auditLogger.info("Undeploy model completed");
827 } catch (Exception e) {
828 errorMessage = e.getMessage();
829 logger.error("Exception occured during unDeployModel", e);
831 if (!errorMessage.isEmpty()) {
832 model.setErrorMessageForUi(errorMessage);
833 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
834 ONAPLogConstants.ResponseStatus.ERROR);
835 return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
837 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
838 return new ResponseEntity<>(model, HttpStatus.OK);
841 private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
842 JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
843 String service = AbstractModelElement.getValueByName(globalNode, "service");
844 List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
845 if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
846 List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
847 for (CldsModelProp cldsModelProp : cldsModelPropList) {
848 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
850 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
851 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
852 if (currentVf != null && !currentVf.isEmpty()) {
853 if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
854 && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
855 throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
856 + " model, please select different Service/VF.");
863 private void updateAndInsertNewEvent(String cldsModelName, String cldsControlNamePrfx, CldsEvent event,
865 // If model action is in submit/resubmit/distributed and user try
866 // to save then we are changing action back to create.
867 if (event != null && (CldsEvent.ACTION_SUBMIT.equalsIgnoreCase(event.getActionCd())
868 || CldsEvent.ACTION_RESUBMIT.equalsIgnoreCase(event.getActionCd())
869 || CldsEvent.ACTION_DISTRIBUTE.equalsIgnoreCase(event.getActionCd()))) {
870 CldsEvent newEvent = new CldsEvent();
871 newEvent.setUserid(getUserId());
872 newEvent.setActionCd(newAction);
873 newEvent.setActionStateCd(CldsEvent.ACTION_STATE_COMPLETED);
874 cldsDao.insEvent(cldsModelName, cldsControlNamePrfx, null, newEvent);
878 // Created for the integration test
879 public void setLoggingUtil(LoggingUtils utilP) {