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