gerrit.onap Code Review - cps.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Bell Canada
   4  *  Modifications Copyright (C) 2022-2024 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     /**
  55      * Get all cm handle references under a registered DMI plugin.
  56      *
  57      * @param cmHandleQueryParameters DMI plugin identifier
  58      * @param outputAlternateId       Boolean for cm handle reference type either
  59      *                                cm handle id (False) or alternate id (True)
  60      * @return                        list of cm handle IDs
  61      */
  62     @Override
  63     public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters,
  64                                                           final Boolean outputAlternateId) {
  65         final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
  66                 .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
  67
  68         final Collection<String> cmHandleIds = networkCmProxyInventoryFacade
  69                 .executeParameterizedCmHandleIdSearch(cmHandleQueryServiceParameters, outputAlternateId);
  70         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  71     }
  72
  73     /**
  74      * Get all cm-handle IDs under a registered DMI plugin.
  75      *
  76      * @param dmiPluginIdentifier DMI plugin identifier
  77      * @param outputAlternateId   Boolean for cm handle reference type either
  78      *                            cm handle id (False) or alternate id (True)
  79      * @return list of cm handle IDs
  80      */
  81     @Override
  82     public ResponseEntity<List<String>> getAllCmHandleReferencesForRegisteredDmi(final String dmiPluginIdentifier,
  83                                                                                  final Boolean outputAlternateId) {
  84
  85         final Collection<String> cmHandleIds =
  86             networkCmProxyInventoryFacade.getAllCmHandleReferencesByDmiPluginIdentifier(dmiPluginIdentifier,
  87                 outputAlternateId);
  88         return ResponseEntity.ok(List.copyOf(cmHandleIds));
  89     }
  90
  91     /**
  92      * Update DMI Plugin Registration (used for first registration also).
  93      *
  94      * @param restDmiPluginRegistration the registration data
  95      */
  96     @Override
  97     @Timed(value = "cps.ncmp.inventory.controller.update",
  98         description = "Time taken to handle registration request")
  99     public ResponseEntity updateDmiPluginRegistration(
 100         final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
 101         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse =
 102             networkCmProxyInventoryFacade.updateDmiRegistration(
 103                 ncmpRestInputMapper.toDmiPluginRegistration(restDmiPluginRegistration));
 104         final DmiPluginRegistrationErrorResponse failedRegistrationErrorResponse =
 105             getFailureRegistrationResponse(dmiPluginRegistrationResponse);
 106         return allRegistrationsSuccessful(failedRegistrationErrorResponse)
 107             ? new ResponseEntity<>(HttpStatus.OK)
 108             : new ResponseEntity<>(failedRegistrationErrorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
 109     }
 110
 111     private boolean allRegistrationsSuccessful(
 112         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
 113         return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
 114                 && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
 115                 && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty()
 116                 && dmiPluginRegistrationErrorResponse.getFailedUpgradeCmHandles().isEmpty();
 117     }
 118
 119     private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
 120         final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
 121         final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
 122             new DmiPluginRegistrationErrorResponse();
 123         dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
 124             getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
 125         dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
 126             getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
 127         dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
 128             getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
 129         dmiPluginRegistrationErrorResponse.setFailedUpgradeCmHandles(
 130                 getFailedResponses(dmiPluginRegistrationResponse.getUpgradedCmHandles()));
 131         return dmiPluginRegistrationErrorResponse;
 132     }
 133
 134     private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
 135             final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
 136         return cmHandleRegistrationResponseList.stream()
 137                 .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
 138                 .map(this::toCmHandleRegistrationErrorResponse).collect(Collectors.toList());
 139     }
 140
 141     private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
 142         final CmHandleRegistrationResponse registrationResponse) {
 143         return new CmHandlerRegistrationErrorResponse()
 144             .cmHandle(registrationResponse.getCmHandle())
 145             .errorCode(registrationResponse.getNcmpResponseStatus().getCode())
 146             .errorText(registrationResponse.getErrorText());
 147     }
 148
 149 }