Merge "Update Model to allow Persisting of alternateId"
[cps.git] / 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 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.ResourceLoader;
48 import org.springframework.http.HttpStatus;
49 import org.springframework.http.ResponseEntity;
50 import org.springframework.kafka.core.KafkaTemplate;
51 import org.springframework.web.bind.annotation.PathVariable;
52 import org.springframework.web.bind.annotation.PostMapping;
53 import org.springframework.web.bind.annotation.RequestBody;
54 import org.springframework.web.bind.annotation.RequestMapping;
55 import org.springframework.web.bind.annotation.RequestParam;
56 import org.springframework.web.bind.annotation.RestController;
57
58 @RestController
59 @RequestMapping("${rest.api.dmi-stub-base-path}")
60 @RequiredArgsConstructor
61 @Slf4j
62 public class DmiRestStubController {
63
64     private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
65     private final ObjectMapper objectMapper;
66     private final ApplicationContext applicationContext;
67
68     @Value("${app.ncmp.async-m2m.topic}")
69     private String ncmpAsyncM2mTopic;
70
71     private String dataOperationEventType = "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent";
72
73     /**
74      * Get all modules for given cm handle.
75      *
76      * @param cmHandle                The identifier for a network function, network element, subnetwork,
77      *                                or any other cm object by managed Network CM Proxy
78      * @param moduleReferencesRequest module references request body
79      * @return ResponseEntity response entity having module response as json string.
80      */
81     @PostMapping("/v1/ch/{cmHandle}/modules")
82     public ResponseEntity<String> getModuleReferences(@PathVariable final String cmHandle,
83                                                       @RequestBody final Object moduleReferencesRequest) {
84         final String moduleResponseContent = ResourceFileReaderUtil
85                 .getResourceFileContent(applicationContext.getResource(
86                         ResourceLoader.CLASSPATH_URL_PREFIX + "module/moduleResponse.json"));
87         log.info("cm handle: {} requested for modules", cmHandle);
88         return ResponseEntity.ok(moduleResponseContent);
89     }
90
91     /**
92      * Get all module resources for given cm handle.
93      *
94      * @param cmHandle                   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/{cmHandle}/moduleResources")
100     public ResponseEntity<String> retrieveModuleResources(
101             @PathVariable final String cmHandle,
102             @RequestBody final Object moduleResourcesReadRequest) {
103         final String moduleResourcesResponseContent = ResourceFileReaderUtil
104                 .getResourceFileContent(applicationContext.getResource(
105                         ResourceLoader.CLASSPATH_URL_PREFIX + "module/moduleResourcesResponse.json"));
106         log.info("cm handle: {} requested for module resources", cmHandle);
107         return ResponseEntity.ok(moduleResourcesResponseContent);
108     }
109
110     /**
111      * This method is not implemented for ONAP DMI plugin.
112      *
113      * @param topic                   client given topic name
114      * @param requestId               requestId generated by NCMP as an ack for client
115      * @param dmiDataOperationRequest list of operation details
116      * @return (@ code ResponseEntity) response entity
117      */
118     @PostMapping("/v1/data")
119     public ResponseEntity<Void> getResourceDataForCmHandleDataOperation(@RequestParam(value = "topic")
120                                                                             final String topic,
121                                                                         @RequestParam(value = "requestId")
122                                                                         final String requestId,
123                                                                         @RequestBody final DmiDataOperationRequest
124                                                                                     dmiDataOperationRequest) {
125         try {
126             log.info("Request received from the NCMP to DMI Plugin: {}",
127                     objectMapper.writeValueAsString(dmiDataOperationRequest));
128         } catch (final JsonProcessingException jsonProcessingException) {
129             log.info("Unable to process dmi data operation request to json string");
130         }
131         dmiDataOperationRequest.getOperations().forEach(dmiDataOperation -> {
132             final DataOperationEvent dataOperationEvent = getDataOperationEvent(dmiDataOperation);
133             dmiDataOperation.getCmHandles().forEach(cmHandle -> {
134                 dataOperationEvent.getData().getResponses().get(0).setIds(List.of(cmHandle.getId()));
135                 final CloudEvent cloudEvent = buildAndGetCloudEvent(topic, requestId, dataOperationEvent);
136                 cloudEventKafkaTemplate.send(ncmpAsyncM2mTopic, UUID.randomUUID().toString(), cloudEvent);
137             });
138         });
139         return new ResponseEntity<>(HttpStatus.ACCEPTED);
140     }
141
142     private CloudEvent buildAndGetCloudEvent(final String topic, final String requestId,
143                                              final DataOperationEvent dataOperationEvent) {
144         CloudEvent cloudEvent = null;
145         try {
146             cloudEvent = CloudEventBuilder.v1()
147                     .withId(UUID.randomUUID().toString())
148                     .withSource(URI.create("DMI"))
149                     .withType(dataOperationEventType)
150                     .withDataSchema(URI.create("urn:cps:" + dataOperationEventType + ":1.0.0"))
151                     .withTime(EventDateTimeFormatter.toIsoOffsetDateTime(
152                             EventDateTimeFormatter.getCurrentIsoFormattedDateTime()))
153                     .withData(objectMapper.writeValueAsBytes(dataOperationEvent))
154                     .withExtension("destination", topic)
155                     .withExtension("correlationid", requestId)
156                     .build();
157         } catch (final JsonProcessingException jsonProcessingException) {
158             log.error("Unable to parse event into bytes. cause : {}", jsonProcessingException.getMessage());
159         }
160         return cloudEvent;
161     }
162
163     private DataOperationEvent getDataOperationEvent(final DataOperationRequest dataOperationRequest) {
164         final Response response = new Response();
165         response.setOperationId(dataOperationRequest.getOperationId());
166         response.setStatusCode(SUCCESS.getCode());
167         response.setStatusMessage(SUCCESS.getMessage());
168         response.setIds(dataOperationRequest.getCmHandles().stream().map(CmHandle::getId).toList());
169         response.setResourceIdentifier(dataOperationRequest.getResourceIdentifier());
170         response.setOptions(dataOperationRequest.getOptions());
171         final String ietfNetworkTopologySample = ResourceFileReaderUtil
172                 .getResourceFileContent(applicationContext.getResource(
173                         ResourceLoader.CLASSPATH_URL_PREFIX
174                                 + "data/operational/ietf-network-topology-sample-rfc8345.json"));
175         final JSONParser jsonParser = new JSONParser();
176         try {
177             response.setResult(jsonParser.parse(ietfNetworkTopologySample));
178         } catch (final ParseException parseException) {
179             log.error("Unable to parse event result as json object. cause : {}", parseException.getMessage());
180         }
181         final List<Response> responseList = new ArrayList<>(1);
182         responseList.add(response);
183         final Data data = new Data();
184         data.setResponses(responseList);
185         final DataOperationEvent dataOperationEvent = new DataOperationEvent();
186         dataOperationEvent.setData(data);
187         return dataOperationEvent;
188     }
189 }