2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022 Bell Canada
4 * Modifications Copyright (c) 2022 Nordix Foundation
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.rest.stub.controller;
24 import com.fasterxml.jackson.databind.ObjectMapper;
25 import java.io.IOException;
26 import java.io.InputStream;
27 import java.nio.charset.StandardCharsets;
28 import java.util.Arrays;
29 import java.util.HashMap;
30 import java.util.List;
32 import java.util.UUID;
33 import javax.validation.Valid;
34 import javax.validation.constraints.NotNull;
35 import lombok.extern.slf4j.Slf4j;
36 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
37 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
38 import org.onap.cps.ncmp.rest.model.RestModuleDefinition;
39 import org.onap.cps.ncmp.rest.model.RestModuleReference;
40 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
41 import org.onap.cps.ncmp.rest.model.RestOutputCmHandleCompositeState;
42 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
43 import org.springframework.beans.factory.annotation.Value;
44 import org.springframework.core.io.ClassPathResource;
45 import org.springframework.http.HttpStatus;
46 import org.springframework.http.ResponseEntity;
47 import org.springframework.web.bind.annotation.RequestMapping;
48 import org.springframework.web.bind.annotation.RestController;
52 @RequestMapping("${rest.api.ncmp-stub-base-path}")
53 public class NetworkCmProxyStubController implements NetworkCmProxyApi {
55 public static final String ASYNC_REQUEST_ID = "requestId";
57 @Value("${stub.path}")
58 private String pathToResponseFiles;
61 public ResponseEntity<Void> createResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
62 final String cmHandleId, @Valid final Object body, final String contentType) {
63 return new ResponseEntity<>(HttpStatus.CREATED);
67 public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandleId,
68 @NotNull @Valid final String resourceIdentifier, final String contentType) {
69 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
73 public ResponseEntity<List<RestOutputCmHandle>> searchCmHandles(
74 final CmHandleQueryParameters cmHandleQueryParameters) {
75 List<RestOutputCmHandle> restOutputCmHandles = null;
76 // read JSON file and map/convert to java POJO
77 final ClassPathResource resource = new ClassPathResource(pathToResponseFiles + "cmHandlesSearch.json");
78 try (InputStream inputStream = resource.getInputStream()) {
79 final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
80 final ObjectMapper mapper = new ObjectMapper();
81 restOutputCmHandles = Arrays.asList(mapper.readValue(string, RestOutputCmHandle[].class));
82 } catch (final IOException exception) {
83 log.error("Error reading the file.", exception);
84 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
86 return ResponseEntity.ok(restOutputCmHandles);
90 public ResponseEntity<Object> setDataSyncEnabledFlagForCmHandle(final String cmHandleId,
91 final Boolean dataSyncEnabled) {
92 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
96 public ResponseEntity<List<String>> searchCmHandleIds(
97 final CmHandleQueryParameters cmHandleQueryParameters) {
98 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
102 public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
103 final String cmHandleId) {
104 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
108 public ResponseEntity<RestOutputCmHandleCompositeState> getCmHandleStateByCmHandleId(final String cmHandle) {
109 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
113 public ResponseEntity<List<RestModuleDefinition>> getModuleDefinitionsByCmHandleId(final String cmHandle) {
114 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
118 public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandleId) {
119 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
123 * Get resource data from operational datastore.
125 * @param cmHandleId cm handle identifier
126 * @param resourceIdentifier resource identifier
127 * @param optionsParamInQuery options query parameter
128 * @param topicParamInQuery topic query parameter
129 * @return {@code ResponseEntity} response from dmi plugin
132 public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandleId,
133 final String resourceIdentifier, final String optionsParamInQuery, final String topicParamInQuery) {
134 final ResponseEntity<Map<String, Object>> asyncResponse = populateAsyncResponse(topicParamInQuery);
135 final Map<String, Object> asyncResponseData = asyncResponse.getBody();
136 Object responseObject = null;
137 // read JSON file and map/convert to java POJO
138 final ClassPathResource resource = new ClassPathResource(pathToResponseFiles
139 + "passthrough-operational-example.json");
140 try (InputStream inputStream = resource.getInputStream()) {
141 final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
142 final ObjectMapper mapper = new ObjectMapper();
143 responseObject = mapper.readValue(string, Object.class);
144 } catch (final IOException exception) {
145 log.error("Error reading the file.", exception);
146 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
148 if (asyncResponseData == null) {
149 return ResponseEntity.ok(responseObject);
151 return ResponseEntity.ok(asyncResponse);
156 public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandleId,
157 final String resourceIdentifier, final String options, final String topic) {
158 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
162 public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
163 final String cmHandleId, final Object body, final String contentType) {
164 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
168 public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
169 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
173 public ResponseEntity<Object> updateResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
174 final String cmHandleId, @Valid final Object body, final String contentType) {
175 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
178 private ResponseEntity<Map<String, Object>> populateAsyncResponse(final String topicParamInQuery) {
179 final Map<String, Object> responseData;
180 if (topicParamInQuery != null) {
181 responseData = getAsyncResponseData();
185 return ResponseEntity.ok().body(responseData);
188 private Map<String, Object> getAsyncResponseData() {
189 final Map<String, Object> asyncResponseData = new HashMap<>(1);
190 final String resourceDataRequestId = UUID.randomUUID().toString();
191 asyncResponseData.put(ASYNC_REQUEST_ID, resourceDataRequestId);
192 return asyncResponseData;