cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyInventoryController.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Bell Canada
   4  *  Modifications Copyright (C) 2022-2023 Nordix Foundation
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.rest.controller;
  23
  24 import io.micrometer.core.annotation.Timed;
  25 import jakarta.validation.Valid;
  26 import java.util.Collection;
  27 import java.util.List;
  28 import java.util.stream.Collectors;
  29 import lombok.RequiredArgsConstructor;
  30 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  31 import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
  32 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
  33 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.Status;
  34 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
  35 import org.onap.cps.ncmp.rest.api.NetworkCmProxyInventoryApi;
  36 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
  37 import org.onap.cps.ncmp.rest.model.CmHandlerRegistrationErrorResponse;
  38 import org.onap.cps.ncmp.rest.model.DmiPluginRegistrationErrorResponse;
  39 import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
  40 import org.springframework.http.HttpStatus;
  41 import org.springframework.http.ResponseEntity;
  42 import org.springframework.web.bind.annotation.RequestMapping;
  43 import org.springframework.web.bind.annotation.RestController;
  44
  45 @RestController
  46 @RequestMapping("${rest.api.ncmp-inventory-base-path}")
  47 @RequiredArgsConstructor
  48 public class NetworkCmProxyInventoryController implements NetworkCmProxyInventoryApi {
  49
  50     private final NetworkCmProxyDataService networkCmProxyDataService;
  51     private final NcmpRestInputMapper ncmpRestInputMapper;
  52
  53     @Override
  54     public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters) {
  55         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
  56                 .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
  57
  58         final Collection<String> cmHandleIds = networkCmProxyDataService
  59                 .executeCmHandleIdSearchForInventory(cmHandleQueryServiceParameters);
  60         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  61     }
  62
  63     /**
  64      * Get all cm-handle IDs under a registered DMI plugin.
  65      *
  66      * @param dmiPluginIdentifier DMI plugin identifier
  67      * @return list of cm handle IDs
  68      */
  69     @Override
  70     public ResponseEntity<List<String>> getAllCmHandleIdsForRegisteredDmi(final String dmiPluginIdentifier) {
  71         final Collection<String> cmHandleIds =
  72                 networkCmProxyDataService.getAllCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifier);
  73         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  74     }
  75
  76     /**
  77      * Update DMI Plugin Registration (used for first registration also).
  78      *
  79      * @param restDmiPluginRegistration the registration data
  80      */
  81     @Override
  82     @Timed(value = "cps.ncmp.inventory.controller.update",
  83         description = "Time taken to handle registration request")
  84     public ResponseEntity updateDmiPluginRegistration(
  85         final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
  86         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse =
  87             networkCmProxyDataService.updateDmiRegistrationAndSyncModule(
  88                 ncmpRestInputMapper.toDmiPluginRegistration(restDmiPluginRegistration));
  89         final DmiPluginRegistrationErrorResponse failedRegistrationErrorResponse =
  90             getFailureRegistrationResponse(dmiPluginRegistrationResponse);
  91         return allRegistrationsSuccessful(failedRegistrationErrorResponse)
  92             ? new ResponseEntity<>(HttpStatus.OK)
  93             : new ResponseEntity<>(failedRegistrationErrorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
  94     }
  95
  96     private boolean allRegistrationsSuccessful(
  97         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
  98         return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
  99                 && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
 100                 && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty()
 101                 && dmiPluginRegistrationErrorResponse.getFailedUpgradeCmHandles().isEmpty();
 102     }
 103
 104     private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
 105         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
 106         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
 107             new DmiPluginRegistrationErrorResponse();
 108         dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
 109             getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
 110         dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
 111             getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
 112         dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
 113             getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
 114         dmiPluginRegistrationErrorResponse.setFailedUpgradeCmHandles(
 115                 getFailedResponses(dmiPluginRegistrationResponse.getUpgradedCmHandles()));
 116         return dmiPluginRegistrationErrorResponse;
 117     }
 118
 119     private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
 120             final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
 121         return cmHandleRegistrationResponseList.stream()
 122                 .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
 123                 .map(this::toCmHandleRegistrationErrorResponse).collect(Collectors.toList());
 124     }
 125
 126     private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
 127         final CmHandleRegistrationResponse registrationResponse) {
 128         return new CmHandlerRegistrationErrorResponse()
 129             .cmHandle(registrationResponse.getCmHandle())
 130             .errorCode(registrationResponse.getNcmpResponseStatus().getCode())
 131             .errorText(registrationResponse.getErrorText());
 132     }
 133
 134 }