gerrit.onap Code Review - cps.git/blob

   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.inventory.NetworkCmProxyInventoryFacade;
  31 import org.onap.cps.ncmp.api.inventory.models.CmHandleQueryServiceParameters;
  32 import org.onap.cps.ncmp.api.inventory.models.CmHandleRegistrationResponse;
  33 import org.onap.cps.ncmp.api.inventory.models.CmHandleRegistrationResponse.Status;
  34 import org.onap.cps.ncmp.api.inventory.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.onap.cps.ncmp.rest.util.NcmpRestInputMapper;
  41 import org.springframework.http.HttpStatus;
  42 import org.springframework.http.ResponseEntity;
  43 import org.springframework.web.bind.annotation.RequestMapping;
  44 import org.springframework.web.bind.annotation.RestController;
  45
  46 @RestController
  47 @RequestMapping("${rest.api.ncmp-inventory-base-path}")
  48 @RequiredArgsConstructor
  49 public class NetworkCmProxyInventoryController implements NetworkCmProxyInventoryApi {
  50
  51     private final NetworkCmProxyInventoryFacade networkCmProxyInventoryFacade;
  52     private final NcmpRestInputMapper ncmpRestInputMapper;
  53
  54     @Override
  55     public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters) {
  56         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
  57                 .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
  58
  59         final Collection<String> cmHandleIds = networkCmProxyInventoryFacade
  60                 .executeParameterizedCmHandleIdSearch(cmHandleQueryServiceParameters);
  61         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  62     }
  63
  64     /**
  65      * Get all cm-handle IDs under a registered DMI plugin.
  66      *
  67      * @param dmiPluginIdentifier DMI plugin identifier
  68      * @return list of cm handle IDs
  69      */
  70     @Override
  71     public ResponseEntity<List<String>> getAllCmHandleIdsForRegisteredDmi(final String dmiPluginIdentifier) {
  72         final Collection<String> cmHandleIds =
  73             networkCmProxyInventoryFacade.getAllCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifier);
  74         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  75     }
  76
  77     /**
  78      * Update DMI Plugin Registration (used for first registration also).
  79      *
  80      * @param restDmiPluginRegistration the registration data
  81      */
  82     @Override
  83     @Timed(value = "cps.ncmp.inventory.controller.update",
  84         description = "Time taken to handle registration request")
  85     public ResponseEntity updateDmiPluginRegistration(
  86         final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
  87         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse =
  88             networkCmProxyInventoryFacade.updateDmiRegistrationAndSyncModule(
  89                 ncmpRestInputMapper.toDmiPluginRegistration(restDmiPluginRegistration));
  90         final DmiPluginRegistrationErrorResponse failedRegistrationErrorResponse =
  91             getFailureRegistrationResponse(dmiPluginRegistrationResponse);
  92         return allRegistrationsSuccessful(failedRegistrationErrorResponse)
  93             ? new ResponseEntity<>(HttpStatus.OK)
  94             : new ResponseEntity<>(failedRegistrationErrorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
  95     }
  96
  97     private boolean allRegistrationsSuccessful(
  98         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
  99         return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
 100                 && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
 101                 && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty()
 102                 && dmiPluginRegistrationErrorResponse.getFailedUpgradeCmHandles().isEmpty();
 103     }
 104
 105     private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
 106         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
 107         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
 108             new DmiPluginRegistrationErrorResponse();
 109         dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
 110             getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
 111         dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
 112             getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
 113         dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
 114             getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
 115         dmiPluginRegistrationErrorResponse.setFailedUpgradeCmHandles(
 116                 getFailedResponses(dmiPluginRegistrationResponse.getUpgradedCmHandles()));
 117         return dmiPluginRegistrationErrorResponse;
 118     }
 119
 120     private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
 121             final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
 122         return cmHandleRegistrationResponseList.stream()
 123                 .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
 124                 .map(this::toCmHandleRegistrationErrorResponse).collect(Collectors.toList());
 125     }
 126
 127     private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
 128         final CmHandleRegistrationResponse registrationResponse) {
 129         return new CmHandlerRegistrationErrorResponse()
 130             .cmHandle(registrationResponse.getCmHandle())
 131             .errorCode(registrationResponse.getNcmpResponseStatus().getCode())
 132             .errorText(registrationResponse.getErrorText());
 133     }
 134
 135 }