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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.rest.controller;
24 import io.micrometer.core.annotation.Timed;
25 import java.util.List;
27 import java.util.stream.Collectors;
28 import javax.validation.Valid;
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;
46 @RequestMapping("${rest.api.ncmp-inventory-base-path}")
47 @RequiredArgsConstructor
48 public class NetworkCmProxyInventoryController implements NetworkCmProxyInventoryApi {
50 private final NetworkCmProxyDataService networkCmProxyDataService;
51 private final NcmpRestInputMapper ncmpRestInputMapper;
54 public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters) {
55 final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
56 .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
58 final Set<String> cmHandleIds = networkCmProxyDataService
59 .executeCmHandleIdSearchForInventory(cmHandleQueryServiceParameters);
60 return ResponseEntity.ok(List.copyOf(cmHandleIds));
64 * Get all cm-handle IDs under a registered DMI plugin.
66 * @param dmiPluginIdentifier DMI plugin identifier
67 * @return list of cm handle IDs
70 public ResponseEntity<List<String>> getAllCmHandleIdsForRegisteredDmi(final String dmiPluginIdentifier) {
71 final Set<String> cmHandleIds =
72 networkCmProxyDataService.getAllCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifier);
73 return ResponseEntity.ok(List.copyOf(cmHandleIds));
77 * Update DMI Plugin Registration (used for first registration also).
79 * @param restDmiPluginRegistration the registration data
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);
96 private boolean allRegistrationsSuccessful(
97 final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
98 return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
99 && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
100 && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty();
103 private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
104 final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
105 final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
106 new DmiPluginRegistrationErrorResponse();
107 dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
108 getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
109 dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
110 getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
111 dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
112 getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
114 return dmiPluginRegistrationErrorResponse;
117 private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
118 final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
119 return cmHandleRegistrationResponseList.stream()
120 .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
121 .map(this::toCmHandleRegistrationErrorResponse)
122 .collect(Collectors.toList());
125 private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
126 final CmHandleRegistrationResponse registrationResponse) {
127 return new CmHandlerRegistrationErrorResponse()
128 .cmHandle(registrationResponse.getCmHandle())
129 .errorCode(registrationResponse.getRegistrationError().errorCode)
130 .errorText(registrationResponse.getErrorText());