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.onap.cps.ncmp.api.NetworkCmProxyDataService;
41 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
42 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
43 import org.onap.cps.ncmp.rest.model.CmHandleProperties;
44 import org.onap.cps.ncmp.rest.model.CmHandleProperty;
45 import org.onap.cps.ncmp.rest.model.CmHandlePublicProperties;
46 import org.onap.cps.ncmp.rest.model.CmHandles;
47 import org.onap.cps.ncmp.rest.model.ConditionProperties;
48 import org.onap.cps.ncmp.rest.model.Conditions;
49 import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
50 import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
51 import org.onap.cps.ncmp.rest.model.RestModuleReference;
52 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
53 import org.onap.cps.utils.JsonObjectMapper;
54 import org.springframework.http.HttpStatus;
55 import org.springframework.http.ResponseEntity;
56 import org.springframework.web.bind.annotation.RequestMapping;
57 import org.springframework.web.bind.annotation.RestController;
61 @RequestMapping("${rest.api.ncmp-base-path}")
62 @RequiredArgsConstructor
63 public class NetworkCmProxyController implements NetworkCmProxyApi {
65 private static final String NO_BODY = null;
67 private final NetworkCmProxyDataService networkCmProxyDataService;
68 private final JsonObjectMapper jsonObjectMapper;
69 private final NcmpRestInputMapper ncmpRestInputMapper;
72 * Get resource data from operational datastore.
74 * @param cmHandle cm handle identifier
75 * @param resourceIdentifier resource identifier
76 * @param acceptParamInHeader accept header parameter
77 * @param optionsParamInQuery options query parameter
78 * @param topicParamInQuery topic query parameter
79 * @return {@code ResponseEntity} response from dmi plugin
82 public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
83 final @NotNull @Valid String resourceIdentifier,
84 final String acceptParamInHeader,
85 final @Valid String optionsParamInQuery,
86 final @Valid String topicParamInQuery) {
87 final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(cmHandle,
92 return ResponseEntity.ok(responseObject);
96 * Get resource data from pass-through running datastore.
98 * @param cmHandle cm handle identifier
99 * @param resourceIdentifier resource identifier
100 * @param acceptParamInHeader accept header parameter
101 * @param optionsParamInQuery options query parameter
102 * @param topicParamInQuery topic query parameter
103 * @return {@code ResponseEntity} response from dmi plugin
106 public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
107 final @NotNull @Valid String resourceIdentifier,
108 final String acceptParamInHeader,
109 final @Valid String optionsParamInQuery,
110 final @Valid String topicParamInQuery) {
111 final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
116 return ResponseEntity.ok(responseObject);
120 public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
121 final String cmHandle,
122 final Object requestBody, final String contentType) {
123 final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
124 resourceIdentifier, PATCH, jsonObjectMapper.asJsonString(requestBody), contentType);
125 return ResponseEntity.ok(responseObject);
129 * Create resource data in datastore pass-through running for given cm-handle.
131 * @param resourceIdentifier resource identifier
132 * @param cmHandle cm handle identifier
133 * @param requestBody the request body
134 * @param contentType content type of body
135 * @return {@code ResponseEntity} response from dmi plugin
138 public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
139 final String cmHandle, final Object requestBody, final String contentType) {
140 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
141 resourceIdentifier, CREATE, jsonObjectMapper.asJsonString(requestBody), contentType);
142 return new ResponseEntity<>(HttpStatus.CREATED);
146 * Update resource data in datastore pass-through running for given cm-handle.
148 * @param resourceIdentifier resource identifier
149 * @param cmHandle cm handle identifier
150 * @param requestBody the request body
151 * @param contentType content type of the body
152 * @return response entity
155 public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
156 final String cmHandle,
157 final Object requestBody,
158 final String contentType) {
159 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
160 resourceIdentifier, UPDATE, jsonObjectMapper.asJsonString(requestBody), contentType);
161 return new ResponseEntity<>(HttpStatus.OK);
166 * Delete resource data in datastore pass-through running for a given cm-handle.
168 * @param resourceIdentifier resource identifier
169 * @param cmHandle cm handle identifier
170 * @param contentType content type of the body
171 * @return response entity no content if request is successful
174 public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
175 final String resourceIdentifier,
176 final String contentType) {
177 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
178 resourceIdentifier, DELETE, NO_BODY, contentType);
179 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
183 * Execute cm handle search.
185 * @param conditions the conditions
186 * @return cm handles returned from search.
189 public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
190 final List<ConditionProperties> conditionProperties =
191 conditions.getConditions().stream().collect(Collectors.toList());
192 final CmHandles cmHandles = new CmHandles();
193 cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
194 return ResponseEntity.ok(cmHandles);
198 * Search for Cm Handle and Properties by Name.
199 * @param cmHandleId cm-handle identifier
200 * @return cm handle and its properties
203 public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
204 final NcmpServiceCmHandle ncmpServiceCmHandle = networkCmProxyDataService.getNcmpServiceCmHandle(cmHandleId);
205 final RestOutputCmHandle restOutputCmHandle = toRestOutputCmHandle(ncmpServiceCmHandle);
206 return ResponseEntity.ok(restOutputCmHandle);
210 * Return module references for a cm handle.
212 * @param cmHandle the cm handle
213 * @return module references for cm handle. Namespace will be always blank because restConf does not include this.
215 public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
216 final List<RestModuleReference> restModuleReferences =
217 networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
218 .map(ncmpRestInputMapper::toRestModuleReference)
219 .collect(Collectors.toList());
220 return new ResponseEntity<>(restModuleReferences, HttpStatus.OK);
223 private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
224 for (final ConditionProperties conditionProperty : conditionProperties) {
225 if (conditionProperty.getName().equals("hasAllModules")) {
226 return executeCmHandleSearchesForModuleNames(conditionProperty);
228 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
231 log.warn("No valid conditions found {}.", conditionProperties);
232 return Collections.emptyList();
235 private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
236 return networkCmProxyDataService
237 .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
240 private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
241 final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
242 for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
243 moduleNames.add(moduleNameAsJsonObject.getModuleName());
248 private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
249 final CmHandleProperties cmHandleProperties = new CmHandleProperties();
250 for (final String cmHandleIdentifier : cmHandleIdentifiers) {
251 final CmHandleProperty cmHandleProperty = new CmHandleProperty();
252 cmHandleProperty.setCmHandleId(cmHandleIdentifier);
253 cmHandleProperties.add(cmHandleProperty);
255 return cmHandleProperties;
258 private RestOutputCmHandle toRestOutputCmHandle(final NcmpServiceCmHandle ncmpServiceCmHandle) {
259 final RestOutputCmHandle restOutputCmHandle = new RestOutputCmHandle();
260 final CmHandlePublicProperties cmHandlePublicProperties = new CmHandlePublicProperties();
261 restOutputCmHandle.setCmHandle(ncmpServiceCmHandle.getCmHandleID());
262 cmHandlePublicProperties.add(ncmpServiceCmHandle.getPublicProperties());
263 restOutputCmHandle.setPublicCmHandleProperties(cmHandlePublicProperties);
264 return restOutputCmHandle;