cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 highstreet technologies GmbH
   4  *  Modifications Copyright (C) 2021-2022 Nordix Foundation
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   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.api.impl;
  25
  26 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
  27 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
  28 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
  29 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
  30 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
  31 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  32 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
  33
  34 import com.google.common.base.Strings;
  35 import java.util.ArrayList;
  36 import java.util.Collection;
  37 import java.util.HashMap;
  38 import java.util.LinkedHashMap;
  39 import java.util.List;
  40 import java.util.Map;
  41 import java.util.Set;
  42 import java.util.stream.Collectors;
  43 import lombok.RequiredArgsConstructor;
  44 import lombok.extern.slf4j.Slf4j;
  45 import org.onap.cps.api.CpsAdminService;
  46 import org.onap.cps.api.CpsDataService;
  47 import org.onap.cps.api.CpsModuleService;
  48 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  49 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
  50 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
  51 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
  52 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
  53 import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever;
  54 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  55 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
  56 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
  57 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
  58 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
  59 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
  60 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  61 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  62 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  63 import org.onap.cps.spi.exceptions.DataValidationException;
  64 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  65 import org.onap.cps.spi.model.ModuleReference;
  66 import org.onap.cps.utils.CpsValidator;
  67 import org.onap.cps.utils.JsonObjectMapper;
  68 import org.springframework.http.ResponseEntity;
  69 import org.springframework.stereotype.Service;
  70
  71 @Slf4j
  72 @Service
  73 @RequiredArgsConstructor
  74 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  75
  76     private final CpsDataService cpsDataService;
  77
  78     private final JsonObjectMapper jsonObjectMapper;
  79
  80     private final DmiDataOperations dmiDataOperations;
  81
  82     private final DmiModelOperations dmiModelOperations;
  83
  84     private final CpsModuleService cpsModuleService;
  85
  86     private final CpsAdminService cpsAdminService;
  87
  88     private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
  89
  90     private final YangModelCmHandleRetriever yangModelCmHandleRetriever;
  91
  92     @Override
  93     public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
  94         final DmiPluginRegistration dmiPluginRegistration) {
  95         dmiPluginRegistration.validateDmiPluginRegistration();
  96         final var dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
  97         dmiPluginRegistrationResponse.setRemovedCmHandles(
  98             parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
  99         if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
 100             dmiPluginRegistrationResponse.setCreatedCmHandles(
 101                 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration));
 102         }
 103         if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
 104             dmiPluginRegistrationResponse.setUpdatedCmHandles(
 105                 networkCmProxyDataServicePropertyHandler
 106                     .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
 107         }
 108         return dmiPluginRegistrationResponse;
 109     }
 110
 111     @Override
 112     public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
 113                                                         final String resourceIdentifier,
 114                                                         final String optionsParamInQuery,
 115                                                         final String topicParamInQuery,
 116                                                         final String requestId) {
 117         CpsValidator.validateNameCharacters(cmHandleId);
 118         return getResourceDataResponse(cmHandleId, resourceIdentifier,
 119                 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL, optionsParamInQuery, topicParamInQuery, requestId);
 120     }
 121
 122     @Override
 123     public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 124                                                                final String resourceIdentifier,
 125                                                                final String optionsParamInQuery,
 126                                                                final String topicParamInQuery,
 127                                                                final String requestId) {
 128         CpsValidator.validateNameCharacters(cmHandleId);
 129         return getResourceDataResponse(cmHandleId, resourceIdentifier,
 130                 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING, optionsParamInQuery, topicParamInQuery, requestId);
 131     }
 132
 133     @Override
 134     public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 135                                                                final String resourceIdentifier,
 136                                                                final OperationEnum operation,
 137                                                                final String requestData,
 138                                                                final String dataType) {
 139         CpsValidator.validateNameCharacters(cmHandleId);
 140         return handleResponse(
 141                 dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
 142                         requestData, dataType), operation);
 143     }
 144
 145
 146     @Override
 147     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 148         CpsValidator.validateNameCharacters(cmHandleId);
 149         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 150     }
 151
 152     /**
 153      * Retrieve cm handle identifiers for the given list of module names.
 154      *
 155      * @param moduleNames module names.
 156      * @return a collection of anchor identifiers
 157      */
 158     @Override
 159     public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
 160         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
 161     }
 162
 163     @Override
 164     public Set<String> queryCmHandles(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 165
 166         cmHandleQueryApiParameters.getPublicProperties().forEach((key, value) -> {
 167             if (Strings.isNullOrEmpty(key)) {
 168                 throw new DataValidationException("Invalid Query Parameter.",
 169                     "Missing property name - please supply a valid name.");
 170             }
 171         });
 172
 173         return cpsAdminService.queryCmHandles(jsonObjectMapper.convertToValueType(cmHandleQueryApiParameters,
 174                 org.onap.cps.spi.model.CmHandleQueryParameters.class));
 175     }
 176
 177     /**
 178      * Retrieve cm handle details for a given cm handle.
 179      *
 180      * @param cmHandleId cm handle identifier
 181      * @return cm handle details
 182      */
 183     @Override
 184     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 185         CpsValidator.validateNameCharacters(cmHandleId);
 186         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
 187         final YangModelCmHandle yangModelCmHandle =
 188             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
 189         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
 190         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
 191         ncmpServiceCmHandle.setCmHandleId(yangModelCmHandle.getId());
 192         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
 193         setPublicProperties(publicProperties, ncmpServiceCmHandle);
 194         return ncmpServiceCmHandle;
 195     }
 196
 197     /**
 198      * THis method registers a cm handle and initiates modules sync.
 199      *
 200      * @param dmiPluginRegistration dmi plugin registration information.
 201      * @return cm-handle registration response for create cm-handle requests.
 202      */
 203     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 204         final DmiPluginRegistration dmiPluginRegistration) {
 205         List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
 206         try {
 207             cmHandleRegistrationResponses = dmiPluginRegistration.getCreatedCmHandles().stream()
 208                 .map(cmHandle ->
 209                     YangModelCmHandle.toYangModelCmHandle(
 210                         dmiPluginRegistration.getDmiPlugin(),
 211                         dmiPluginRegistration.getDmiDataPlugin(),
 212                         dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
 213                 )
 214                 .map(this::registerAndSyncNewCmHandle)
 215                 .collect(Collectors.toList());
 216         } catch (final DataValidationException dataValidationException) {
 217             cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
 218                     .getCreatedCmHandles().stream()
 219                     .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
 220                 RegistrationError.CM_HANDLE_INVALID_ID));
 221         }
 222         return cmHandleRegistrationResponses;
 223     }
 224
 225     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 226         syncAndCreateSchemaSet(yangModelCmHandle);
 227         createAnchor(yangModelCmHandle);
 228     }
 229
 230     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 231         final List<String> tobeRemovedCmHandles) {
 232         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 233             new ArrayList<>(tobeRemovedCmHandles.size());
 234         for (final String cmHandle : tobeRemovedCmHandles) {
 235             try {
 236                 CpsValidator.validateNameCharacters(cmHandle);
 237                 deleteSchemaSetWithCascade(cmHandle);
 238                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 239                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 240                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 241             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 242                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 243                     cmHandle, dataNodeNotFoundException.getMessage());
 244                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 245                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 246             } catch (final DataValidationException dataValidationException) {
 247                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 248                     cmHandle, dataValidationException.getMessage());
 249                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 250                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 251             } catch (final Exception exception) {
 252                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 253                     cmHandle, exception.getMessage());
 254                 cmHandleRegistrationResponses.add(
 255                     CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 256             }
 257         }
 258         return cmHandleRegistrationResponses;
 259     }
 260
 261     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 262         try {
 263             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 264                 CASCADE_DELETE_ALLOWED);
 265         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 266             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 267         }
 268     }
 269
 270     private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
 271         final Collection<ModuleReference> moduleReferencesFromCmHandle =
 272             dmiModelOperations.getModuleReferences(yangModelCmHandle);
 273
 274         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
 275             .identifyNewModuleReferences(moduleReferencesFromCmHandle);
 276
 277         final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
 278             moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
 279                 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
 280             ).collect(Collectors.toList());
 281
 282         final Map<String, String> newModuleNameToContentMap;
 283         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
 284             newModuleNameToContentMap = new HashMap<>();
 285         } else {
 286             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 287                 identifiedNewModuleReferencesFromCmHandle);
 288         }
 289         cpsModuleService
 290             .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 291                 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
 292     }
 293
 294     private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
 295         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 296             yangModelCmHandle.getId());
 297     }
 298
 299     private Object getResourceDataResponse(final String cmHandleId,
 300                                            final String resourceIdentifier,
 301                                            final DmiOperations.DataStoreEnum dataStore,
 302                                            final String optionsParamInQuery,
 303                                            final String topicParamInQuery,
 304                                            final String requestId) {
 305         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
 306                 cmHandleId, resourceIdentifier, optionsParamInQuery, dataStore, requestId, topicParamInQuery);
 307         return handleResponse(responseEntity, OperationEnum.READ);
 308     }
 309
 310     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 311                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 312         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 313         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 314         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 315     }
 316
 317     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 318                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 319         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 320         asPropertiesMap(publicProperties, publicPropertiesMap);
 321         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 322     }
 323
 324     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 325                                  final Map<String, String> propertiesMap) {
 326         for (final YangModelCmHandle.Property property: properties) {
 327             propertiesMap.put(property.getName(), property.getValue());
 328         }
 329     }
 330
 331
 332     private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 333         try {
 334             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 335                 jsonObjectMapper.asJsonString(yangModelCmHandle));
 336             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 337                 cmHandleJsonData, NO_TIMESTAMP);
 338             syncModulesAndCreateAnchor(yangModelCmHandle);
 339             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 340         } catch (final AlreadyDefinedException alreadyDefinedException) {
 341             return CmHandleRegistrationResponse.createFailureResponse(
 342                 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 343         } catch (final Exception exception) {
 344             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 345         }
 346     }
 347
 348     private static Object handleResponse(final ResponseEntity<?> responseEntity, final OperationEnum operation) {
 349         if (responseEntity.getStatusCode().is2xxSuccessful()) {
 350             return responseEntity.getBody();
 351         } else {
 352             final String exceptionMessage = "Unable to " + operation.toString() + " resource data.";
 353             throw new HttpClientRequestException(exceptionMessage, (String) responseEntity.getBody(),
 354                 responseEntity.getStatusCodeValue());
 355         }
 356     }
 357
 358 }