2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Pantheon.tech
4 * Modifications Copyright (C) 2021-2022 Nordix Foundation
5 * Modification Copyright (C) 2021 highstreet technologies GmbH
6 * Modifications (C) 2021 Bell Canada
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.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.ncmp.rest.controller;
26 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.CREATE;
27 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.DELETE;
28 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.PATCH;
29 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.UPDATE;
31 import java.util.ArrayList;
32 import java.util.Collection;
33 import java.util.Collections;
34 import java.util.List;
35 import java.util.stream.Collectors;
36 import javax.validation.Valid;
37 import javax.validation.constraints.NotNull;
38 import lombok.RequiredArgsConstructor;
39 import lombok.extern.slf4j.Slf4j;
40 import org.modelmapper.ModelMapper;
41 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
42 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
43 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
44 import org.onap.cps.ncmp.rest.model.CmHandleProperties;
45 import org.onap.cps.ncmp.rest.model.CmHandleProperty;
46 import org.onap.cps.ncmp.rest.model.CmHandlePublicProperties;
47 import org.onap.cps.ncmp.rest.model.CmHandles;
48 import org.onap.cps.ncmp.rest.model.ConditionProperties;
49 import org.onap.cps.ncmp.rest.model.Conditions;
50 import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
51 import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
52 import org.onap.cps.ncmp.rest.model.ModuleReference;
53 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
54 import org.onap.cps.utils.JsonObjectMapper;
55 import org.springframework.http.HttpStatus;
56 import org.springframework.http.ResponseEntity;
57 import org.springframework.web.bind.annotation.RequestMapping;
58 import org.springframework.web.bind.annotation.RestController;
62 @RequestMapping("${rest.api.ncmp-base-path}")
63 @RequiredArgsConstructor
64 public class NetworkCmProxyController implements NetworkCmProxyApi {
66 private static final String NO_BODY = null;
68 private final ModelMapper modelMapper;
69 private final NetworkCmProxyDataService networkCmProxyDataService;
70 private final JsonObjectMapper jsonObjectMapper;
73 * Get resource data from operational datastore.
75 * @param cmHandle cm handle identifier
76 * @param resourceIdentifier resource identifier
77 * @param acceptParamInHeader accept header parameter
78 * @param optionsParamInQuery options query parameter
79 * @param topicParamInQuery topic query parameter
80 * @return {@code ResponseEntity} response from dmi plugin
83 public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
84 final @NotNull @Valid String resourceIdentifier,
85 final String acceptParamInHeader,
86 final @Valid String optionsParamInQuery,
87 final @Valid String topicParamInQuery) {
88 final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(cmHandle,
93 return ResponseEntity.ok(responseObject);
97 * Get resource data from pass-through running datastore.
99 * @param cmHandle cm handle identifier
100 * @param resourceIdentifier resource identifier
101 * @param acceptParamInHeader accept header parameter
102 * @param optionsParamInQuery options query parameter
103 * @param topicParamInQuery topic query parameter
104 * @return {@code ResponseEntity} response from dmi plugin
107 public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
108 final @NotNull @Valid String resourceIdentifier,
109 final String acceptParamInHeader,
110 final @Valid String optionsParamInQuery,
111 final @Valid String topicParamInQuery) {
112 final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
117 return ResponseEntity.ok(responseObject);
121 public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
122 final String cmHandle,
123 final Object requestBody, final String contentType) {
124 final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
125 resourceIdentifier, PATCH, jsonObjectMapper.asJsonString(requestBody), contentType);
126 return ResponseEntity.ok(responseObject);
130 * Create resource data in datastore pass-through running for given cm-handle.
132 * @param resourceIdentifier resource identifier
133 * @param cmHandle cm handle identifier
134 * @param requestBody the request body
135 * @param contentType content type of body
136 * @return {@code ResponseEntity} response from dmi plugin
139 public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
140 final String cmHandle, final Object requestBody, final String contentType) {
141 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
142 resourceIdentifier, CREATE, jsonObjectMapper.asJsonString(requestBody), contentType);
143 return new ResponseEntity<>(HttpStatus.CREATED);
147 * Update resource data in datastore pass-through running for given cm-handle.
149 * @param resourceIdentifier resource identifier
150 * @param cmHandle cm handle identifier
151 * @param requestBody the request body
152 * @param contentType content type of the body
153 * @return response entity
156 public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
157 final String cmHandle,
158 final Object requestBody,
159 final String contentType) {
160 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
161 resourceIdentifier, UPDATE, jsonObjectMapper.asJsonString(requestBody), contentType);
162 return new ResponseEntity<>(HttpStatus.OK);
167 * Delete resource data in datastore pass-through running for a given cm-handle.
169 * @param resourceIdentifier resource identifier
170 * @param cmHandle cm handle identifier
171 * @param contentType content type of the body
172 * @return response entity no content if request is successful
175 public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
176 final String resourceIdentifier,
177 final String contentType) {
178 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
179 resourceIdentifier, DELETE, NO_BODY, contentType);
180 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
184 * Execute cm handle search.
186 * @param conditions the conditions
187 * @return cm handles returned from search.
190 public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
191 final List<ConditionProperties> conditionProperties =
192 conditions.getConditions().stream().collect(Collectors.toList());
193 final CmHandles cmHandles = new CmHandles();
194 cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
195 return ResponseEntity.ok(cmHandles);
199 * Search for Cm Handle and Properties by Name.
200 * @param cmHandleId cm-handle identifier
201 * @return cm handle and its properties
204 public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
205 final NcmpServiceCmHandle ncmpServiceCmHandle = networkCmProxyDataService.getNcmpServiceCmHandle(cmHandleId);
206 final RestOutputCmHandle restOutputCmHandle = toRestOutputCmHandle(ncmpServiceCmHandle);
207 return ResponseEntity.ok(restOutputCmHandle);
211 * Return module references for a cm handle.
213 * @param cmHandle the cm handle
214 * @return module references for cm handle. Namespace will be always blank because restConf does not include this.
216 public ResponseEntity<List<ModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
217 final List<ModuleReference> moduleReferences =
218 networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
219 .map(moduleReference -> modelMapper.map(moduleReference, ModuleReference.class))
220 .collect(Collectors.toList());
221 return new ResponseEntity<>(moduleReferences, HttpStatus.OK);
224 private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
225 for (final ConditionProperties conditionProperty : conditionProperties) {
226 if (conditionProperty.getName().equals("hasAllModules")) {
227 return executeCmHandleSearchesForModuleNames(conditionProperty);
229 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
232 log.warn("No valid conditions found {}.", conditionProperties);
233 return Collections.emptyList();
236 private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
237 return networkCmProxyDataService
238 .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
241 private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
242 final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
243 for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
244 moduleNames.add(moduleNameAsJsonObject.getModuleName());
249 private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
250 final CmHandleProperties cmHandleProperties = new CmHandleProperties();
251 for (final String cmHandleIdentifier : cmHandleIdentifiers) {
252 final CmHandleProperty cmHandleProperty = new CmHandleProperty();
253 cmHandleProperty.setCmHandleId(cmHandleIdentifier);
254 cmHandleProperties.add(cmHandleProperty);
256 return cmHandleProperties;
259 private RestOutputCmHandle toRestOutputCmHandle(final NcmpServiceCmHandle ncmpServiceCmHandle) {
260 final RestOutputCmHandle restOutputCmHandle = new RestOutputCmHandle();
261 final CmHandlePublicProperties cmHandlePublicProperties = new CmHandlePublicProperties();
262 restOutputCmHandle.setCmHandle(ncmpServiceCmHandle.getCmHandleID());
263 cmHandlePublicProperties.add(ncmpServiceCmHandle.getPublicProperties());
264 restOutputCmHandle.setPublicCmHandleProperties(cmHandlePublicProperties);
265 return restOutputCmHandle;