dmi-plugin-demo-and-csit-stub/dmi-plugin-demo-and-csit-stub-service/src/main/java/org/onap/cps/ncmp/dmi/rest/stub/controller/DmiRestStubController.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023-2024 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.dmi.rest.stub.controller;
  22
  23 import static org.onap.cps.ncmp.api.NcmpResponseStatus.SUCCESS;
  24
  25 import com.fasterxml.jackson.core.JsonProcessingException;
  26 import com.fasterxml.jackson.databind.ObjectMapper;
  27 import io.cloudevents.CloudEvent;
  28 import io.cloudevents.core.builder.CloudEventBuilder;
  29 import java.net.URI;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.UUID;
  33 import lombok.RequiredArgsConstructor;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.json.simple.parser.JSONParser;
  36 import org.json.simple.parser.ParseException;
  37 import org.onap.cps.ncmp.api.impl.utils.EventDateTimeFormatter;
  38 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.CmHandle;
  39 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.DataOperationRequest;
  40 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.DmiDataOperationRequest;
  41 import org.onap.cps.ncmp.dmi.rest.stub.utils.ResourceFileReaderUtil;
  42 import org.onap.cps.ncmp.events.async1_0_0.Data;
  43 import org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent;
  44 import org.onap.cps.ncmp.events.async1_0_0.Response;
  45 import org.springframework.beans.factory.annotation.Value;
  46 import org.springframework.context.ApplicationContext;
  47 import org.springframework.core.io.Resource;
  48 import org.springframework.core.io.ResourceLoader;
  49 import org.springframework.http.HttpStatus;
  50 import org.springframework.http.ResponseEntity;
  51 import org.springframework.kafka.core.KafkaTemplate;
  52 import org.springframework.web.bind.annotation.PathVariable;
  53 import org.springframework.web.bind.annotation.PostMapping;
  54 import org.springframework.web.bind.annotation.RequestBody;
  55 import org.springframework.web.bind.annotation.RequestMapping;
  56 import org.springframework.web.bind.annotation.RequestParam;
  57 import org.springframework.web.bind.annotation.RestController;
  58
  59 @RestController
  60 @RequestMapping("${rest.api.dmi-stub-base-path}")
  61 @RequiredArgsConstructor
  62 @Slf4j
  63 public class DmiRestStubController {
  64
  65     private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
  66     private final ObjectMapper objectMapper;
  67     private final ApplicationContext applicationContext;
  68
  69     @Value("${app.ncmp.async-m2m.topic}")
  70     private String ncmpAsyncM2mTopic;
  71
  72     private String dataOperationEventType = "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent";
  73
  74     /**
  75      * Get all modules for given cm handle.
  76      *
  77      * @param cmHandleId              The identifier for a network function, network element, subnetwork,
  78      *                                or any other cm object by managed Network CM Proxy
  79      * @param moduleReferencesRequest module references request body
  80      * @return ResponseEntity response entity having module response as json string.
  81      */
  82     @PostMapping("/v1/ch/{cmHandleId}/modules")
  83     public ResponseEntity<String> getModuleReferences(@PathVariable final String cmHandleId,
  84                                                       @RequestBody final Object moduleReferencesRequest) {
  85         final String moduleResponseContent = getModuleResourceResponse(cmHandleId,
  86                 "ModuleResponse.json");
  87         log.info("cm handle: {} requested for modules", cmHandleId);
  88         return ResponseEntity.ok(moduleResponseContent);
  89     }
  90
  91     /**
  92      * Retrieves module resources for a given cmHandleId.
  93      *
  94      * @param cmHandleId                 The identifier for a network function, network element, subnetwork,
  95      *                                   or any other cm object by managed Network CM Proxy
  96      * @param moduleResourcesReadRequest module resources read request body
  97      * @return ResponseEntity response entity having module resources response as json string.
  98      */
  99     @PostMapping("/v1/ch/{cmHandleId}/moduleResources")
 100     public ResponseEntity<String> retrieveModuleResources(
 101             @PathVariable final String cmHandleId,
 102             @RequestBody final Object moduleResourcesReadRequest) {
 103         final String moduleResourcesResponseContent = getModuleResourceResponse(cmHandleId,
 104                 "ModuleResourcesResponse.json");
 105         log.info("cm handle: {} requested for modules resources", cmHandleId);
 106         return ResponseEntity.ok(moduleResourcesResponseContent);
 107     }
 108
 109     /**
 110      * This method is not implemented for ONAP DMI plugin.
 111      *
 112      * @param topic                   client given topic name
 113      * @param requestId               requestId generated by NCMP as an ack for client
 114      * @param dmiDataOperationRequest list of operation details
 115      * @return (@ code ResponseEntity) response entity
 116      */
 117     @PostMapping("/v1/data")
 118     public ResponseEntity<Void> getResourceDataForCmHandleDataOperation(@RequestParam(value = "topic")
 119                                                                             final String topic,
 120                                                                         @RequestParam(value = "requestId")
 121                                                                         final String requestId,
 122                                                                         @RequestBody final DmiDataOperationRequest
 123                                                                                     dmiDataOperationRequest) {
 124         try {
 125             log.info("Request received from the NCMP to DMI Plugin: {}",
 126                     objectMapper.writeValueAsString(dmiDataOperationRequest));
 127         } catch (final JsonProcessingException jsonProcessingException) {
 128             log.info("Unable to process dmi data operation request to json string");
 129         }
 130         dmiDataOperationRequest.getOperations().forEach(dmiDataOperation -> {
 131             final DataOperationEvent dataOperationEvent = getDataOperationEvent(dmiDataOperation);
 132             dmiDataOperation.getCmHandles().forEach(cmHandle -> {
 133                 dataOperationEvent.getData().getResponses().get(0).setIds(List.of(cmHandle.getId()));
 134                 final CloudEvent cloudEvent = buildAndGetCloudEvent(topic, requestId, dataOperationEvent);
 135                 cloudEventKafkaTemplate.send(ncmpAsyncM2mTopic, UUID.randomUUID().toString(), cloudEvent);
 136             });
 137         });
 138         return new ResponseEntity<>(HttpStatus.ACCEPTED);
 139     }
 140
 141     private CloudEvent buildAndGetCloudEvent(final String topic, final String requestId,
 142                                              final DataOperationEvent dataOperationEvent) {
 143         CloudEvent cloudEvent = null;
 144         try {
 145             cloudEvent = CloudEventBuilder.v1()
 146                     .withId(UUID.randomUUID().toString())
 147                     .withSource(URI.create("DMI"))
 148                     .withType(dataOperationEventType)
 149                     .withDataSchema(URI.create("urn:cps:" + dataOperationEventType + ":1.0.0"))
 150                     .withTime(EventDateTimeFormatter.toIsoOffsetDateTime(
 151                             EventDateTimeFormatter.getCurrentIsoFormattedDateTime()))
 152                     .withData(objectMapper.writeValueAsBytes(dataOperationEvent))
 153                     .withExtension("destination", topic)
 154                     .withExtension("correlationid", requestId)
 155                     .build();
 156         } catch (final JsonProcessingException jsonProcessingException) {
 157             log.error("Unable to parse event into bytes. cause : {}", jsonProcessingException.getMessage());
 158         }
 159         return cloudEvent;
 160     }
 161
 162     private DataOperationEvent getDataOperationEvent(final DataOperationRequest dataOperationRequest) {
 163         final Response response = new Response();
 164         response.setOperationId(dataOperationRequest.getOperationId());
 165         response.setStatusCode(SUCCESS.getCode());
 166         response.setStatusMessage(SUCCESS.getMessage());
 167         response.setIds(dataOperationRequest.getCmHandles().stream().map(CmHandle::getId).toList());
 168         response.setResourceIdentifier(dataOperationRequest.getResourceIdentifier());
 169         response.setOptions(dataOperationRequest.getOptions());
 170         final String ietfNetworkTopologySample = ResourceFileReaderUtil
 171                 .getResourceFileContent(applicationContext.getResource(
 172                         ResourceLoader.CLASSPATH_URL_PREFIX
 173                                 + "data/operational/ietf-network-topology-sample-rfc8345.json"));
 174         final JSONParser jsonParser = new JSONParser();
 175         try {
 176             response.setResult(jsonParser.parse(ietfNetworkTopologySample));
 177         } catch (final ParseException parseException) {
 178             log.error("Unable to parse event result as json object. cause : {}", parseException.getMessage());
 179         }
 180         final List<Response> responseList = new ArrayList<>(1);
 181         responseList.add(response);
 182         final Data data = new Data();
 183         data.setResponses(responseList);
 184         final DataOperationEvent dataOperationEvent = new DataOperationEvent();
 185         dataOperationEvent.setData(data);
 186         return dataOperationEvent;
 187     }
 188
 189     private String getModuleResourceResponse(final String cmHandleId, final String moduleResponseType) {
 190         final String nodeType = cmHandleId.split("-")[0];
 191         final String moduleResponseFilePath = String.format("module/%s%s", nodeType, moduleResponseType);
 192         final Resource moduleResponseResource = applicationContext.getResource(
 193                 ResourceLoader.CLASSPATH_URL_PREFIX + moduleResponseFilePath);
 194         if (moduleResponseResource.exists()) {
 195             log.info("Using requested node type: {}", nodeType);
 196             return ResourceFileReaderUtil.getResourceFileContent(moduleResponseResource);
 197         }
 198         log.info("Using default node type: ietfYang");
 199         return ResourceFileReaderUtil.getResourceFileContent(applicationContext.getResource(
 200                 ResourceLoader.CLASSPATH_URL_PREFIX + "module/ietfYang" + moduleResponseType));
 201     }
 202 }