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     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 198                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 199         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 200         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 201         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 202     }
 203
 204     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 205                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 206         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 207         asPropertiesMap(publicProperties, publicPropertiesMap);
 208         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 209     }
 210
 211     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 212                                  final Map<String, String> propertiesMap) {
 213         for (final YangModelCmHandle.Property property: properties) {
 214             propertiesMap.put(property.getName(), property.getValue());
 215         }
 216     }
 217
 218     /**
 219      * THis method registers a cm handle and initiates modules sync.
 220      *
 221      * @param dmiPluginRegistration dmi plugin registration information.
 222      * @return cm-handle registration response for create cm-handle requests.
 223      */
 224     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 225         final DmiPluginRegistration dmiPluginRegistration) {
 226         return dmiPluginRegistration.getCreatedCmHandles().stream()
 227             .map(cmHandle ->
 228                 YangModelCmHandle.toYangModelCmHandle(
 229                     dmiPluginRegistration.getDmiPlugin(),
 230                     dmiPluginRegistration.getDmiDataPlugin(),
 231                     dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
 232             )
 233             .map(this::registerAndSyncNewCmHandle)
 234             .collect(Collectors.toList());
 235     }
 236
 237     private static Object handleResponse(final ResponseEntity<?> responseEntity, final OperationEnum operation) {
 238         if (responseEntity.getStatusCode().is2xxSuccessful()) {
 239             return responseEntity.getBody();
 240         } else {
 241             final String exceptionMessage = "Unable to " + operation.toString() + " resource data.";
 242             throw new HttpClientRequestException(exceptionMessage, (String) responseEntity.getBody(),
 243                     responseEntity.getStatusCodeValue());
 244         }
 245     }
 246
 247     private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 248         try {
 249             CpsValidator.validateNameCharacters(yangModelCmHandle.getId());
 250             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 251                 jsonObjectMapper.asJsonString(yangModelCmHandle));
 252             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 253                 cmHandleJsonData, NO_TIMESTAMP);
 254             syncModulesAndCreateAnchor(yangModelCmHandle);
 255             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 256         } catch (final AlreadyDefinedException alreadyDefinedException) {
 257             return CmHandleRegistrationResponse.createFailureResponse(
 258                 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 259         } catch (final DataValidationException dataValidationException) {
 260             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(),
 261                 RegistrationError.CM_HANDLE_INVALID_ID);
 262         } catch (final Exception exception) {
 263             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 264         }
 265     }
 266
 267     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 268         syncAndCreateSchemaSet(yangModelCmHandle);
 269         createAnchor(yangModelCmHandle);
 270     }
 271
 272     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 273         final List<String> tobeRemovedCmHandles) {
 274         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 275             new ArrayList<>(tobeRemovedCmHandles.size());
 276         for (final String cmHandle : tobeRemovedCmHandles) {
 277             try {
 278                 CpsValidator.validateNameCharacters(cmHandle);
 279                 deleteSchemaSetWithCascade(cmHandle);
 280                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 281                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 282                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 283             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 284                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 285                     cmHandle, dataNodeNotFoundException.getMessage());
 286                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 287                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 288             } catch (final DataValidationException dataValidationException) {
 289                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 290                     cmHandle, dataValidationException.getMessage());
 291                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 292                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 293             } catch (final Exception exception) {
 294                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 295                     cmHandle, exception.getMessage());
 296                 cmHandleRegistrationResponses.add(
 297                     CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 298             }
 299         }
 300         return cmHandleRegistrationResponses;
 301     }
 302
 303     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 304         try {
 305             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 306                 CASCADE_DELETE_ALLOWED);
 307         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 308             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 309         }
 310     }
 311
 312     private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
 313         final Collection<ModuleReference> moduleReferencesFromCmHandle =
 314             dmiModelOperations.getModuleReferences(yangModelCmHandle);
 315
 316         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
 317             .identifyNewModuleReferences(moduleReferencesFromCmHandle);
 318
 319         final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
 320             moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
 321                 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
 322             ).collect(Collectors.toList());
 323
 324         final Map<String, String> newModuleNameToContentMap;
 325         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
 326             newModuleNameToContentMap = new HashMap<>();
 327         } else {
 328             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 329                 identifiedNewModuleReferencesFromCmHandle);
 330         }
 331         cpsModuleService
 332             .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 333                 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
 334     }
 335
 336     private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
 337         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 338             yangModelCmHandle.getId());
 339     }
 340
 341     private Object getResourceDataResponse(final String cmHandleId,
 342                                            final String resourceIdentifier,
 343                                            final DmiOperations.DataStoreEnum dataStore,
 344                                            final String optionsParamInQuery,
 345                                            final String topicParamInQuery,
 346                                            final String requestId) {
 347         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
 348                 cmHandleId, resourceIdentifier, optionsParamInQuery, dataStore, requestId, topicParamInQuery);
 349         return handleResponse(responseEntity, OperationEnum.READ);
 350     }
 351 }