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