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;
39 import java.util.concurrent.TimeUnit;
41 import javax.annotation.PostConstruct;
42 import javax.ws.rs.BadRequestException;
43 import javax.ws.rs.Consumes;
44 import javax.ws.rs.DefaultValue;
45 import javax.ws.rs.GET;
46 import javax.ws.rs.NotAuthorizedException;
47 import javax.ws.rs.POST;
48 import javax.ws.rs.PUT;
49 import javax.ws.rs.Path;
50 import javax.ws.rs.PathParam;
51 import javax.ws.rs.Produces;
52 import javax.ws.rs.QueryParam;
53 import javax.ws.rs.core.MediaType;
54 import javax.ws.rs.core.Response;
55 import javax.xml.transform.TransformerException;
57 import org.apache.camel.Produce;
58 import org.apache.commons.codec.DecoderException;
59 import org.apache.commons.lang3.StringUtils;
60 import org.json.simple.parser.ParseException;
61 import org.onap.clamp.clds.camel.CamelProxy;
62 import org.onap.clamp.clds.client.DcaeDispatcherServices;
63 import org.onap.clamp.clds.client.DcaeInventoryServices;
64 import org.onap.clamp.clds.client.req.sdc.SdcCatalogServices;
65 import org.onap.clamp.clds.config.ClampProperties;
66 import org.onap.clamp.clds.dao.CldsDao;
67 import org.onap.clamp.clds.exception.CldsConfigException;
68 import org.onap.clamp.clds.exception.policy.PolicyClientException;
69 import org.onap.clamp.clds.exception.sdc.SdcCommunicationException;
70 import org.onap.clamp.clds.model.CldsDbServiceCache;
71 import org.onap.clamp.clds.model.CldsEvent;
72 import org.onap.clamp.clds.model.CldsHealthCheck;
73 import org.onap.clamp.clds.model.CldsInfo;
74 import org.onap.clamp.clds.model.CldsModel;
75 import org.onap.clamp.clds.model.CldsModelProp;
76 import org.onap.clamp.clds.model.CldsMonitoringDetails;
77 import org.onap.clamp.clds.model.CldsServiceData;
78 import org.onap.clamp.clds.model.CldsTemplate;
79 import org.onap.clamp.clds.model.DcaeEvent;
80 import org.onap.clamp.clds.model.ValueItem;
81 import org.onap.clamp.clds.model.properties.AbstractModelElement;
82 import org.onap.clamp.clds.model.properties.ModelProperties;
83 import org.onap.clamp.clds.model.sdc.SdcResource;
84 import org.onap.clamp.clds.model.sdc.SdcServiceDetail;
85 import org.onap.clamp.clds.model.sdc.SdcServiceInfo;
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;
123 private static final long DCAE_DEPLOY_WAITING_TIME = TimeUnit.SECONDS.toNanos(30);
126 private final void afterConstruction() {
127 permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
128 permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
129 permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
131 permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
136 private CldsDao cldsDao;
138 private XslTransformer cldsBpmnTransformer;
140 private ClampProperties refProp;
142 private SdcCatalogServices sdcCatalogServices;
144 private DcaeDispatcherServices dcaeDispatcherServices;
146 private DcaeInventoryServices dcaeInventoryServices;
149 * @return list of CLDS-Monitoring-Details: CLOSELOOP_NAME | Close loop name
150 * used in the CLDS application (prefix: ClosedLoop- + unique ClosedLoop ID)
151 * MODEL_NAME | Model Name in CLDS application SERVICE_TYPE_ID | TypeId
152 * returned from the DCAE application when the ClosedLoop is submitted
153 * (DCAEServiceTypeRequest generated in DCAE application). DEPLOYMENT_ID |
154 * Id generated when the ClosedLoop is deployed in DCAE. TEMPLATE_NAME |
155 * Template used to generate the ClosedLoop model. ACTION_CD | Current state
156 * of the ClosedLoop in CLDS application.
159 @Path("/cldsDetails")
160 @Produces(MediaType.APPLICATION_JSON)
161 public List<CldsMonitoringDetails> getCLDSDetails() {
162 Date startTime = new Date();
163 LoggingUtils.setRequestContext("CldsService: GET model details", getPrincipalName());
164 List<CldsMonitoringDetails> cldsMonitoringDetailsList = cldsDao.getCLDSMonitoringDetails();
166 LoggingUtils.setTimeContext(startTime, new Date());
167 LoggingUtils.setResponseContext("0", "Get cldsDetails success", this.getClass().getName());
168 auditLogger.info("GET cldsDetails completed");
169 return cldsMonitoringDetailsList;
173 * CLDS IFO service will return 3 things 1. User Name 2. CLDS code version
174 * that is currently installed from pom.xml file 3. User permissions
178 @Produces(MediaType.APPLICATION_JSON)
179 public CldsInfo getCldsInfo() {
180 CldsInfo cldsInfo = new CldsInfo();
181 Date startTime = new Date();
182 LoggingUtils.setRequestContext("CldsService: GET cldsInfo", getPrincipalName());
183 LoggingUtils.setTimeContext(startTime, new Date());
185 cldsInfo.setUserName(getUserName());
186 // Get CLDS application version
187 String cldsVersion = "";
188 Properties props = new Properties();
189 ClassLoader loader = Thread.currentThread().getContextClassLoader();
190 try (InputStream resourceStream = loader.getResourceAsStream(RESOURCE_NAME)) {
191 props.load(resourceStream);
192 cldsVersion = props.getProperty("clds.version");
193 } catch (Exception ex) {
194 logger.error("Exception caught during the clds.version reading", ex);
196 cldsInfo.setCldsVersion(cldsVersion);
197 // Get the user list of permissions
198 cldsInfo.setPermissionReadCl(isAuthorizedNoException(permissionReadCl));
199 cldsInfo.setPermissionUpdateCl(isAuthorizedNoException(permissionUpdateCl));
200 cldsInfo.setPermissionReadTemplate(isAuthorizedNoException(permissionReadTemplate));
201 cldsInfo.setPermissionUpdateTemplate(isAuthorizedNoException(permissionUpdateTemplate));
203 LoggingUtils.setTimeContext(startTime, new Date());
204 LoggingUtils.setResponseContext("0", "Get cldsInfo success", this.getClass().getName());
205 securityLogger.info("GET cldsInfo completed");
210 * REST service that retrieves clds healthcheck information.
212 * @return CldsHealthCheck class containing healthcheck info
215 @Path("/healthcheck")
216 @Produces(MediaType.APPLICATION_JSON)
217 public Response gethealthcheck() {
218 CldsHealthCheck cldsHealthCheck = new CldsHealthCheck();
219 Date startTime = new Date();
220 LoggingUtils.setRequestContext("CldsService: GET healthcheck", "Clamp-Health-Check");
221 LoggingUtils.setTimeContext(startTime, new Date());
222 boolean healthcheckFailed = false;
224 cldsDao.doHealthCheck();
225 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
226 cldsHealthCheck.setHealthCheckStatus("UP");
227 cldsHealthCheck.setDescription("OK");
228 LoggingUtils.setResponseContext("0", "Get healthcheck success", this.getClass().getName());
229 } catch (Exception e) {
230 healthcheckFailed = true;
231 logger.error("CLAMP application DB Error", e);
232 LoggingUtils.setResponseContext("999", "Get healthcheck failed", this.getClass().getName());
233 cldsHealthCheck.setHealthCheckComponent("CLDS-APP");
234 cldsHealthCheck.setHealthCheckStatus("DOWN");
235 cldsHealthCheck.setDescription("NOT-OK");
238 LoggingUtils.setTimeContext(startTime, new Date());
239 logger.info("GET healthcheck completed");
240 if (healthcheckFailed) {
241 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(cldsHealthCheck).build();
243 return Response.status(Response.Status.OK).entity(cldsHealthCheck).build();
248 * REST service that retrieves BPMN for a CLDS model name from the database.
249 * This is subset of the json getModel. This is only expected to be used for
250 * testing purposes, not by the UI.
253 * @return bpmn xml text - content of bpmn given name
256 @Path("/model/bpmn/{modelName}")
257 @Produces(MediaType.TEXT_XML)
258 public String getBpmnXml(@PathParam("modelName") String modelName) {
259 Date startTime = new Date();
260 LoggingUtils.setRequestContext("CldsService: GET model bpmn", getPrincipalName());
261 isAuthorized(permissionReadCl);
262 logger.info("GET bpmnText for modelName={}", modelName);
263 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
265 LoggingUtils.setTimeContext(startTime, new Date());
266 LoggingUtils.setResponseContext("0", "Get model bpmn success", this.getClass().getName());
267 auditLogger.info("GET model bpmn completed");
268 return model.getBpmnText();
272 * REST service that retrieves image for a CLDS model name from the
273 * database. This is subset of the json getModel. This is only expected to
274 * be used for testing purposes, not by the UI.
277 * @return image xml text - content of image given name
280 @Path("/model/image/{modelName}")
281 @Produces(MediaType.TEXT_XML)
282 public String getImageXml(@PathParam("modelName") String modelName) {
283 Date startTime = new Date();
284 LoggingUtils.setRequestContext("CldsService: GET model image", getPrincipalName());
285 isAuthorized(permissionReadCl);
286 logger.info("GET imageText for modelName={}", modelName);
287 CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
289 LoggingUtils.setTimeContext(startTime, new Date());
290 LoggingUtils.setResponseContext("0", "Get model image success", this.getClass().getName());
291 auditLogger.info("GET model image completed");
292 return model.getImageText();
296 * REST service that retrieves a CLDS model by name from the database.
299 * @return clds model - clds model for the given model name
302 @Path("/model/{modelName}")
303 @Produces(MediaType.APPLICATION_JSON)
304 public CldsModel getModel(@PathParam("modelName") String modelName) {
305 Date startTime = new Date();
306 LoggingUtils.setRequestContext("CldsService: GET model", getPrincipalName());
307 isAuthorized(permissionReadCl);
308 logger.debug("GET model for modelName={}", modelName);
309 CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
310 isAuthorizedForVf(cldsModel);
311 // Checking condition whether our CLDS model can call Inventory Method
312 if (cldsModel.canInventoryCall()) {
314 // Method to call dcae inventory and invoke insert event method
315 dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
316 } catch (Exception e) {
317 LoggingUtils.setErrorContext("900", "Set event inventory error");
318 logger.error("getModel set event Inventory error:" + e);
322 LoggingUtils.setTimeContext(startTime, new Date());
323 LoggingUtils.setResponseContext("0", "Get model success", this.getClass().getName());
324 auditLogger.info("GET model completed");
329 * REST service that saves a CLDS model by name in the database.
334 @Path("/model/{modelName}")
335 @Consumes(MediaType.APPLICATION_JSON)
336 @Produces(MediaType.APPLICATION_JSON)
337 public CldsModel putModel(@PathParam("modelName") String modelName, CldsModel cldsModel) {
338 Date startTime = new Date();
339 LoggingUtils.setRequestContext("CldsService: PUT model", getPrincipalName());
340 isAuthorized(permissionUpdateCl);
341 isAuthorizedForVf(cldsModel);
342 logger.info("PUT model for modelName={}", modelName);
343 logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
344 logger.info("PUT propText={}", cldsModel.getPropText());
345 logger.info("PUT imageText={}", cldsModel.getImageText());
346 cldsModel.setName(modelName);
347 if (cldsModel.getTemplateName() != null) {
348 CldsTemplate template = cldsDao.getTemplate(cldsModel.getTemplateName());
349 if (template != null) {
350 cldsModel.setTemplateId(template.getId());
351 cldsModel.setDocText(template.getPropText());
352 // This is to provide the Bpmn XML when Template part in UI is
354 cldsModel.setBpmnText(template.getBpmnText());
357 cldsModel.save(cldsDao, getUserId());
359 LoggingUtils.setTimeContext(startTime, new Date());
360 LoggingUtils.setResponseContext("0", "Put model success", this.getClass().getName());
361 auditLogger.info("PUT model completed");
366 * REST service that retrieves a list of CLDS model names.
368 * @return model names in JSON
371 @Path("/model-names")
372 @Produces(MediaType.APPLICATION_JSON)
373 public List<ValueItem> getModelNames() {
374 Date startTime = new Date();
375 LoggingUtils.setRequestContext("CldsService: GET model names", getPrincipalName());
376 isAuthorized(permissionReadCl);
377 logger.info("GET list of model names");
378 List<ValueItem> names = cldsDao.getBpmnNames();
380 LoggingUtils.setTimeContext(startTime, new Date());
381 LoggingUtils.setResponseContext("0", "Get model names success", this.getClass().getName());
382 auditLogger.info("GET model names completed");
386 private void fillInCldsModel(CldsModel model) {
387 if (model.getTemplateName() != null) {
388 CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
389 if (template != null) {
390 model.setTemplateId(template.getId());
391 model.setDocText(template.getPropText());
392 // This is to provide the Bpmn XML when Template part in UI
395 model.setBpmnText(template.getBpmnText());
401 * REST service that saves and processes an action for a CLDS model by name.
408 * @throws TransformerException
409 * In case of issues when doing the XSLT of the BPMN flow
410 * @throws ParseException
411 * In case of issues when parsing the JSON
412 * @throws GeneralSecurityException
413 * In case of issues when decrypting the password
414 * @throws DecoderException
415 * In case of issues with the Hex String decoding
418 @Path("/action/{action}/{modelName}")
419 @Consumes(MediaType.APPLICATION_JSON)
420 @Produces(MediaType.APPLICATION_JSON)
421 public Response putModelAndProcessAction(@PathParam("action") String action,
422 @PathParam("modelName") String modelName, @QueryParam("test") String test, CldsModel model)
423 throws TransformerException, ParseException {
424 Date startTime = new Date();
425 CldsModel retrievedModel = null;
426 Boolean errorCase = false;
428 LoggingUtils.setRequestContext("CldsService: Process model action", getPrincipalName());
429 String actionCd = action.toUpperCase();
430 SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
431 cldsPermissionInstance, actionCd);
432 isAuthorized(permisionManage);
433 isAuthorizedForVf(model);
434 String userId = getUserId();
435 logger.info("PUT actionCd={}", actionCd);
436 logger.info("PUT modelName={}", modelName);
437 logger.info("PUT test={}", test);
438 logger.info("PUT bpmnText={}", model.getBpmnText());
439 logger.info("PUT propText={}", model.getPropText());
440 logger.info("PUT userId={}", userId);
441 logger.info("PUT getTypeId={}", model.getTypeId());
442 logger.info("PUT deploymentId={}", model.getDeploymentId());
443 this.fillInCldsModel(model);
445 model.setName(modelName);
446 model.save(cldsDao, getUserId());
447 // get vars and format if necessary
448 String prop = model.getPropText();
449 String bpmn = model.getBpmnText();
450 String docText = model.getDocText();
451 String controlName = model.getControlName();
452 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
453 logger.info("PUT bpmnJson={}", bpmnJson);
454 // Flag indicates whether it is triggered by Validation Test button
457 boolean isTest = false;
458 if (test != null && test.equalsIgnoreCase("true")) {
461 String actionTestOverride = refProp.getStringValue("action.test.override");
462 if (actionTestOverride != null && actionTestOverride.equalsIgnoreCase("true")) {
463 logger.info("PUT actionTestOverride={}", actionTestOverride);
464 logger.info("PUT override test indicator and setting it to true");
468 logger.info("PUT isTest={}", isTest);
469 boolean isInsertTestEvent = false;
470 String insertTestEvent = refProp.getStringValue("action.insert.test.event");
471 if (insertTestEvent != null && insertTestEvent.equalsIgnoreCase("true")) {
472 isInsertTestEvent = true;
474 logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
475 // determine if requested action is permitted
476 model.validateAction(actionCd);
477 logger.info("modelProp - " + prop);
478 logger.info("docText - " + docText);
480 String result = camelProxy.submit(actionCd, prop, bpmnJson, modelName, controlName, docText, isTest,
481 userId, isInsertTestEvent);
482 logger.info("Starting Camel flow on request, result is: ", result);
483 } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
485 logger.error("Exception occured during invoking Camel process", e);
487 // refresh model info from db (get fresh event info)
488 retrievedModel = CldsModel.retrieve(cldsDao, modelName, false);
489 if (!isTest && (actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMIT)
490 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_RESUBMIT)
491 || actionCd.equalsIgnoreCase(CldsEvent.ACTION_SUBMITDCAE))) {
492 // To verify inventory status and modify model status to
494 dcaeInventoryServices.setEventInventory(retrievedModel, getUserId());
495 retrievedModel.save(cldsDao, getUserId());
498 LoggingUtils.setTimeContext(startTime, new Date());
499 LoggingUtils.setResponseContext("0", "Process model action success", this.getClass().getName());
500 auditLogger.info("Process model action completed");
501 } catch (Exception e) {
503 logger.error("Exception occured during putModelAndProcessAction", e);
506 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(retrievedModel).build();
508 return Response.status(Response.Status.OK).entity(retrievedModel).build();
512 * REST service that accepts events for a model.
519 @Consumes(MediaType.APPLICATION_JSON)
520 @Produces(MediaType.APPLICATION_JSON)
521 public String postDcaeEvent(@QueryParam("test") String test, DcaeEvent dcaeEvent) {
522 Date startTime = new Date();
523 LoggingUtils.setRequestContext("CldsService: Post dcae event", getPrincipalName());
524 String userid = null;
525 // TODO: allow auth checking to be turned off by removing the permission
527 if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
528 SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
529 cldsPermissionInstance, dcaeEvent.getEvent());
530 isAuthorized(permissionEvent);
531 userid = getUserId();
533 // Flag indicates whether it is triggered by Validation Test button from
535 boolean isTest = false;
536 if (test != null && test.equalsIgnoreCase("true")) {
539 int instanceCount = 0;
540 if (dcaeEvent.getInstances() != null) {
541 instanceCount = dcaeEvent.getInstances().size();
543 String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
544 + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
545 + " instance count=" + instanceCount + " isTest=" + isTest;
546 logger.info("POST dcae event {}", msgInfo);
548 logger.warn("Ignorning test event from DCAE");
550 if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
551 CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
553 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
554 CldsEvent.ACTION_STATE_RECEIVED, null);
558 LoggingUtils.setTimeContext(startTime, new Date());
559 LoggingUtils.setResponseContext("0", "Post dcae event success", this.getClass().getName());
560 auditLogger.info("Post dcae event completed");
565 * REST service that retrieves sdc services
567 * @throws GeneralSecurityException
568 * In case of issue when decryting the SDC password
569 * @throws DecoderException
570 * In case of issues with the decoding of the Hex String
573 @Path("/sdc/services")
574 @Produces(MediaType.APPLICATION_JSON)
575 public String getSdcServices() throws GeneralSecurityException, DecoderException {
576 Date startTime = new Date();
577 LoggingUtils.setRequestContext("CldsService: GET sdc services", getPrincipalName());
580 retStr = createUiServiceFormatJson(sdcCatalogServices.getSdcServicesInformation(null));
581 } catch (IOException e) {
582 logger.error("IOException during SDC communication", e);
583 throw new SdcCommunicationException("IOException during SDC communication", e);
585 logger.info("value of sdcServices : {}", retStr);
587 LoggingUtils.setTimeContext(startTime, new Date());
588 LoggingUtils.setResponseContext("0", "Get sdc services success", this.getClass().getName());
589 auditLogger.info("GET sdc services completed");
594 * REST service that retrieves total properties required by UI
596 * @throws IOException
601 @Produces(MediaType.APPLICATION_JSON)
602 public String getSdcProperties() throws IOException {
603 return createPropertiesObjectByUUID("{}");
607 * REST service that retrieves total properties by using invariantUUID based
608 * on refresh and non refresh
610 * @throws GeneralSecurityException
611 * In case of issues with the decryting the encrypted password
612 * @throws DecoderException
613 * In case of issues with the decoding of the Hex String
614 * @throws IOException
615 * In case of issue to convert CldsServiceCache to InputStream
618 @Path("/properties/{serviceInvariantUUID}")
619 @Produces(MediaType.APPLICATION_JSON)
620 public String getSdcPropertiesByServiceUUIDForRefresh(
621 @PathParam("serviceInvariantUUID") String serviceInvariantUUID,
622 @DefaultValue("false") @QueryParam("refresh") boolean refresh)
623 throws GeneralSecurityException, DecoderException, IOException {
624 Date startTime = new Date();
625 LoggingUtils.setRequestContext("CldsService: GET sdc properties by uuid", getPrincipalName());
626 CldsServiceData cldsServiceData = new CldsServiceData();
627 cldsServiceData.setServiceInvariantUUID(serviceInvariantUUID);
629 cldsServiceData = cldsDao.getCldsServiceCache(serviceInvariantUUID);
631 if (sdcCatalogServices.isCldsSdcCacheDataExpired(cldsServiceData)) {
632 cldsServiceData = sdcCatalogServices.getCldsServiceDataWithAlarmConditions(serviceInvariantUUID);
633 cldsDao.setCldsServiceCache(new CldsDbServiceCache(cldsServiceData));
635 // filter out VFs the user is not authorized for
636 cldsServiceData.filterVfs(this);
637 // format retrieved data into properties json
638 String sdcProperties = sdcCatalogServices.createPropertiesObjectByUUID(cldsServiceData);
640 LoggingUtils.setTimeContext(startTime, new Date());
641 LoggingUtils.setResponseContext("0", "Get sdc properties by uuid success", this.getClass().getName());
642 auditLogger.info("GET sdc properties by uuid completed");
643 return sdcProperties;
647 * Determine if the user is authorized for a particular VF by its invariant
650 * @param vfInvariantUuid
651 * @throws NotAuthorizedException
654 public boolean isAuthorizedForVf(String vfInvariantUuid) {
655 if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
656 SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
657 cldsPermissionInstance, vfInvariantUuid);
658 return isAuthorized(permission);
660 // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
661 // VF filtering is turned off
662 logger.warn("VF filtering turned off");
668 * Determine if the user is authorized for a particular VF by its invariant
669 * UUID. If not authorized, then NotAuthorizedException is thrown.
674 private boolean isAuthorizedForVf(CldsModel model) {
675 String vf = ModelProperties.getVf(model);
676 if (vf == null || vf.length() == 0) {
677 logger.info("VF not found in model");
680 return isAuthorizedForVf(vf);
684 private String createUiServiceFormatJson(String responseStr) throws IOException {
685 if (StringUtils.isBlank(responseStr)) {
688 ObjectMapper objectMapper = JacksonUtils.getObjectMapperInstance();
689 List<SdcServiceInfo> rawList = objectMapper.readValue(responseStr,
690 objectMapper.getTypeFactory().constructCollectionType(List.class, SdcServiceInfo.class));
691 ObjectNode invariantIdServiceNode = objectMapper.createObjectNode();
692 ObjectNode serviceNode = objectMapper.createObjectNode();
693 logger.info("value of cldsserviceiNfolist: {}", rawList);
694 if (rawList != null && !rawList.isEmpty()) {
695 List<SdcServiceInfo> cldsSdcServiceInfoList = sdcCatalogServices.removeDuplicateServices(rawList);
696 for (SdcServiceInfo currCldsSdcServiceInfo : cldsSdcServiceInfoList) {
697 if (currCldsSdcServiceInfo != null) {
698 invariantIdServiceNode.put(currCldsSdcServiceInfo.getInvariantUUID(),
699 currCldsSdcServiceInfo.getName());
702 serviceNode.putPOJO("service", invariantIdServiceNode);
704 return serviceNode.toString();
707 private String createPropertiesObjectByUUID(String cldsResponseStr) throws IOException {
708 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
709 SdcServiceDetail cldsSdcServiceDetail = mapper.readValue(cldsResponseStr, SdcServiceDetail.class);
710 ObjectNode globalPropsJson = (ObjectNode) refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY);
711 if (cldsSdcServiceDetail != null && cldsSdcServiceDetail.getUuid() != null) {
713 * to create json with vf, alarm and locations
715 ObjectNode serviceObjectNode = createEmptyVfAlarmObject();
716 ObjectNode vfObjectNode = mapper.createObjectNode();
718 * to create json with vf and vfresourceId
720 createVfObjectNode(vfObjectNode, cldsSdcServiceDetail.getResources());
721 serviceObjectNode.putPOJO(cldsSdcServiceDetail.getInvariantUUID(), vfObjectNode);
722 ObjectNode byServiceBasicObjetNode = mapper.createObjectNode();
723 byServiceBasicObjetNode.putPOJO("byService", serviceObjectNode);
725 * to create json with VFC Node
727 ObjectNode emptyvfcobjectNode = createByVFCObjectNode(cldsSdcServiceDetail.getResources());
728 byServiceBasicObjetNode.putPOJO("byVf", emptyvfcobjectNode);
729 globalPropsJson.putPOJO("shared", byServiceBasicObjetNode);
730 logger.info("valuie of objNode: {}", globalPropsJson);
732 return globalPropsJson.toString();
735 private ObjectNode createEmptyVfAlarmObject() {
736 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
737 ObjectNode emptyObjectNode = mapper.createObjectNode();
738 emptyObjectNode.put("", "");
739 ObjectNode vfObjectNode = mapper.createObjectNode();
740 vfObjectNode.putPOJO("vf", emptyObjectNode);
741 vfObjectNode.putPOJO("location", emptyObjectNode);
742 vfObjectNode.putPOJO("alarmCondition", emptyObjectNode);
743 ObjectNode emptyServiceObjectNode = mapper.createObjectNode();
744 emptyServiceObjectNode.putPOJO("", vfObjectNode);
745 return emptyServiceObjectNode;
748 private void createVfObjectNode(ObjectNode vfObjectNode2, List<SdcResource> rawCldsSdcResourceList) {
749 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
750 ObjectNode vfNode = mapper.createObjectNode();
752 // To remove repeated resource instance name from
753 // resourceInstanceList
754 List<SdcResource> cldsSdcResourceList = sdcCatalogServices
755 .removeDuplicateSdcResourceInstances(rawCldsSdcResourceList);
757 * Creating vf resource node using cldsSdcResource Object
759 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
760 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
761 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
762 vfNode.put(cldsSdcResource.getResourceUUID(), cldsSdcResource.getResourceName());
766 vfObjectNode2.putPOJO("vf", vfNode);
768 * creating location json object using properties file value
770 ObjectNode locationJsonNode;
772 locationJsonNode = (ObjectNode) mapper.readValue(refProp.getStringValue("ui.location.default"),
774 } catch (IOException e) {
775 logger.error("Unable to load ui.location.default JSON in clds-references.properties properly", e);
776 throw new CldsConfigException(
777 "Unable to load ui.location.default JSON in clds-references.properties properly", e);
779 vfObjectNode2.putPOJO("location", locationJsonNode);
781 * creating alarm json object using properties file value
783 String alarmStringValue = refProp.getStringValue("ui.alarm.default");
784 logger.info("value of alarm: {}", alarmStringValue);
785 ObjectNode alarmStringJsonNode;
787 alarmStringJsonNode = (ObjectNode) mapper.readValue(alarmStringValue, JsonNode.class);
788 } catch (IOException e) {
789 logger.error("Unable to ui.alarm.default JSON in clds-references.properties properly", e);
790 throw new CldsConfigException("Unable to load ui.alarm.default JSON in clds-references.properties properly",
793 vfObjectNode2.putPOJO("alarmCondition", alarmStringJsonNode);
796 private ObjectNode createByVFCObjectNode(List<SdcResource> cldsSdcResourceList) {
797 ObjectMapper mapper = JacksonUtils.getObjectMapperInstance();
798 ObjectNode emptyObjectNode = mapper.createObjectNode();
799 ObjectNode emptyvfcobjectNode = mapper.createObjectNode();
800 ObjectNode vfCObjectNode = mapper.createObjectNode();
801 vfCObjectNode.putPOJO("vfC", emptyObjectNode);
802 ObjectNode subVfCObjectNode = mapper.createObjectNode();
803 subVfCObjectNode.putPOJO("vfc", emptyObjectNode);
804 if (cldsSdcResourceList != null && !cldsSdcResourceList.isEmpty()) {
805 for (SdcResource cldsSdcResource : cldsSdcResourceList) {
806 if (cldsSdcResource != null && "VF".equalsIgnoreCase(cldsSdcResource.getResoucreType())) {
807 vfCObjectNode.putPOJO(cldsSdcResource.getResourceUUID(), subVfCObjectNode);
811 emptyvfcobjectNode.putPOJO("", vfCObjectNode);
812 return emptyvfcobjectNode;
816 @Path("/deploy/{modelName}")
817 @Consumes(MediaType.APPLICATION_JSON)
818 @Produces(MediaType.APPLICATION_JSON)
819 public Response deployModel(@PathParam("modelName") String modelName, CldsModel model) {
820 Date startTime = new Date();
821 LoggingUtils.setRequestContext("CldsService: Deploy model", getPrincipalName());
822 Boolean errorCase = false;
824 fillInCldsModel(model);
825 String bpmnJson = cldsBpmnTransformer.doXslTransformToString(model.getBpmnText());
826 logger.info("PUT bpmnJson={}", bpmnJson);
827 ModelProperties modelProp = new ModelProperties(modelName, model.getControlName(), CldsEvent.ACTION_DEPLOY,
828 false, bpmnJson, model.getPropText());
829 checkForDuplicateServiceVf(modelName, model.getPropText());
830 String deploymentId = "";
831 // If model is already deployed then pass same deployment id
832 if (model.getDeploymentId() != null && !model.getDeploymentId().isEmpty()) {
833 deploymentId = model.getDeploymentId();
835 deploymentId = "closedLoop_" + UUID.randomUUID() + "_deploymentId";
837 String createNewDeploymentStatusUrl = dcaeDispatcherServices.createNewDeployment(deploymentId,
838 model.getTypeId(), modelProp.getGlobal().getDeployParameters());
839 String operationStatus = "processing";
840 long waitingTime = System.nanoTime() + DCAE_DEPLOY_WAITING_TIME;
841 while ("processing".equalsIgnoreCase(operationStatus)) {
842 if (waitingTime < System.nanoTime()) {
843 logger.info("Waiting is over for DCAE deployment");
846 logger.info("Waiting 5s before sending query to DCAE");
848 operationStatus = dcaeDispatcherServices.getOperationStatus(createNewDeploymentStatusUrl);
850 if ("succeeded".equalsIgnoreCase(operationStatus)) {
851 String artifactName = model.getControlName();
852 if (artifactName != null) {
853 artifactName = artifactName + ".yml";
855 DcaeEvent dcaeEvent = new DcaeEvent();
856 /* set dcae events */
857 dcaeEvent.setArtifactName(artifactName);
858 dcaeEvent.setEvent(DcaeEvent.EVENT_DEPLOYMENT);
859 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
860 CldsEvent.ACTION_STATE_RECEIVED, null);
861 model.setDeploymentId(deploymentId);
862 model.save(cldsDao, getUserId());
864 logger.info("Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
865 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
866 "Deploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
868 logger.info("Deploy model (" + modelName + ") succeeded...Deployment Id is - " + deploymentId);
870 LoggingUtils.setTimeContext(startTime, new Date());
871 LoggingUtils.setResponseContext("0", "Deploy model success", this.getClass().getName());
872 auditLogger.info("Deploy model completed");
873 } catch (Exception e) {
875 logger.error("Exception occured during deployModel", e);
878 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
880 return Response.status(Response.Status.OK).entity(model).build();
884 @Path("/undeploy/{modelName}")
885 @Consumes(MediaType.APPLICATION_JSON)
886 @Produces(MediaType.APPLICATION_JSON)
887 public Response unDeployModel(@PathParam("modelName") String modelName, CldsModel model) {
888 Date startTime = new Date();
889 LoggingUtils.setRequestContext("CldsService: Undeploy model", getPrincipalName());
890 Boolean errorCase = false;
892 String operationStatusUndeployUrl = dcaeDispatcherServices.deleteExistingDeployment(model.getDeploymentId(),
894 String operationStatus = "processing";
895 long waitingTime = System.nanoTime() + TimeUnit.MINUTES.toNanos(10);
896 while ("processing".equalsIgnoreCase(operationStatus)) {
897 if (waitingTime < System.nanoTime()) {
900 operationStatus = dcaeDispatcherServices.getOperationStatus(operationStatusUndeployUrl);
902 if ("succeeded".equalsIgnoreCase(operationStatus)) {
903 String artifactName = model.getControlName();
904 if (artifactName != null) {
905 artifactName = artifactName + ".yml";
907 DcaeEvent dcaeEvent = new DcaeEvent();
909 dcaeEvent.setArtifactName(artifactName);
910 dcaeEvent.setEvent(DcaeEvent.EVENT_UNDEPLOYMENT);
911 CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), dcaeEvent.getCldsActionCd(),
912 CldsEvent.ACTION_STATE_RECEIVED, null);
913 model.setDeploymentId(null);
914 model.save(cldsDao, getUserId());
916 logger.info("Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
917 throw new HttpClientErrorException(HttpStatus.INTERNAL_SERVER_ERROR,
918 "Undeploy model (" + modelName + ") failed...Operation Status is - " + operationStatus);
920 logger.info("Undeploy model (" + modelName + ") succeeded.");
922 LoggingUtils.setTimeContext(startTime, new Date());
923 LoggingUtils.setResponseContext("0", "Undeploy model success", this.getClass().getName());
924 auditLogger.info("Undeploy model completed");
925 } catch (Exception e) {
927 logger.error("Exception occured during unDeployModel", e);
930 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(model).build();
932 return Response.status(Response.Status.OK).entity(model).build();
935 private void checkForDuplicateServiceVf(String modelName, String modelPropText) throws IOException {
936 JsonNode globalNode = JacksonUtils.getObjectMapperInstance().readTree(modelPropText).get("global");
937 String service = AbstractModelElement.getValueByName(globalNode, "service");
938 List<String> resourceVf = AbstractModelElement.getValuesByName(globalNode, "vf");
939 if (service != null && resourceVf != null && !resourceVf.isEmpty()) {
940 List<CldsModelProp> cldsModelPropList = cldsDao.getDeployedModelProperties();
941 for (CldsModelProp cldsModelProp : cldsModelPropList) {
942 JsonNode currentNode = JacksonUtils.getObjectMapperInstance().readTree(cldsModelProp.getPropText())
944 String currentService = AbstractModelElement.getValueByName(currentNode, "service");
945 List<String> currentVf = AbstractModelElement.getValuesByName(currentNode, "vf");
946 if (currentVf != null && !currentVf.isEmpty()) {
947 if (!modelName.equalsIgnoreCase(cldsModelProp.getName()) && service.equalsIgnoreCase(currentService)
948 && resourceVf.get(0).equalsIgnoreCase(currentVf.get(0))) {
949 throw new BadRequestException("Same Service/VF already exists in " + cldsModelProp.getName()
950 + " model, please select different Service/VF.");