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.policy.PolicyClientException;
56 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
57 import org.onap.clamp.clds.model.CldsDbServiceCache;
58 import org.onap.clamp.clds.model.CldsEvent;
59 import org.onap.clamp.clds.model.CldsInfo;
60 import org.onap.clamp.clds.model.CldsModel;
61 import org.onap.clamp.clds.model.CldsModelProp;
62 import org.onap.clamp.clds.model.CldsMonitoringDetails;
63 import org.onap.clamp.clds.model.CldsServiceData;
64 import org.onap.clamp.clds.model.CldsTemplate;
65 import org.onap.clamp.clds.model.DcaeEvent;
66 import org.onap.clamp.clds.model.ValueItem;
67 import org.onap.clamp.clds.model.properties.AbstractModelElement;
68 import org.onap.clamp.clds.model.properties.ModelProperties;
69 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
70 import org.onap.clamp.clds.sdc.controller.installer.CsarInstallerImpl;
71 import org.onap.clamp.clds.transform.XslTransformer;
72 import org.onap.clamp.clds.util.JacksonUtils;
73 import org.onap.clamp.clds.util.LoggingUtils;
74 import org.onap.clamp.clds.util.ONAPLogConstants;
75 import org.slf4j.event.Level;
76 import org.springframework.beans.factory.annotation.Autowired;
77 import org.springframework.beans.factory.annotation.Value;
78 import org.springframework.http.HttpStatus;
79 import org.springframework.http.ResponseEntity;
80 import org.springframework.stereotype.Component;
81 import org.springframework.web.client.HttpClientErrorException;
84 * Service to save and retrieve the CLDS model attributes.
87 public class CldsService extends SecureServiceBase {
89 @Produce(uri = "direct:processSubmit")
90 private CamelProxy camelProxy;
91 protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
92 protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
94 public static final String GLOBAL_PROPERTIES_KEY = "files.globalProperties";
95 private final String cldsPersmissionTypeCl;
96 private final String cldsPermissionTypeClManage;
97 private final String cldsPermissionTypeClEvent;
98 private final String cldsPermissionTypeFilterVf;
99 private final String cldsPermissionTypeTemplate;
100 private final String cldsPermissionInstance;
101 final SecureServicePermission permissionReadCl;
102 final SecureServicePermission permissionUpdateCl;
103 final SecureServicePermission permissionReadTemplate;
104 final SecureServicePermission permissionUpdateTemplate;
105 final SecureServicePermission permissionReadTosca;
106 final SecureServicePermission permissionUpdateTosca;
108 private final CldsDao cldsDao;
109 private final XslTransformer cldsBpmnTransformer;
110 private final ClampProperties refProp;
111 private final SdcCatalogServices sdcCatalogServices;
112 private final DcaeDispatcherServices dcaeDispatcherServices;
113 private final DcaeInventoryServices dcaeInventoryServices;
114 private LoggingUtils util = new LoggingUtils(logger);
117 private HttpServletRequest request;
120 public CldsService(CldsDao cldsDao, XslTransformer cldsBpmnTransformer, ClampProperties refProp,
121 SdcCatalogServices sdcCatalogServices, DcaeDispatcherServices dcaeDispatcherServices,
122 DcaeInventoryServices dcaeInventoryServices,
123 @Value("${clamp.config.security.permission.type.cl:permission-type-cl}") String cldsPersmissionTypeCl,
124 @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}") String cldsPermissionTypeClManage,
125 @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}") String cldsPermissionTypeClEvent,
126 @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}") String cldsPermissionTypeFilterVf,
127 @Value("${clamp.config.security.permission.type.template:permission-type-template}") String cldsPermissionTypeTemplate,
128 @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}") String cldsPermissionTypeTosca,
129 @Value("${clamp.config.security.permission.instance:dev}") String cldsPermissionInstance) {
130 this.cldsDao = cldsDao;
131 this.cldsBpmnTransformer = cldsBpmnTransformer;
132 this.refProp = refProp;
133 this.sdcCatalogServices = sdcCatalogServices;
134 this.dcaeDispatcherServices = dcaeDispatcherServices;
135 this.dcaeInventoryServices = dcaeInventoryServices;
136 this.cldsPersmissionTypeCl = cldsPersmissionTypeCl;
137 this.cldsPermissionTypeClManage = cldsPermissionTypeClManage;
138 this.cldsPermissionTypeClEvent = cldsPermissionTypeClEvent;
139 this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
140 this.cldsPermissionTypeTemplate = cldsPermissionTypeTemplate;
141 this.cldsPermissionInstance = cldsPermissionInstance;
142 permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
143 permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
144 permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
146 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
148 permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
149 permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
154 * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
155 * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
156 * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId returned
157 * from the DCAE application when the ClosedLoop is submitted
158 * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID | Id
159 * generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME | Template
160 * used to generate the ClosedLoop model. ACTION_CD | Current state of the
161 * ClosedLoop in CLDS application.
163 public List<CldsMonitoringDetails> getCldsDetails() {
164 util.entering(request, "CldsService: GET model details");
165 Date startTime = new Date();
166 List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCLDSMonitoringDetails();
168 LoggingUtils.setTimeContext(startTime, new Date());
169 auditLogger.info("GET cldsDetails completed");
170 util.exiting("200", "Get cldsDetails success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
171 return cldsMonitoringDetailsList;
175 * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version that
176 * is currently installed from pom.xml file 3. User permissions
178 public CldsInfo getCldsInfo() {
179 util.entering(request, "CldsService: GET cldsInfo");
180 Date startTime = new Date();
181 LoggingUtils.setTimeContext(startTime, new Date());
183 CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
184 CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
187 LoggingUtils.setTimeContext(startTime, new Date());
188 securityLogger.info("GET cldsInfo completed");
189 util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
194 * REST service that retrieves BPMN for a CLDS model name from the database.
195 * This is subset of the json getModel. This is only expected to be used for
196 * testing purposes, not by the UI.
199 * @return bpmn xml text - content of bpmn given name
201 public String getBpmnXml(String modelName) {
202 util.entering(request, "CldsService: GET model bpmn");
203 Date startTime = new Date();
204 isAuthorized(permissionReadCl);
205 logger.info("GET bpmnText for modelName={}", modelName);
206 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
208 LoggingUtils.setTimeContext(startTime, new Date());
209 auditLogger.info("GET model bpmn completed");
210 util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
211 return model.getBpmnText();
215 * REST service that retrieves image for a CLDS model name from the database.
216 * This is subset of the json getModel. This is only expected to be used for
217 * testing purposes, not by the UI.
220 * @return image xml text - content of image given name
222 public String getImageXml(String modelName) {
223 util.entering(request, "CldsService: GET model image");
224 Date startTime = new Date();
225 isAuthorized(permissionReadCl);
226 logger.info("GET imageText for modelName={}", modelName);
227 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
229 LoggingUtils.setTimeContext(startTime, new Date());
230 auditLogger.info("GET model image completed");
231 util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
232 return model.getImageText();
236 * REST service that retrieves a CLDS model by name from the database.
239 * @return clds model - clds model for the given model name
241 public CldsModel getModel(String modelName) {
242 util.entering(request, "CldsService: GET model");
243 Date startTime = new Date();
244 isAuthorized(permissionReadCl);
245 logger.debug("GET model for modelName={}", modelName);
246 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
247 isAuthorizedForVf(cldsModel);
248 // Try an update for DCAE status
249 // Checking condition whether our CLDS model can call Inventory Method
251 // Method to call dcae inventory and invoke insert event method
252 if (cldsModel.canDcaeInventoryCall()
253 && !cldsModel.getTemplateName().startsWith(CsarInstallerImpl.TEMPLATE_NAME_PREFIX)) {
254 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
256 // This is a blocking call
257 if (cldsModel.getEvent().isActionCd(CldsEvent.ACTION_DEPLOY)
258 && !CldsModel.STATUS_ACTIVE.equals(cldsModel.getStatus()) && cldsModel.getDeploymentId() != null
259 && cldsModel.getDeploymentStatusUrl() != null) {
260 checkDcaeDeploymentStatus(cldsModel, CldsEvent.ACTION_DEPLOY, false);
261 // Refresh the model object in any cases for new event
262 cldsModel = CldsModel.retrieve(cldsDao, cldsModel.getName(), false);
264 } catch (Exception e) {
265 LoggingUtils.setErrorContext("900", "Set event inventory error");
266 logger.error("getModel set event Inventory error:" + e);
269 LoggingUtils.setTimeContext(startTime, new Date());
270 auditLogger.info("GET model completed");
271 util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
276 * REST service that saves a CLDS model by name in the database.
280 public CldsModel putModel(String modelName, CldsModel cldsModel) {
281 util.entering(request, "CldsService: PUT model");
282 Date startTime = new Date();
283 isAuthorized(permissionUpdateCl);
284 isAuthorizedForVf(cldsModel);
285 logger.info("PUT model for modelName={}", modelName);
286 logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
287 logger.info("PUT propText={}", cldsModel.getPropText());
288 logger.info("PUT imageText={}", cldsModel.getImageText());
289 fillInCldsModel(cldsModel);
290 cldsModel.save(cldsDao, getUserId());
293 LoggingUtils.setTimeContext(startTime, new Date());
294 auditLogger.info("PUT model completed");
295 util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
300 * REST service that retrieves a list of CLDS model names.
302 * @return model names in JSON
304 public List<ValueItem> getModelNames() {
305 util.entering(request, "CldsService: GET model names");
306 Date startTime = new Date();
307 isAuthorized(permissionReadCl);
308 logger.info("GET list of model names");
309 List<ValueItem> names = cldsDao.getModelNames();
311 LoggingUtils.setTimeContext(startTime, new Date());
312 auditLogger.info("GET model names completed");
313 util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
317 private void fillInCldsModel(CldsModel model) {
318 if (model.getTemplateName() != null) {
319 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
320 if (template != null) {
321 model.setTemplateId(template.getId());
322 model.setDocText(template.getPropText());
323 // This is to provide the Bpmn XML when Template part in UI
326 model.setBpmnText(template.getBpmnText());
332 * REST service that saves and processes an action for a CLDS model by name.
336 * @param validateFlag
339 * @throws TransformerException
340 * In case of issues when doing the XSLT of the BPMN flow
341 * @throws ParseException
342 * In case of issues when parsing the JSON
343 * @throws GeneralSecurityException
344 * In case of issues when decrypting the password
345 * @throws DecoderException
346 * In case of issues with the Hex String decoding
348 public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
349 throws TransformerException, ParseException {
350 util.entering(request, "CldsService: Process model action");
351 Date startTime = new Date();
352 String errorMessage = "";
353 String actionCd = "";
355 actionCd = action.toUpperCase();
356 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
357 cldsPermissionInstance, actionCd);
358 isAuthorized(permisionManage);
359 isAuthorizedForVf(model);
360 String userId = getUserId();
361 logger.info("PUT actionCd={}", actionCd);
362 logger.info("PUT modelName={}", modelName);
363 logger.info("PUT test={}", test);
364 logger.info("PUT bpmnText={}", model.getBpmnText());
365 logger.info("PUT propText={}", model.getPropText());
366 logger.info("PUT userId={}", userId);
367 logger.info("PUT getTypeId={}", model.getTypeId());
368 logger.info("PUT deploymentId={}", model.getDeploymentId());
369 this.fillInCldsModel(model);
370 // save model to db just in case
371 model.save(cldsDao, getUserId());
373 // get vars and format if necessary
374 String prop = model.getPropText();
375 String bpmn = model.getBpmnText();
376 String docText = model.getDocText();
377 String controlName = model.getControlName();
378 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
379 logger.info("PUT bpmnJson={}", bpmnJson);
380 // Test flag coming from UI or from Clamp config
381 boolean isTest = Boolean.parseBoolean(test)
382 || Boolean.parseBoolean(refProp.getStringValue("action.test.override"));
383 logger.info("PUT isTest={}", isTest);
384 boolean isInsertTestEvent = Boolean.parseBoolean(refProp.getStringValue("action.insert.test.event"));
385 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
386 // determine if requested action is permitted
387 model.validateAction(actionCd);
388 logger.info("modelProp - " + prop);
389 logger.info("docText - " + docText);
391 String result = camelProxy.executeAction(actionCd, prop, bpmnJson, modelName, controlName, docText,
392 isTest, userId, isInsertTestEvent, model.getEvent().getActionCd());
393 logger.info("Starting Camel flow on request, result is: ", result);
394 } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
395 logger.error("Exception occured during invoking Camel process", e);
396 errorMessage = e.getMessage();
399 LoggingUtils.setTimeContext(startTime, new Date());
400 auditLogger.info("Process model action completed");
401 } catch (Exception e) {
402 logger.error("Exception occured during putModelAndProcessAction", e);
403 errorMessage = e.getMessage();
406 if (!errorMessage.isEmpty()) {
407 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), actionCd, CldsEvent.ACTION_STATE_ERROR,
409 // Need a refresh as new events have been inserted
410 model = CldsModel.retrieve(cldsDao, modelName, false);
411 model.setErrorMessageForUi(errorMessage);
412 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
413 ONAPLogConstants.ResponseStatus.ERROR);
414 return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
416 // Need a refresh as new events have been inserted, could have been deleted so
418 model = CldsModel.retrieve(cldsDao, modelName, true);
419 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
420 return new ResponseEntity<>(model, HttpStatus.OK);
425 * REST service that accepts events for a model.
430 public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
431 util.entering(request, "CldsService: Post dcae event");
432 Date startTime = new Date();
433 String userid = null;
434 // TODO: allow auth checking to be turned off by removing the permission
436 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
437 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
438 cldsPermissionInstance, dcaeEvent.getEvent());
439 isAuthorized(permissionEvent);
440 userid = getUserId();
442 // Flag indicates whether it is triggered by Validation Test button from
444 boolean isTest = Boolean.parseBoolean(test);
445 int instanceCount = 0;
446 if (dcaeEvent.getInstances() != null) {
447 instanceCount = dcaeEvent.getInstances().size();
449 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
450 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
451 + " instance count=" + instanceCount + " isTest=" + isTest;
452 logger.info("POST dcae event {}", msgInfo);
454 logger.warn("Ignorning test event from DCAE");
456 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
457 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
459 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
460 CldsEvent.ACTION_STATE_RECEIVED, null);
464 LoggingUtils.setTimeContext(startTime, new Date());
465 auditLogger.info("Post dcae event completed");
466 util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
471 * REST service that retrieves sdc services
473 * @throws GeneralSecurityException
474 * In case of issue when decryting the SDC password
475 * @throws DecoderException
476 * In case of issues with the decoding of the Hex String
478 public String getSdcServices() throws GeneralSecurityException, DecoderException {
479 util.entering(request, "CldsService: GET sdc services");
480 Date startTime = new Date();
483 retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
484 } catch (IOException e) {
485 logger.error("IOException during SDC communication", e);
486 throw new SdcCommunicationException("IOException during SDC communication", e);
488 logger.info("value of sdcServices : {}", retStr);
490 LoggingUtils.setTimeContext(startTime, new Date());
491 auditLogger.info("GET sdc services completed");
492 util.exiting("200", "Get sdc services success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
497 * REST service that retrieves total properties required by UI
499 * @throws IOException
502 public String getSdcProperties() throws IOException {
503 return ((ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY)).toString();
507 * REST service that retrieves total properties by using invariantUUID based on
508 * refresh and non refresh
510 * @throws GeneralSecurityException
511 * In case of issues with the decryting the encrypted password
512 * @throws DecoderException
513 * In case of issues with the decoding of the Hex String
514 * @throws IOException
515 * In case of issue to convert CldsServiceCache to InputStream
517 public String getSdcPropertiesByServiceUUIDForRefresh(String serviceInvariantUUID, Boolean refresh)
518 throws GeneralSecurityException, DecoderException, IOException {
519 util.entering(request, "CldsService: GET sdc properties by uuid");
520 Date startTime = new Date();
521 CldsServiceData cldsServiceData = new CldsServiceData();
522 cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
523 if (!Optional.ofNullable(refresh).orElse(false)) {
524 cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
526 if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
527 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
528 cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
530 // filter out VFs the user is not authorized for
531 cldsServiceData.filterVfs(this);
532 // format retrieved data into properties json
533 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
535 LoggingUtils.setTimeContext(startTime, new Date());
536 auditLogger.info("GET sdc properties by uuid completed");
537 util.exiting("200", "Get sdc properties by uuid success", Level.INFO,
538 ONAPLogConstants.ResponseStatus.COMPLETED);
539 return sdcProperties;
543 * Determine if the user is authorized for a particular VF by its invariant
546 * @param vfInvariantUuid
547 * @throws NotAuthorizedException
550 public boolean isAuthorizedForVf(String vfInvariantUuid) {
551 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
552 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
553 cldsPermissionInstance, vfInvariantUuid);
554 return isAuthorized(permission);
556 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
557 // VF filtering is turned off
558 logger.warn("VF filtering turned off");
564 * Determine if the user is authorized for a particular VF by its invariant
565 * UUID. If not authorized, then NotAuthorizedException is thrown.
570 private boolean isAuthorizedForVf(CldsModel model) {
571 String vf = ModelProperties.getVf(model);
572 if (vf == null || vf.length() == 0) {
573 logger.info("VF not found in model");
576 return isAuthorizedForVf(vf);
580 private String createUiServiceFormatJson(String responseStr) throws IOException {
581 if (StringUtils.isBlank(responseStr)) {
584 ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
585 List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
586 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
587 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
588 ObjectNode serviceNode = objectMapper.createObjectNode();
589 logger.info("value of cldsserviceiNfolist: {}", rawList);
590 if (rawList != null && !rawList.isEmpty()) {
591 List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
592 for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
593 if (currCldsSdcServiceInfo != null) {
594 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
595 currCldsSdcServiceInfo.getName());
598 serviceNode.putPOJO("service", invariantIdServiceNode);
600 return serviceNode.toString();
603 public ResponseEntity<CldsModel> deployModel(String modelName, CldsModel model) {
604 util.entering(request, "CldsService: Deploy model");
605 Date startTime = new Date();
606 String errorMessage = "";
608 fillInCldsModel(model);
609 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
610 logger.info("PUT bpmnJson={}", bpmnJson);
611 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
612 cldsPermissionInstance, CldsEvent.ACTION_DEPLOY);
613 isAuthorized(permisionManage);
614 isAuthorizedForVf(model);
615 ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
616 false, bpmnJson, model.getPropText());
617 checkForDuplicateServiceVf(modelName, model.getPropText());
618 String deploymentId = "";
619 // If model is already deployed then pass same deployment id
620 if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
621 deploymentId = model.getDeploymentId();
623 model.setDeploymentId(deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId");
625 model.setDeploymentStatusUrl(dcaeDispatcherServices.createNewDeployment(deploymentId, model.getTypeId(),
626 modelProp.getGlobal().getDeployParameters()));
627 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_DEPLOY,
628 CldsEvent.ACTION_STATE_INITIATED, null);
629 model.save(cldsDao, getUserId());
630 // This is a blocking call
631 checkDcaeDeploymentStatus(model, CldsEvent.ACTION_DEPLOY, true);
632 // Refresh the model object in any cases for new event
633 model = CldsModel.retrieve(cldsDao, model.getName(), false);
635 LoggingUtils.setTimeContext(startTime, new Date());
636 auditLogger.info("Deploy model completed");
637 } catch (Exception e) {
638 errorMessage = e.getMessage();
639 logger.error("Exception occured during deployModel", e);
641 if (!errorMessage.isEmpty()) {
642 model.setErrorMessageForUi(errorMessage);
643 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DeployModel failed", Level.INFO,
644 ONAPLogConstants.ResponseStatus.ERROR);
645 return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
647 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
648 return new ResponseEntity<>(model, HttpStatus.OK);
652 public ResponseEntity<CldsModel> unDeployModel(String modelName, CldsModel model) {
653 util.entering(request, "CldsService: Undeploy model");
654 Date startTime = new Date();
655 String errorMessage = "";
657 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
658 cldsPermissionInstance, CldsEvent.ACTION_UNDEPLOY);
659 isAuthorized(permisionManage);
660 isAuthorizedForVf(model);
661 model.setDeploymentStatusUrl(
662 dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(), model.getTypeId()));
663 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), CldsEvent.ACTION_UNDEPLOY,
664 CldsEvent.ACTION_STATE_INITIATED, null);
665 // clean the deployment ID
666 model.setDeploymentId(null);
667 model.save(cldsDao, getUserId());
668 // This is a blocking call
669 checkDcaeDeploymentStatus(model, CldsEvent.ACTION_UNDEPLOY, true);
670 // Refresh the model object in any cases for new event
671 model = CldsModel.retrieve(cldsDao, model.getName(), false);
673 LoggingUtils.setTimeContext(startTime, new Date());
674 auditLogger.info("Undeploy model completed");
675 } catch (Exception e) {
676 errorMessage = e.getMessage();
677 logger.error("Exception occured during unDeployModel", e);
679 if (!errorMessage.isEmpty()) {
680 model.setErrorMessageForUi(errorMessage);
681 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "UndeployModel failed", Level.INFO,
682 ONAPLogConstants.ResponseStatus.ERROR);
683 return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
685 util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
686 return new ResponseEntity<>(model, HttpStatus.OK);
690 private void checkDcaeDeploymentStatus(CldsModel model, String cldsEvent, boolean withRetry)
691 throws InterruptedException {
692 String operationStatus = withRetry
693 ? dcaeDispatcherServices.getOperationStatusWithRetry(model.getDeploymentStatusUrl())
694 : dcaeDispatcherServices.getOperationStatus(model.getDeploymentStatusUrl());
695 if ("succeeded".equalsIgnoreCase(operationStatus)) {
696 logger.info(cldsEvent + " model (" + model.getName() + ") succeeded...Deployment Id is - "
697 + model.getDeploymentId());
698 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent,
699 CldsEvent.ACTION_STATE_COMPLETED, null);
701 String info = "DCAE " + cldsEvent + " (" + model.getName() + ") failed...Operation Status is - "
704 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), cldsEvent, CldsEvent.ACTION_STATE_ERROR,
706 util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "DCAE operation(" + cldsEvent + ") failed",
707 Level.INFO, ONAPLogConstants.ResponseStatus.ERROR);
708 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR, info);
712 private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
713 JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
714 String service = AbstractModelElement.getValueByName(globalNode, "service");
715 List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
716 if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
717 List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
718 for (CldsModelProp cldsModelProp : cldsModelPropList) {
719 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
721 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
722 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
723 if (currentVf != null && !currentVf.isEmpty()) {
724 if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
725 && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
726 throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
727 + " model, please select different Service/VF.");
734 // Created for the integration test
735 public void setLoggingUtil(LoggingUtils utilP) {