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