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.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
  27 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  28 import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters;
  29
  30 import java.time.OffsetDateTime;
  31 import java.util.ArrayList;
  32 import java.util.Collection;
  33 import java.util.HashMap;
  34 import java.util.HashSet;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Set;
  38 import java.util.stream.Collectors;
  39 import lombok.RequiredArgsConstructor;
  40 import lombok.extern.slf4j.Slf4j;
  41 import org.onap.cps.api.CpsDataService;
  42 import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService;
  43 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  44 import org.onap.cps.ncmp.api.impl.event.lcm.LcmEventsCmHandleStateHandler;
  45 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
  46 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
  47 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  48 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  49 import org.onap.cps.ncmp.api.inventory.CmHandleQueries;
  50 import org.onap.cps.ncmp.api.inventory.CmHandleState;
  51 import org.onap.cps.ncmp.api.inventory.CompositeState;
  52 import org.onap.cps.ncmp.api.inventory.CompositeStateUtils;
  53 import org.onap.cps.ncmp.api.inventory.DataStoreSyncState;
  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.FetchDescendantsOption;
  62 import org.onap.cps.spi.exceptions.AlreadyDefinedExceptionBatch;
  63 import org.onap.cps.spi.exceptions.CpsException;
  64 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  65 import org.onap.cps.spi.exceptions.DataValidationException;
  66 import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
  67 import org.onap.cps.spi.model.ModuleDefinition;
  68 import org.onap.cps.spi.model.ModuleReference;
  69 import org.onap.cps.utils.CpsValidator;
  70 import org.onap.cps.utils.JsonObjectMapper;
  71 import org.springframework.http.ResponseEntity;
  72 import org.springframework.stereotype.Service;
  73
  74 @Slf4j
  75 @Service
  76 @RequiredArgsConstructor
  77 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  78
  79     private final JsonObjectMapper jsonObjectMapper;
  80
  81     private final DmiDataOperations dmiDataOperations;
  82
  83     private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
  84
  85     private final InventoryPersistence inventoryPersistence;
  86
  87     private final CmHandleQueries cmHandleQueries;
  88
  89     private final NetworkCmProxyCmHandlerQueryService networkCmProxyCmHandlerQueryService;
  90
  91     private final LcmEventsCmHandleStateHandler lcmEventsCmHandleStateHandler;
  92
  93     private final CpsDataService cpsDataService;
  94
  95     @Override
  96     public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
  97             final DmiPluginRegistration dmiPluginRegistration) {
  98         dmiPluginRegistration.validateDmiPluginRegistration();
  99         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
 100         dmiPluginRegistrationResponse.setRemovedCmHandles(
 101                 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
 102         if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
 103             dmiPluginRegistrationResponse.setCreatedCmHandles(
 104                     parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration));
 105         }
 106         if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
 107             dmiPluginRegistrationResponse.setUpdatedCmHandles(
 108                     networkCmProxyDataServicePropertyHandler
 109                             .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
 110         }
 111         return dmiPluginRegistrationResponse;
 112     }
 113
 114     @Override
 115     public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
 116                                                         final String resourceIdentifier,
 117                                                         final String optionsParamInQuery,
 118                                                         final String topicParamInQuery,
 119                                                         final String requestId) {
 120         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
 121                 resourceIdentifier,
 122                 optionsParamInQuery,
 123                 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL,
 124                 requestId, topicParamInQuery);
 125         return responseEntity.getBody();
 126     }
 127
 128     @Override
 129     public Object getResourceDataOperational(final String cmHandleId,
 130                                              final String resourceIdentifier,
 131                                              final FetchDescendantsOption fetchDescendantsOption) {
 132         return cpsDataService.getDataNode(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, resourceIdentifier,
 133                 fetchDescendantsOption);
 134     }
 135
 136     @Override
 137     public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 138                                                                final String resourceIdentifier,
 139                                                                final String optionsParamInQuery,
 140                                                                final String topicParamInQuery,
 141                                                                final String requestId) {
 142         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
 143                 resourceIdentifier,
 144                 optionsParamInQuery,
 145                 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING,
 146                 requestId, topicParamInQuery);
 147         return responseEntity.getBody();
 148     }
 149
 150     @Override
 151     public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 152                                                                  final String resourceIdentifier,
 153                                                                  final OperationEnum operation,
 154                                                                  final String requestData,
 155                                                                  final String dataType) {
 156         CpsValidator.validateNameCharacters(cmHandleId);
 157         return dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
 158                 requestData, dataType);
 159     }
 160
 161     @Override
 162     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 163         CpsValidator.validateNameCharacters(cmHandleId);
 164         return inventoryPersistence.getYangResourcesModuleReferences(cmHandleId);
 165     }
 166
 167     @Override
 168     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
 169         CpsValidator.validateNameCharacters(cmHandleId);
 170         return inventoryPersistence.getModuleDefinitionsByCmHandleId(cmHandleId);
 171     }
 172
 173     /**
 174      * Retrieve cm handles with details for the given query parameters.
 175      *
 176      * @param cmHandleQueryApiParameters cm handle query parameters
 177      * @return cm handles with details
 178      */
 179     @Override
 180     public Set<NcmpServiceCmHandle> executeCmHandleSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 181         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
 182                 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
 183
 184         validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
 185
 186         return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryServiceParameters);
 187     }
 188
 189     /**
 190      * Retrieve cm handle ids for the given query parameters.
 191      *
 192      * @param cmHandleQueryApiParameters cm handle query parameters
 193      * @return cm handle ids
 194      */
 195     @Override
 196     public Set<String> executeCmHandleIdSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
 197         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
 198                 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
 199
 200         validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
 201
 202         return networkCmProxyCmHandlerQueryService.queryCmHandleIds(cmHandleQueryServiceParameters);
 203     }
 204
 205     /**
 206      * Set the data sync enabled flag, along with the data sync state
 207      * based on the data sync enabled boolean for the cm handle id provided.
 208      *
 209      * @param cmHandleId      cm handle id
 210      * @param dataSyncEnabled data sync enabled flag
 211      */
 212     @Override
 213     public void setDataSyncEnabled(final String cmHandleId, final boolean dataSyncEnabled) {
 214         CpsValidator.validateNameCharacters(cmHandleId);
 215         final CompositeState compositeState = inventoryPersistence
 216                 .getCmHandleState(cmHandleId);
 217         if (compositeState.getDataSyncEnabled().equals(dataSyncEnabled)) {
 218             log.info("Data-Sync Enabled flag is already: {} ", dataSyncEnabled);
 219         } else if (compositeState.getCmHandleState() != CmHandleState.READY) {
 220             throw new CpsException("State mismatch exception.", "Cm-Handle not in READY state. Cm handle state is: "
 221                     + compositeState.getCmHandleState());
 222         } else {
 223             final DataStoreSyncState dataStoreSyncState = compositeState.getDataStores()
 224                     .getOperationalDataStore().getDataStoreSyncState();
 225             if (!dataSyncEnabled && dataStoreSyncState == DataStoreSyncState.SYNCHRONIZED) {
 226                 cpsDataService.deleteDataNode(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
 227                         "/netconf-state", OffsetDateTime.now());
 228             }
 229             CompositeStateUtils.setDataSyncEnabledFlagWithDataSyncState(dataSyncEnabled, compositeState);
 230             inventoryPersistence.saveCmHandleState(cmHandleId,
 231                     compositeState);
 232         }
 233     }
 234
 235     /**
 236      * Get all cm handle IDs by DMI plugin identifier.
 237      *
 238      * @param dmiPluginIdentifier DMI plugin identifier
 239      * @return set of cm handle IDs
 240      */
 241     @Override
 242     public Set<String> getAllCmHandleIdsByDmiPluginIdentifier(final String dmiPluginIdentifier) {
 243         final Set<NcmpServiceCmHandle> ncmpServiceCmHandles =
 244                 cmHandleQueries.getCmHandlesByDmiPluginIdentifier(dmiPluginIdentifier);
 245         final Set<String> cmHandleIds = new HashSet<>(ncmpServiceCmHandles.size());
 246         ncmpServiceCmHandles.forEach(cmHandle -> cmHandleIds.add(cmHandle.getCmHandleId()));
 247         return cmHandleIds;
 248     }
 249
 250     /**
 251      * Retrieve cm handle details for a given cm handle.
 252      *
 253      * @param cmHandleId cm handle identifier
 254      * @return cm handle details
 255      */
 256     @Override
 257     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 258         CpsValidator.validateNameCharacters(cmHandleId);
 259         return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(
 260                 inventoryPersistence.getYangModelCmHandle(cmHandleId));
 261     }
 262
 263     /**
 264      * Get cm handle public properties for a given cm handle id.
 265      *
 266      * @param cmHandleId cm handle identifier
 267      * @return cm handle public properties
 268      */
 269     @Override
 270     public Map<String, String> getCmHandlePublicProperties(final String cmHandleId) {
 271         CpsValidator.validateNameCharacters(cmHandleId);
 272         final YangModelCmHandle yangModelCmHandle =
 273                 inventoryPersistence.getYangModelCmHandle(cmHandleId);
 274         final List<YangModelCmHandle.Property> yangModelPublicProperties = yangModelCmHandle.getPublicProperties();
 275         final Map<String, String> cmHandlePublicProperties = new HashMap<>();
 276         YangDataConverter.asPropertiesMap(yangModelPublicProperties, cmHandlePublicProperties);
 277         return cmHandlePublicProperties;
 278     }
 279
 280     /**
 281      * Get cm handle composite state for a given cm handle id.
 282      *
 283      * @param cmHandleId cm handle identifier
 284      * @return cm handle state
 285      */
 286     @Override
 287     public CompositeState getCmHandleCompositeState(final String cmHandleId) {
 288         CpsValidator.validateNameCharacters(cmHandleId);
 289         return inventoryPersistence.getYangModelCmHandle(cmHandleId).getCompositeState();
 290     }
 291
 292     /**
 293      * THis method registers a cm handle and initiates modules sync.
 294      *
 295      * @param dmiPluginRegistration dmi plugin registration information.
 296      * @return cm-handle registration response for create cm-handle requests.
 297      */
 298     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 299             final DmiPluginRegistration dmiPluginRegistration) {
 300         List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
 301         final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle = new HashMap<>();
 302         try {
 303             dmiPluginRegistration.getCreatedCmHandles()
 304                     .forEach(cmHandle -> {
 305                         final YangModelCmHandle yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle(
 306                                 dmiPluginRegistration.getDmiPlugin(),
 307                                 dmiPluginRegistration.getDmiDataPlugin(),
 308                                 dmiPluginRegistration.getDmiModelPlugin(),
 309                                 cmHandle);
 310                         cmHandleStatePerCmHandle.put(yangModelCmHandle, CmHandleState.ADVISED);
 311                     });
 312             cmHandleRegistrationResponses = registerNewCmHandles(cmHandleStatePerCmHandle);
 313         } catch (final DataValidationException dataValidationException) {
 314             cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
 315                             .getCreatedCmHandles().stream()
 316                             .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
 317                     RegistrationError.CM_HANDLE_INVALID_ID));
 318         }
 319         return cmHandleRegistrationResponses;
 320     }
 321
 322     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 323             final List<String> tobeRemovedCmHandles) {
 324         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 325                 new ArrayList<>(tobeRemovedCmHandles.size());
 326         for (final String cmHandleId : tobeRemovedCmHandles) {
 327             try {
 328                 CpsValidator.validateNameCharacters(cmHandleId);
 329                 final YangModelCmHandle yangModelCmHandle = inventoryPersistence.getYangModelCmHandle(cmHandleId);
 330                 lcmEventsCmHandleStateHandler.updateCmHandleState(yangModelCmHandle,
 331                         CmHandleState.DELETING);
 332                 deleteCmHandleByCmHandleId(cmHandleId);
 333                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandleId));
 334                 lcmEventsCmHandleStateHandler.updateCmHandleState(yangModelCmHandle,
 335                         CmHandleState.DELETED);
 336             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 337                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 338                         cmHandleId, dataNodeNotFoundException.getMessage());
 339                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 340                         .createFailureResponse(cmHandleId, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 341             } catch (final DataValidationException dataValidationException) {
 342                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 343                         cmHandleId, dataValidationException.getMessage());
 344                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 345                         .createFailureResponse(cmHandleId, RegistrationError.CM_HANDLE_INVALID_ID));
 346             } catch (final Exception exception) {
 347                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 348                         cmHandleId, exception.getMessage());
 349                 cmHandleRegistrationResponses.add(
 350                         CmHandleRegistrationResponse.createFailureResponse(cmHandleId, exception));
 351             }
 352         }
 353         return cmHandleRegistrationResponses;
 354     }
 355
 356     private void deleteCmHandleByCmHandleId(final String cmHandleId) {
 357         inventoryPersistence.deleteSchemaSetWithCascade(cmHandleId);
 358         inventoryPersistence.deleteListOrListElement("/dmi-registry/cm-handles[@id='" + cmHandleId + "']");
 359     }
 360
 361     private List<CmHandleRegistrationResponse> registerNewCmHandles(final Map<YangModelCmHandle, CmHandleState>
 362                                                                             cmHandleStatePerCmHandle) {
 363         final List<String> cmHandleIds = cmHandleStatePerCmHandle.keySet().stream().map(YangModelCmHandle::getId)
 364                 .collect(Collectors.toList());
 365         try {
 366             lcmEventsCmHandleStateHandler.updateCmHandleStateBatch(cmHandleStatePerCmHandle);
 367             return CmHandleRegistrationResponse.createSuccessResponses(cmHandleIds);
 368         } catch (final AlreadyDefinedExceptionBatch alreadyDefinedExceptionBatch) {
 369             return CmHandleRegistrationResponse.createFailureResponses(
 370                     alreadyDefinedExceptionBatch.getAlreadyDefinedXpaths(),
 371                     RegistrationError.CM_HANDLE_ALREADY_EXIST);
 372         } catch (final Exception exception) {
 373             return CmHandleRegistrationResponse.createFailureResponses(cmHandleIds, exception);
 374         }
 375     }
 376 }