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.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         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
 117             resourceIdentifier,
 118             optionsParamInQuery,
 119             DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL,
 120             requestId, topicParamInQuery);
 121         return responseEntity.getBody();
 122     }
 123
 124     @Override
 125     public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 126                                                                final String resourceIdentifier,
 127                                                                final String optionsParamInQuery,
 128                                                                final String topicParamInQuery,
 129                                                                final String requestId) {
 130         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
 131             resourceIdentifier,
 132             optionsParamInQuery,
 133             DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING,
 134             requestId, topicParamInQuery);
 135         return responseEntity.getBody();
 136     }
 137
 138     @Override
 139     public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 140                                                                  final String resourceIdentifier,
 141                                                                  final OperationEnum operation,
 142                                                                  final String requestData,
 143                                                                  final String dataType) {
 144         CpsValidator.validateNameCharacters(cmHandleId);
 145         return dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
 146             requestData, dataType);
 147     }
 148
 149
 150     @Override
 151     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 152         CpsValidator.validateNameCharacters(cmHandleId);
 153         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 154     }
 155
 156     /**
 157      * Retrieve cm handle identifiers for the given list of module names.
 158      *
 159      * @param moduleNames module names.
 160      * @return a collection of anchor identifiers
 161      */
 162     @Override
 163     public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
 164         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
 165     }
 166
 167     @Override
 168     public Set<String> queryCmHandles(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 169
 170         cmHandleQueryApiParameters.getPublicProperties().forEach((key, value) -> {
 171             if (Strings.isNullOrEmpty(key)) {
 172                 throw new DataValidationException("Invalid Query Parameter.",
 173                     "Missing property name - please supply a valid name.");
 174             }
 175         });
 176
 177         return cpsAdminService.queryCmHandles(jsonObjectMapper.convertToValueType(cmHandleQueryApiParameters,
 178             org.onap.cps.spi.model.CmHandleQueryParameters.class));
 179     }
 180
 181     /**
 182      * Retrieve cm handle details for a given cm handle.
 183      *
 184      * @param cmHandleId cm handle identifier
 185      * @return cm handle details
 186      */
 187     @Override
 188     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 189         CpsValidator.validateNameCharacters(cmHandleId);
 190         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
 191         final YangModelCmHandle yangModelCmHandle =
 192             yangModelCmHandleRetriever.getYangModelCmHandle(cmHandleId);
 193         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
 194         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
 195         ncmpServiceCmHandle.setCmHandleId(yangModelCmHandle.getId());
 196         ncmpServiceCmHandle.setCompositeState(yangModelCmHandle.getCompositeState());
 197         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
 198         setPublicProperties(publicProperties, ncmpServiceCmHandle);
 199         return ncmpServiceCmHandle;
 200     }
 201
 202     /**
 203      * Get cm handle public properties for a given cm handle id.
 204      *
 205      * @param cmHandleId cm handle identifier
 206      * @return cm handle public properties
 207      */
 208     @Override
 209     public Map<String, String> getCmHandlePublicProperties(final String cmHandleId) {
 210         CpsValidator.validateNameCharacters(cmHandleId);
 211         final YangModelCmHandle yangModelCmHandle =
 212             yangModelCmHandleRetriever.getYangModelCmHandle(cmHandleId);
 213         final List<YangModelCmHandle.Property> yangModelPublicProperties = yangModelCmHandle.getPublicProperties();
 214         final Map<String, String> cmHandlePublicProperties = new HashMap<>();
 215         asPropertiesMap(yangModelPublicProperties, cmHandlePublicProperties);
 216         return cmHandlePublicProperties;
 217     }
 218
 219     /**
 220      * THis method registers a cm handle and initiates modules sync.
 221      *
 222      * @param dmiPluginRegistration dmi plugin registration information.
 223      * @return cm-handle registration response for create cm-handle requests.
 224      */
 225     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 226         final DmiPluginRegistration dmiPluginRegistration) {
 227         List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
 228         try {
 229             cmHandleRegistrationResponses = dmiPluginRegistration.getCreatedCmHandles().stream()
 230                 .map(cmHandle ->
 231                     YangModelCmHandle.toYangModelCmHandle(
 232                         dmiPluginRegistration.getDmiPlugin(),
 233                         dmiPluginRegistration.getDmiDataPlugin(),
 234                         dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
 235                 )
 236                 .map(this::registerAndSyncNewCmHandle)
 237                 .collect(Collectors.toList());
 238         } catch (final DataValidationException dataValidationException) {
 239             cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
 240                     .getCreatedCmHandles().stream()
 241                     .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
 242                 RegistrationError.CM_HANDLE_INVALID_ID));
 243         }
 244         return cmHandleRegistrationResponses;
 245     }
 246
 247     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 248         final String schemaSetName = moduleSyncService.syncAndCreateSchemaSet(yangModelCmHandle);
 249         final String anchorName = yangModelCmHandle.getId();
 250         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 251             anchorName);
 252     }
 253
 254     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 255         final List<String> tobeRemovedCmHandles) {
 256         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 257             new ArrayList<>(tobeRemovedCmHandles.size());
 258         for (final String cmHandle : tobeRemovedCmHandles) {
 259             try {
 260                 CpsValidator.validateNameCharacters(cmHandle);
 261                 deleteSchemaSetWithCascade(cmHandle);
 262                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 263                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 264                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 265             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 266                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 267                     cmHandle, dataNodeNotFoundException.getMessage());
 268                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 269                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 270             } catch (final DataValidationException dataValidationException) {
 271                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 272                     cmHandle, dataValidationException.getMessage());
 273                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 274                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 275             } catch (final Exception exception) {
 276                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 277                     cmHandle, exception.getMessage());
 278                 cmHandleRegistrationResponses.add(
 279                     CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 280             }
 281         }
 282         return cmHandleRegistrationResponses;
 283     }
 284
 285     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 286         try {
 287             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 288                 CASCADE_DELETE_ALLOWED);
 289         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 290             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 291         }
 292     }
 293
 294     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 295                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 296         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 297         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 298         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 299     }
 300
 301     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 302                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 303         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 304         asPropertiesMap(publicProperties, publicPropertiesMap);
 305         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 306     }
 307
 308     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 309                                  final Map<String, String> propertiesMap) {
 310         for (final YangModelCmHandle.Property property: properties) {
 311             propertiesMap.put(property.getName(), property.getValue());
 312         }
 313     }
 314
 315     private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 316         try {
 317             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 318                 jsonObjectMapper.asJsonString(yangModelCmHandle));
 319             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 320                 cmHandleJsonData, NO_TIMESTAMP);
 321             syncModulesAndCreateAnchor(yangModelCmHandle);
 322             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 323         } catch (final AlreadyDefinedException alreadyDefinedException) {
 324             return CmHandleRegistrationResponse.createFailureResponse(
 325                 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 326         } catch (final Exception exception) {
 327             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 328         }
 329     }
 330
 331 }