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