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 import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters;
  34
  35 import java.util.ArrayList;
  36 import java.util.Collection;
  37 import java.util.HashMap;
  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.CpsDataService;
  45 import org.onap.cps.api.CpsModuleService;
  46 import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService;
  47 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  48 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
  49 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
  50 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  51 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  52 import org.onap.cps.ncmp.api.inventory.CmHandleState;
  53 import org.onap.cps.ncmp.api.inventory.CompositeState;
  54 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  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.CmHandleQueryServiceParameters;
  66 import org.onap.cps.spi.model.ModuleReference;
  67 import org.onap.cps.utils.CpsValidator;
  68 import org.onap.cps.utils.JsonObjectMapper;
  69 import org.springframework.http.ResponseEntity;
  70 import org.springframework.stereotype.Service;
  71
  72 @Slf4j
  73 @Service
  74 @RequiredArgsConstructor
  75 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  76
  77     private final CpsDataService cpsDataService;
  78
  79     private final JsonObjectMapper jsonObjectMapper;
  80
  81     private final DmiDataOperations dmiDataOperations;
  82
  83     private final CpsModuleService cpsModuleService;
  84
  85     private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
  86
  87     private final InventoryPersistence inventoryPersistence;
  88
  89     private final NetworkCmProxyCmHandlerQueryService networkCmProxyCmHandlerQueryService;
  90
  91     @Override
  92     public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
  93             final DmiPluginRegistration dmiPluginRegistration) {
  94         dmiPluginRegistration.validateDmiPluginRegistration();
  95         final DmiPluginRegistrationResponse 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 handles with details for the given query parameters.
 158      *
 159      * @param cmHandleQueryApiParameters cm handle query parameters
 160      * @return cm handles with details
 161      */
 162     @Override
 163     public Set<NcmpServiceCmHandle> executeCmHandleSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 164         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
 165                 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
 166
 167         validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
 168
 169         return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryServiceParameters);
 170     }
 171
 172     /**
 173      * Retrieve cm handle ids for the given query parameters.
 174      *
 175      * @param cmHandleQueryApiParameters cm handle query parameters
 176      * @return cm handle ids
 177      */
 178     @Override
 179     public Set<String> executeCmHandleIdSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 180         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
 181                 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
 182
 183         validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
 184
 185         return networkCmProxyCmHandlerQueryService.queryCmHandleIds(cmHandleQueryServiceParameters);
 186     }
 187
 188     /**
 189      * Retrieve cm handle details for a given cm handle.
 190      *
 191      * @param cmHandleId cm handle identifier
 192      * @return cm handle details
 193      */
 194     @Override
 195     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 196         CpsValidator.validateNameCharacters(cmHandleId);
 197         return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(
 198                 inventoryPersistence.getYangModelCmHandle(cmHandleId));
 199     }
 200
 201     /**
 202      * Get cm handle public properties for a given cm handle id.
 203      *
 204      * @param cmHandleId cm handle identifier
 205      * @return cm handle public properties
 206      */
 207     @Override
 208     public Map<String, String> getCmHandlePublicProperties(final String cmHandleId) {
 209         CpsValidator.validateNameCharacters(cmHandleId);
 210         final YangModelCmHandle yangModelCmHandle =
 211             inventoryPersistence.getYangModelCmHandle(cmHandleId);
 212         final List<YangModelCmHandle.Property> yangModelPublicProperties = yangModelCmHandle.getPublicProperties();
 213         final Map<String, String> cmHandlePublicProperties = new HashMap<>();
 214         YangDataConverter.asPropertiesMap(yangModelPublicProperties, cmHandlePublicProperties);
 215         return cmHandlePublicProperties;
 216     }
 217
 218     /**
 219      * Get cm handle composite state for a given cm handle id.
 220      *
 221      * @param cmHandleId cm handle identifier
 222      * @return cm handle state
 223      */
 224     @Override
 225     public CompositeState getCmHandleCompositeState(final String cmHandleId) {
 226         CpsValidator.validateNameCharacters(cmHandleId);
 227         return inventoryPersistence.getYangModelCmHandle(cmHandleId).getCompositeState();
 228     }
 229
 230     /**
 231      * THis method registers a cm handle and initiates modules sync.
 232      *
 233      * @param dmiPluginRegistration dmi plugin registration information.
 234      * @return cm-handle registration response for create cm-handle requests.
 235      */
 236     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 237             final DmiPluginRegistration dmiPluginRegistration) {
 238         List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
 239         try {
 240             cmHandleRegistrationResponses = dmiPluginRegistration.getCreatedCmHandles().stream()
 241                 .map(cmHandle -> {
 242                     setCompositeStateToAdvised(cmHandle);
 243                     return YangModelCmHandle.toYangModelCmHandle(
 244                         dmiPluginRegistration.getDmiPlugin(),
 245                         dmiPluginRegistration.getDmiDataPlugin(),
 246                         dmiPluginRegistration.getDmiModelPlugin(),
 247                         cmHandle);
 248                     }
 249                 )
 250                 .map(this::registerNewCmHandle)
 251                 .collect(Collectors.toList());
 252         } catch (final DataValidationException dataValidationException) {
 253             cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
 254                             .getCreatedCmHandles().stream()
 255                             .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
 256                     RegistrationError.CM_HANDLE_INVALID_ID));
 257         }
 258         return cmHandleRegistrationResponses;
 259     }
 260
 261     private void setCompositeStateToAdvised(final NcmpServiceCmHandle ncmpServiceCmHandle) {
 262         final CompositeState compositeState = new CompositeState();
 263         compositeState.setCmHandleState(CmHandleState.ADVISED);
 264         compositeState.setLastUpdateTimeNow();
 265         ncmpServiceCmHandle.setCompositeState(compositeState);
 266     }
 267
 268     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 269             final List<String> tobeRemovedCmHandles) {
 270         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 271                 new ArrayList<>(tobeRemovedCmHandles.size());
 272         for (final String cmHandle : tobeRemovedCmHandles) {
 273             try {
 274                 CpsValidator.validateNameCharacters(cmHandle);
 275                 deleteSchemaSetWithCascade(cmHandle);
 276                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 277                         "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 278                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 279             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 280                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 281                         cmHandle, dataNodeNotFoundException.getMessage());
 282                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 283                         .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 284             } catch (final DataValidationException dataValidationException) {
 285                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 286                         cmHandle, dataValidationException.getMessage());
 287                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 288                         .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 289             } catch (final Exception exception) {
 290                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 291                         cmHandle, exception.getMessage());
 292                 cmHandleRegistrationResponses.add(
 293                         CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 294             }
 295         }
 296         return cmHandleRegistrationResponses;
 297     }
 298
 299     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 300         try {
 301             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 302                     CASCADE_DELETE_ALLOWED);
 303         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 304             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 305         }
 306     }
 307
 308     private CmHandleRegistrationResponse registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 309         try {
 310             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 311                     jsonObjectMapper.asJsonString(yangModelCmHandle));
 312             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 313                     cmHandleJsonData, NO_TIMESTAMP);
 314             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 315         } catch (final AlreadyDefinedException alreadyDefinedException) {
 316             return CmHandleRegistrationResponse.createFailureResponse(
 317                     yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 318         } catch (final Exception exception) {
 319             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 320         }
 321     }
 322 }