cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java

   1 /*
   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-2022 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
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.ncmp.rest.controller;
  25
  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;
  30
  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;
  58
  59 @Slf4j
  60 @RestController
  61 @RequestMapping("${rest.api.ncmp-base-path}")
  62 @RequiredArgsConstructor
  63 public class NetworkCmProxyController implements NetworkCmProxyApi {
  64
  65     private static final String NO_BODY = null;
  66
  67     private final NetworkCmProxyDataService networkCmProxyDataService;
  68     private final JsonObjectMapper jsonObjectMapper;
  69     private final NcmpRestInputMapper ncmpRestInputMapper;
  70
  71     /**
  72      * Get resource data from operational datastore.
  73      *
  74      * @param cmHandle cm handle identifier
  75      * @param resourceIdentifier resource identifier
  76      * @param optionsParamInQuery options query parameter
  77      * @param topicParamInQuery topic query parameter
  78      * @return {@code ResponseEntity} response from dmi plugin
  79      */
  80     @Override
  81     public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
  82                                                                         final @NotNull @Valid String resourceIdentifier,
  83                                                                         final @Valid String optionsParamInQuery,
  84                                                                         final @Valid String topicParamInQuery) {
  85         final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(cmHandle,
  86                 resourceIdentifier,
  87                 optionsParamInQuery,
  88                 topicParamInQuery);
  89         return ResponseEntity.ok(responseObject);
  90     }
  91
  92     /**
  93      * Get resource data from pass-through running datastore.
  94      *
  95      * @param cmHandle cm handle identifier
  96      * @param resourceIdentifier resource identifier
  97      * @param optionsParamInQuery options query parameter
  98      * @param topicParamInQuery topic query parameter
  99      * @return {@code ResponseEntity} response from dmi plugin
 100      */
 101     @Override
 102     public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
 103                                                                     final @NotNull @Valid String resourceIdentifier,
 104                                                                     final @Valid String optionsParamInQuery,
 105                                                                     final @Valid String topicParamInQuery) {
 106         final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
 107                 resourceIdentifier,
 108                 optionsParamInQuery,
 109                 topicParamInQuery);
 110         return ResponseEntity.ok(responseObject);
 111     }
 112
 113     @Override
 114     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
 115         final String cmHandle,
 116         final Object requestBody, final String contentType) {
 117         final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 118             resourceIdentifier, PATCH, jsonObjectMapper.asJsonString(requestBody), contentType);
 119         return ResponseEntity.ok(responseObject);
 120     }
 121
 122     /**
 123      * Create resource data in datastore pass-through running for given cm-handle.
 124      *
 125      * @param resourceIdentifier resource identifier
 126      * @param cmHandle cm handle identifier
 127      * @param requestBody the request body
 128      * @param contentType content type of body
 129      * @return {@code ResponseEntity} response from dmi plugin
 130      */
 131     @Override
 132     public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
 133         final String cmHandle, final Object requestBody, final String contentType) {
 134         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 135                 resourceIdentifier, CREATE, jsonObjectMapper.asJsonString(requestBody), contentType);
 136         return new ResponseEntity<>(HttpStatus.CREATED);
 137     }
 138
 139     /**
 140      * Update resource data in datastore pass-through running for given cm-handle.
 141      *
 142      * @param resourceIdentifier resource identifier
 143      * @param cmHandle cm handle identifier
 144      * @param requestBody the request body
 145      * @param contentType content type of the body
 146      * @return response entity
 147      */
 148     @Override
 149     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
 150                                                                        final String cmHandle,
 151                                                                        final Object requestBody,
 152                                                                        final String contentType) {
 153         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 154                 resourceIdentifier, UPDATE, jsonObjectMapper.asJsonString(requestBody), contentType);
 155         return new ResponseEntity<>(HttpStatus.OK);
 156     }
 157
 158
 159     /**
 160      *  Delete resource data in datastore pass-through running for a given cm-handle.
 161      *
 162      * @param resourceIdentifier resource identifier
 163      * @param cmHandle cm handle identifier
 164      * @param contentType content type of the body
 165      * @return response entity no content if request is successful
 166      */
 167     @Override
 168     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
 169                                                                      final String resourceIdentifier,
 170                                                                      final String contentType) {
 171         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 172             resourceIdentifier, DELETE, NO_BODY, contentType);
 173         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 174     }
 175
 176     /**
 177      * Execute cm handle search.
 178      *
 179      * @param conditions the conditions
 180      * @return cm handles returned from search.
 181      */
 182     @Override
 183     public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
 184         final List<ConditionProperties> conditionProperties =
 185             conditions.getConditions().stream().collect(Collectors.toList());
 186         final CmHandles cmHandles = new CmHandles();
 187         cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
 188         return ResponseEntity.ok(cmHandles);
 189     }
 190
 191     /**
 192      * Search for Cm Handle and Properties by Name.
 193      * @param cmHandleId cm-handle identifier
 194      * @return cm handle and its properties
 195      */
 196     @Override
 197     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
 198         final NcmpServiceCmHandle ncmpServiceCmHandle = networkCmProxyDataService.getNcmpServiceCmHandle(cmHandleId);
 199         final RestOutputCmHandle restOutputCmHandle = toRestOutputCmHandle(ncmpServiceCmHandle);
 200         return ResponseEntity.ok(restOutputCmHandle);
 201     }
 202
 203     /**
 204      * Return module references for a cm handle.
 205      *
 206      * @param cmHandle the cm handle
 207      * @return module references for cm handle. Namespace will be always blank because restConf does not include this.
 208      */
 209     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
 210         final List<RestModuleReference> restModuleReferences =
 211             networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
 212             .map(ncmpRestInputMapper::toRestModuleReference)
 213                 .collect(Collectors.toList());
 214         return new ResponseEntity<>(restModuleReferences, HttpStatus.OK);
 215     }
 216
 217     private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
 218         for (final ConditionProperties conditionProperty : conditionProperties) {
 219             if (conditionProperty.getName().equals("hasAllModules")) {
 220                 return executeCmHandleSearchesForModuleNames(conditionProperty);
 221             } else {
 222                 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
 223             }
 224         }
 225         log.warn("No valid conditions found {}.", conditionProperties);
 226         return Collections.emptyList();
 227     }
 228
 229     private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
 230         return networkCmProxyDataService
 231             .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
 232     }
 233
 234     private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
 235         final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
 236         for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
 237             moduleNames.add(moduleNameAsJsonObject.getModuleName());
 238         }
 239         return moduleNames;
 240     }
 241
 242     private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
 243         final CmHandleProperties cmHandleProperties = new CmHandleProperties();
 244         for (final String cmHandleIdentifier : cmHandleIdentifiers) {
 245             final CmHandleProperty cmHandleProperty = new CmHandleProperty();
 246             cmHandleProperty.setCmHandleId(cmHandleIdentifier);
 247             cmHandleProperties.add(cmHandleProperty);
 248         }
 249         return cmHandleProperties;
 250     }
 251
 252     private RestOutputCmHandle toRestOutputCmHandle(final NcmpServiceCmHandle ncmpServiceCmHandle) {
 253         final RestOutputCmHandle restOutputCmHandle = new RestOutputCmHandle();
 254         final CmHandlePublicProperties cmHandlePublicProperties = new CmHandlePublicProperties();
 255         restOutputCmHandle.setCmHandle(ncmpServiceCmHandle.getCmHandleID());
 256         cmHandlePublicProperties.add(ncmpServiceCmHandle.getPublicProperties());
 257         restOutputCmHandle.setPublicCmHandleProperties(cmHandlePublicProperties);
 258         return restOutputCmHandle;
 259     }
 260 }