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