2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Pantheon.tech
4 * Modifications (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
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.ncmp.rest.controller;
25 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.CREATE;
26 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.DELETE;
27 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.PATCH;
28 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.UPDATE;
30 import java.util.ArrayList;
31 import java.util.Collection;
32 import java.util.Collections;
33 import java.util.List;
34 import java.util.stream.Collectors;
35 import javax.validation.Valid;
36 import javax.validation.constraints.NotNull;
37 import lombok.RequiredArgsConstructor;
38 import lombok.extern.slf4j.Slf4j;
39 import org.modelmapper.ModelMapper;
40 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
41 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
42 import org.onap.cps.ncmp.rest.model.CmHandleProperties;
43 import org.onap.cps.ncmp.rest.model.CmHandleProperty;
44 import org.onap.cps.ncmp.rest.model.CmHandles;
45 import org.onap.cps.ncmp.rest.model.ConditionProperties;
46 import org.onap.cps.ncmp.rest.model.Conditions;
47 import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
48 import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
49 import org.onap.cps.ncmp.rest.model.ModuleReference;
50 import org.onap.cps.utils.JsonObjectMapper;
51 import org.springframework.http.HttpStatus;
52 import org.springframework.http.ResponseEntity;
53 import org.springframework.web.bind.annotation.RequestMapping;
54 import org.springframework.web.bind.annotation.RestController;
58 @RequestMapping("${rest.api.ncmp-base-path}")
59 @RequiredArgsConstructor
60 public class NetworkCmProxyController implements NetworkCmProxyApi {
62 private static final String NO_BODY = null;
64 private final ModelMapper modelMapper;
65 private final NetworkCmProxyDataService networkCmProxyDataService;
66 private final JsonObjectMapper jsonObjectMapper;
69 * Get resource data from operational datastore.
71 * @param cmHandle cm handle identifier
72 * @param resourceIdentifier resource identifier
73 * @param acceptParamInHeader accept header parameter
74 * @param optionsParamInQuery options query parameter
75 * @return {@code ResponseEntity} response from dmi plugin
78 public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
79 final @NotNull @Valid String resourceIdentifier,
80 final String acceptParamInHeader,
81 final @Valid String optionsParamInQuery) {
82 final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(cmHandle,
86 return ResponseEntity.ok(responseObject);
90 * Get resource data from pass-through running datastore.
92 * @param cmHandle cm handle identifier
93 * @param resourceIdentifier resource identifier
94 * @param acceptParamInHeader accept header parameter
95 * @param optionsParamInQuery options query parameter
96 * @return {@code ResponseEntity} response from dmi plugin
99 public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
100 final @NotNull @Valid String resourceIdentifier,
101 final String acceptParamInHeader,
102 final @Valid String optionsParamInQuery) {
103 final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
106 optionsParamInQuery);
107 return ResponseEntity.ok(responseObject);
111 public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
112 final String cmHandle,
113 final Object requestBody, final String contentType) {
114 final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
115 resourceIdentifier, PATCH, jsonObjectMapper.asJsonString(requestBody), contentType);
116 return ResponseEntity.ok(responseObject);
120 * Create resource data in datastore pass-through running for given cm-handle.
122 * @param resourceIdentifier resource identifier
123 * @param cmHandle cm handle identifier
124 * @param requestBody the request body
125 * @param contentType content type of body
126 * @return {@code ResponseEntity} response from dmi plugin
129 public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
130 final String cmHandle, final Object requestBody, final String contentType) {
131 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
132 resourceIdentifier, CREATE, jsonObjectMapper.asJsonString(requestBody), contentType);
133 return new ResponseEntity<>(HttpStatus.CREATED);
137 * Update resource data in datastore pass-through running for given cm-handle.
139 * @param resourceIdentifier resource identifier
140 * @param cmHandle cm handle identifier
141 * @param requestBody the request body
142 * @param contentType content type of the body
143 * @return response entity
146 public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
147 final String cmHandle,
148 final Object requestBody,
149 final String contentType) {
150 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
151 resourceIdentifier, UPDATE, jsonObjectMapper.asJsonString(requestBody), contentType);
152 return new ResponseEntity<>(HttpStatus.OK);
157 * Delete resource data in datastore pass-through running for a given cm-handle.
159 * @param resourceIdentifier resource identifier
160 * @param cmHandle cm handle identifier
161 * @param contentType content type of the body
162 * @return response entity no content if request is successful
165 public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
166 final String resourceIdentifier,
167 final String contentType) {
168 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
169 resourceIdentifier, DELETE, NO_BODY, contentType);
170 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
174 * Execute cm handle search.
176 * @param conditions the conditions
177 * @return cm handles returned from search.
180 public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
181 final List<ConditionProperties> conditionProperties =
182 conditions.getConditions().stream().collect(Collectors.toList());
183 final CmHandles cmHandles = new CmHandles();
184 cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
185 return ResponseEntity.ok(cmHandles);
189 * Return module references for a cm handle.
191 * @param cmHandle the cm handle
192 * @return module references for cm handle
194 public ResponseEntity<List<ModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
195 final List<ModuleReference> moduleReferences =
196 networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
197 .map(moduleReference -> modelMapper.map(moduleReference, ModuleReference.class))
198 .collect(Collectors.toList());
199 return new ResponseEntity<>(moduleReferences, HttpStatus.OK);
202 private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
203 for (final ConditionProperties conditionProperty : conditionProperties) {
204 if (conditionProperty.getName().equals("hasAllModules")) {
205 return executeCmHandleSearchesForModuleNames(conditionProperty);
207 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
210 log.warn("No valid conditions found {}.", conditionProperties);
211 return Collections.emptyList();
214 private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
215 return networkCmProxyDataService
216 .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
219 private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
220 final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
221 for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
222 moduleNames.add(moduleNameAsJsonObject.getModuleName());
227 private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
228 final CmHandleProperties cmHandleProperties = new CmHandleProperties();
229 for (final String cmHandleIdentifier : cmHandleIdentifiers) {
230 final CmHandleProperty cmHandleProperty = new CmHandleProperty();
231 cmHandleProperty.setCmHandleId(cmHandleIdentifier);
232 cmHandleProperties.add(cmHandleProperty);
234 return cmHandleProperties;