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  *  Modifications Copyright (C) 2021 highstreet technologies GmbH
   6  *  Modifications Copyright (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.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Set;
  38 import java.util.UUID;
  39 import java.util.stream.Collectors;
  40 import javax.validation.Valid;
  41 import javax.validation.constraints.NotNull;
  42 import lombok.RequiredArgsConstructor;
  43 import lombok.extern.slf4j.Slf4j;
  44 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  45 import org.onap.cps.ncmp.api.impl.exception.InvalidTopicException;
  46 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
  47 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  48 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
  49 import org.onap.cps.ncmp.rest.executor.CpsNcmpTaskExecutor;
  50 import org.onap.cps.ncmp.rest.mapper.RestOutputCmHandleStateMapper;
  51 import org.onap.cps.ncmp.rest.model.CmHandleProperties;
  52 import org.onap.cps.ncmp.rest.model.CmHandleProperty;
  53 import org.onap.cps.ncmp.rest.model.CmHandlePublicProperties;
  54 import org.onap.cps.ncmp.rest.model.CmHandleQueryRestParameters;
  55 import org.onap.cps.ncmp.rest.model.CmHandles;
  56 import org.onap.cps.ncmp.rest.model.ConditionProperties;
  57 import org.onap.cps.ncmp.rest.model.Conditions;
  58 import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
  59 import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
  60 import org.onap.cps.ncmp.rest.model.RestModuleReference;
  61 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
  62 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
  63 import org.onap.cps.utils.CpsValidator;
  64 import org.onap.cps.utils.JsonObjectMapper;
  65 import org.springframework.beans.factory.annotation.Value;
  66 import org.springframework.http.HttpStatus;
  67 import org.springframework.http.ResponseEntity;
  68 import org.springframework.web.bind.annotation.RequestMapping;
  69 import org.springframework.web.bind.annotation.RestController;
  70
  71 @Slf4j
  72 @RestController
  73 @RequestMapping("${rest.api.ncmp-base-path}")
  74 @RequiredArgsConstructor
  75 public class NetworkCmProxyController implements NetworkCmProxyApi {
  76
  77     private static final String NO_BODY = null;
  78     private static final String NO_REQUEST_ID = null;
  79     private static final String NO_TOPIC = null;
  80     private final NetworkCmProxyDataService networkCmProxyDataService;
  81     private final JsonObjectMapper jsonObjectMapper;
  82     private final NcmpRestInputMapper ncmpRestInputMapper;
  83     private final RestOutputCmHandleStateMapper restOutputCmHandleStateMapper;
  84     private final CpsNcmpTaskExecutor cpsNcmpTaskExecutor;
  85
  86     @Value("${notification.async.executor.time-out-value-in-ms:2000}")
  87     private int timeOutInMilliSeconds;
  88
  89     /**
  90      * Get resource data from operational datastore.
  91      *
  92      * @param cmHandle cm handle identifier
  93      * @param resourceIdentifier resource identifier
  94      * @param optionsParamInQuery options query parameter
  95      * @param topicParamInQuery topic query parameter
  96      * @return {@code ResponseEntity} response from dmi plugin
  97      */
  98     @Override
  99     public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
 100                                                                         final @NotNull @Valid String resourceIdentifier,
 101                                                                         final @Valid String optionsParamInQuery,
 102                                                                         final @Valid String topicParamInQuery) {
 103         if (isValidTopic(topicParamInQuery)) {
 104             final String requestId = UUID.randomUUID().toString();
 105             cpsNcmpTaskExecutor.executeTask(() ->
 106                 networkCmProxyDataService.getResourceDataOperationalForCmHandle(
 107                     cmHandle, resourceIdentifier, optionsParamInQuery, topicParamInQuery,
 108                         requestId
 109                 ), timeOutInMilliSeconds
 110             );
 111             return acknowledgeAsyncRequest(requestId);
 112         }
 113
 114         final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(
 115             cmHandle, resourceIdentifier, optionsParamInQuery, NO_TOPIC, NO_REQUEST_ID);
 116
 117         return ResponseEntity.ok(responseObject);
 118     }
 119
 120     /**
 121      * Get resource data from pass-through running datastore.
 122      *
 123      * @param cmHandle cm handle identifier
 124      * @param resourceIdentifier resource identifier
 125      * @param optionsParamInQuery options query parameter
 126      * @param topicParamInQuery topic query parameter
 127      * @return {@code ResponseEntity} response from dmi plugin
 128      */
 129     @Override
 130     public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
 131                                                                     final @NotNull @Valid String resourceIdentifier,
 132                                                                     final @Valid String optionsParamInQuery,
 133                                                                     final @Valid String topicParamInQuery) {
 134         if (isValidTopic(topicParamInQuery)) {
 135             final String resourceDataRequestId = UUID.randomUUID().toString();
 136             cpsNcmpTaskExecutor.executeTask(() ->
 137                 networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(
 138                     cmHandle, resourceIdentifier, optionsParamInQuery, topicParamInQuery,
 139                         resourceDataRequestId
 140                 ), timeOutInMilliSeconds
 141             );
 142             return acknowledgeAsyncRequest(resourceDataRequestId);
 143         }
 144
 145         final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(
 146             cmHandle, resourceIdentifier, optionsParamInQuery, NO_TOPIC, NO_REQUEST_ID);
 147
 148         return ResponseEntity.ok(responseObject);
 149     }
 150
 151     @Override
 152     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
 153         final String cmHandle,
 154         final Object requestBody, final String contentType) {
 155         final Object responseObject = networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 156             resourceIdentifier, PATCH, jsonObjectMapper.asJsonString(requestBody), contentType);
 157         return ResponseEntity.ok(responseObject);
 158     }
 159
 160     /**
 161      * Create resource data in datastore pass-through running for given cm-handle.
 162      *
 163      * @param resourceIdentifier resource identifier
 164      * @param cmHandle cm handle identifier
 165      * @param requestBody the request body
 166      * @param contentType content type of body
 167      * @return {@code ResponseEntity} response from dmi plugin
 168      */
 169     @Override
 170     public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
 171         final String cmHandle, final Object requestBody, final String contentType) {
 172         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 173                 resourceIdentifier, CREATE, jsonObjectMapper.asJsonString(requestBody), contentType);
 174         return new ResponseEntity<>(HttpStatus.CREATED);
 175     }
 176
 177     /**
 178      * Update resource data in datastore pass-through running for given cm-handle.
 179      *
 180      * @param resourceIdentifier resource identifier
 181      * @param cmHandle cm handle identifier
 182      * @param requestBody the request body
 183      * @param contentType content type of the body
 184      * @return response entity
 185      */
 186     @Override
 187     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
 188                                                                        final String cmHandle,
 189                                                                        final Object requestBody,
 190                                                                        final String contentType) {
 191         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 192                 resourceIdentifier, UPDATE, jsonObjectMapper.asJsonString(requestBody), contentType);
 193         return new ResponseEntity<>(HttpStatus.OK);
 194     }
 195
 196
 197     /**
 198      *  Delete resource data in datastore pass-through running for a given cm-handle.
 199      *
 200      * @param resourceIdentifier resource identifier
 201      * @param cmHandle cm handle identifier
 202      * @param contentType content type of the body
 203      * @return response entity no content if request is successful
 204      */
 205     @Override
 206     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandle,
 207                                                                      final String resourceIdentifier,
 208                                                                      final String contentType) {
 209         networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
 210             resourceIdentifier, DELETE, NO_BODY, contentType);
 211         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
 212     }
 213
 214     /**
 215      * Execute cm handle search.
 216      *
 217      * @param conditions the conditions
 218      * @return cm handles returned from search.
 219      */
 220     @Override
 221     public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
 222         final List<ConditionProperties> conditionProperties =
 223             conditions.getConditions().stream().collect(Collectors.toList());
 224         final CmHandles cmHandles = new CmHandles();
 225         cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
 226         return ResponseEntity.ok(cmHandles);
 227     }
 228
 229     /**
 230      * Query and return cm handles that match the given query parameters.
 231      *
 232      * @param cmHandleQueryRestParameters the cm handle query parameters
 233      * @return collection of cm handle ids
 234      */
 235     public ResponseEntity<List<String>> queryCmHandles(
 236         final CmHandleQueryRestParameters cmHandleQueryRestParameters) {
 237         final Set<String> cmHandleIds = networkCmProxyDataService.queryCmHandles(
 238             jsonObjectMapper.convertToValueType(cmHandleQueryRestParameters, CmHandleQueryApiParameters.class));
 239         return ResponseEntity.ok(List.copyOf(cmHandleIds));
 240     }
 241
 242     /**
 243      * Search for Cm Handle and Properties by Name.
 244      * @param cmHandleId cm-handle identifier
 245      * @return cm handle and its properties
 246      */
 247     @Override
 248     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
 249         final NcmpServiceCmHandle ncmpServiceCmHandle = networkCmProxyDataService.getNcmpServiceCmHandle(cmHandleId);
 250         final RestOutputCmHandle restOutputCmHandle = toRestOutputCmHandle(ncmpServiceCmHandle);
 251         return ResponseEntity.ok(restOutputCmHandle);
 252     }
 253
 254     /**
 255      * Get Cm Handle Properties by Cm Handle Id.
 256      * @param cmHandleId cm-handle identifier
 257      * @return cm handle and its properties
 258      */
 259     @Override
 260     public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
 261         final String cmHandleId) {
 262         final CmHandlePublicProperties cmHandlePublicProperties = new CmHandlePublicProperties();
 263         cmHandlePublicProperties.add(networkCmProxyDataService.getCmHandlePublicProperties(cmHandleId));
 264         final RestOutputCmHandlePublicProperties restOutputCmHandlePublicProperties =
 265             new RestOutputCmHandlePublicProperties();
 266         restOutputCmHandlePublicProperties.setPublicCmHandleProperties(cmHandlePublicProperties);
 267         return ResponseEntity.ok(restOutputCmHandlePublicProperties);
 268     }
 269
 270     /**
 271      * Return module references for a cm handle.
 272      *
 273      * @param cmHandle the cm handle
 274      * @return module references for cm handle. Namespace will be always blank because restConf does not include this.
 275      */
 276     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
 277         final List<RestModuleReference> restModuleReferences =
 278             networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
 279             .map(ncmpRestInputMapper::toRestModuleReference)
 280                 .collect(Collectors.toList());
 281         return new ResponseEntity<>(restModuleReferences, HttpStatus.OK);
 282     }
 283
 284     private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
 285         for (final ConditionProperties conditionProperty : conditionProperties) {
 286             if (conditionProperty.getName().equals("hasAllModules")) {
 287                 return executeCmHandleSearchesForModuleNames(conditionProperty);
 288             } else {
 289                 log.warn("Unrecognized condition name {}.", conditionProperty.getName());
 290             }
 291         }
 292         log.warn("No valid conditions found {}.", conditionProperties);
 293         return Collections.emptyList();
 294     }
 295
 296     private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
 297         return networkCmProxyDataService
 298             .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
 299     }
 300
 301     private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
 302         final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
 303         for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
 304             moduleNames.add(moduleNameAsJsonObject.getModuleName());
 305         }
 306         return moduleNames;
 307     }
 308
 309     private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
 310         final CmHandleProperties cmHandleProperties = new CmHandleProperties();
 311         for (final String cmHandleIdentifier : cmHandleIdentifiers) {
 312             final CmHandleProperty cmHandleProperty = new CmHandleProperty();
 313             cmHandleProperty.setCmHandleId(cmHandleIdentifier);
 314             cmHandleProperties.add(cmHandleProperty);
 315         }
 316         return cmHandleProperties;
 317     }
 318
 319     private RestOutputCmHandle toRestOutputCmHandle(final NcmpServiceCmHandle ncmpServiceCmHandle) {
 320         final RestOutputCmHandle restOutputCmHandle = new RestOutputCmHandle();
 321         final CmHandlePublicProperties cmHandlePublicProperties = new CmHandlePublicProperties();
 322         restOutputCmHandle.setCmHandle(ncmpServiceCmHandle.getCmHandleId());
 323         cmHandlePublicProperties.add(ncmpServiceCmHandle.getPublicProperties());
 324         restOutputCmHandle.setPublicCmHandleProperties(cmHandlePublicProperties);
 325         restOutputCmHandle.setState(restOutputCmHandleStateMapper.toRestOutputCmHandleState(
 326                 ncmpServiceCmHandle.getCompositeState()));
 327         return restOutputCmHandle;
 328     }
 329
 330     private static boolean isValidTopic(final String topicName) {
 331         if (topicName == null) {
 332             return false;
 333         }
 334         if (CpsValidator.validateTopicName(topicName)) {
 335             return true;
 336         }
 337         throw new InvalidTopicException("Topic name " + topicName + " is invalid", "invalid topic");
 338     }
 339
 340     private ResponseEntity<Object> acknowledgeAsyncRequest(final String requestId) {
 341         final Map<String, Object> acknowledgeData = new HashMap<>(1);
 342         acknowledgeData.put("requestId", requestId);
 343         return ResponseEntity.ok(acknowledgeData);
 344     }
 345
 346 }
 347