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 com.google.gson.Gson;
31 import com.google.gson.GsonBuilder;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.List;
36 import java.util.stream.Collectors;
37 import javax.validation.Valid;
38 import javax.validation.constraints.NotNull;
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.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.CmHandles;
46 import org.onap.cps.ncmp.rest.model.ConditionProperties;
47 import org.onap.cps.ncmp.rest.model.Conditions;
48 import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
49 import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
50 import org.onap.cps.ncmp.rest.model.ModuleReference;
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 public class NetworkCmProxyController implements NetworkCmProxyApi {
61 private static final Gson GSON = new GsonBuilder().create();
62 private static final String NO_BODY = null;
64 private final ModelMapper modelMapper = new ModelMapper();
65 private final NetworkCmProxyDataService networkCmProxyDataService;
68 * Constructor Injection for Dependencies.
69 * @param networkCmProxyDataService Data Service Interface
71 public NetworkCmProxyController(final NetworkCmProxyDataService networkCmProxyDataService) {
72 this.networkCmProxyDataService = networkCmProxyDataService;
76 * Get resource data from operational datastore.
78 * @param cmHandle cm handle identifier
79 * @param resourceIdentifier resource identifier
80 * @param acceptParamInHeader accept header parameter
81 * @param optionsParamInQuery options query parameter
82 * @return {@code ResponseEntity} response from dmi plugin
85 public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
86 final @NotNull @Valid String resourceIdentifier,
87 final String acceptParamInHeader,
88 final @Valid String optionsParamInQuery) {
89 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 * @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 Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
113 optionsParamInQuery);
114 return ResponseEntity.ok(responseObject);
118 public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
119 final String cmHandle,
120 final Object requestBody, final String contentType) {
121 final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
122 resourceIdentifier, PATCH, GSON.toJson(requestBody), contentType);
123 return ResponseEntity.ok(responseObject);
127 * Create resource data in datastore pass-through running for given cm-handle.
129 * @param resourceIdentifier resource identifier
130 * @param cmHandle cm handle identifier
131 * @param requestBody the request body
132 * @param contentType content type of body
133 * @return {@code ResponseEntity} response from dmi plugin
136 public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
137 final String cmHandle, final Object requestBody, final String contentType) {
138 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
139 resourceIdentifier, CREATE, GSON.toJson(requestBody), contentType);
140 return new ResponseEntity<>(HttpStatus.CREATED);
144 * Update resource data in datastore pass-through running for given cm-handle.
146 * @param resourceIdentifier resource identifier
147 * @param cmHandle cm handle identifier
148 * @param requestBody the request body
149 * @param contentType content type of the body
150 * @return response entity
153 public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
154 final String cmHandle,
155 final Object requestBody,
156 final String contentType) {
157 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
158 resourceIdentifier, UPDATE, GSON.toJson(requestBody), contentType);
159 return new ResponseEntity<>(HttpStatus.OK);
164 * Delete resource data in datastore pass-through running for a given cm-handle.
166 * @param resourceIdentifier resource identifier
167 * @param cmHandle cm handle identifier
168 * @param contentType content type of the body
169 * @return response entity no content if request is successful
172 public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
173 final String resourceIdentifier,
174 final String contentType) {
175 networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
176 resourceIdentifier, DELETE, NO_BODY, contentType);
177 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
181 * Execute cm handle search.
183 * @param conditions the conditions
184 * @return cm handles returned from search.
187 public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
188 final List<ConditionProperties> conditionProperties =
189 conditions.getConditions().stream().collect(Collectors.toList());
190 final CmHandles cmHandles = new CmHandles();
191 cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
192 return ResponseEntity.ok(cmHandles);
196 * Return module references for a cm handle.
198 * @param cmHandle the cm handle
199 * @return module references for cm handle
201 public ResponseEntity<List<ModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
202 final List<ModuleReference> moduleReferences =
203 networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
204 .map(moduleReference -> modelMapper.map(moduleReference, ModuleReference.class))
205 .collect(Collectors.toList());
206 return new ResponseEntity<>(moduleReferences, HttpStatus.OK);
209 private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
210 for (final ConditionProperties conditionProperty : conditionProperties) {
211 if (conditionProperty.getName().equals("hasAllModules")) {
212 return executeCmHandleSearchesForModuleNames(conditionProperty);
214 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
217 log.warn("No valid conditions found {}.", conditionProperties);
218 return Collections.emptyList();
221 private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
222 return networkCmProxyDataService
223 .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
226 private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
227 final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
228 for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
229 moduleNames.add(moduleNameAsJsonObject.getModuleName());
234 private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
235 final CmHandleProperties cmHandleProperties = new CmHandleProperties();
236 for (final String cmHandleIdentifier : cmHandleIdentifiers) {
237 final CmHandleProperty cmHandleProperty = new CmHandleProperty();
238 cmHandleProperty.setCmHandleId(cmHandleIdentifier);
239 cmHandleProperties.add(cmHandleProperty);
241 return cmHandleProperties;