2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 Bell Canada
4 * Modifications Copyright (C) 2022 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 java.util.List;
26 import java.util.stream.Collectors;
27 import javax.validation.Valid;
28 import lombok.RequiredArgsConstructor;
29 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
30 import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
31 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
32 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.Status;
33 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
34 import org.onap.cps.ncmp.rest.api.NetworkCmProxyInventoryApi;
35 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
36 import org.onap.cps.ncmp.rest.model.CmHandlerRegistrationErrorResponse;
37 import org.onap.cps.ncmp.rest.model.DmiPluginRegistrationErrorResponse;
38 import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
39 import org.springframework.http.HttpStatus;
40 import org.springframework.http.ResponseEntity;
41 import org.springframework.web.bind.annotation.RequestMapping;
42 import org.springframework.web.bind.annotation.RestController;
45 @RequestMapping("${rest.api.ncmp-inventory-base-path}")
46 @RequiredArgsConstructor
47 public class NetworkCmProxyInventoryController implements NetworkCmProxyInventoryApi {
49 private final NetworkCmProxyDataService networkCmProxyDataService;
50 private final NcmpRestInputMapper ncmpRestInputMapper;
53 public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters) {
54 final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
55 .toCmHandleQueryServiceParameters(cmHandleQueryParameters);
57 final Set<String> cmHandleIds = networkCmProxyDataService
58 .executeCmHandleIdSearchForInventory(cmHandleQueryServiceParameters);
59 return ResponseEntity.ok(List.copyOf(cmHandleIds));
63 * Get all cm-handle IDs under a registered DMI plugin.
65 * @param dmiPluginIdentifier DMI plugin identifier
66 * @return list of cm handle IDs
69 public ResponseEntity<List<String>> getAllCmHandleIdsForRegisteredDmi(final String dmiPluginIdentifier) {
70 final Set<String> cmHandleIds =
71 networkCmProxyDataService.getAllCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifier);
72 return ResponseEntity.ok(List.copyOf(cmHandleIds));
76 * Update DMI Plugin Registration (used for first registration also).
78 * @param restDmiPluginRegistration the registration data
81 public ResponseEntity updateDmiPluginRegistration(
82 final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
83 final DmiPluginRegistrationResponse dmiPluginRegistrationResponse =
84 networkCmProxyDataService.updateDmiRegistrationAndSyncModule(
85 ncmpRestInputMapper.toDmiPluginRegistration(restDmiPluginRegistration));
86 final DmiPluginRegistrationErrorResponse failedRegistrationErrorResponse =
87 getFailureRegistrationResponse(dmiPluginRegistrationResponse);
88 return allRegistrationsSuccessful(failedRegistrationErrorResponse)
89 ? new ResponseEntity<>(HttpStatus.OK)
90 : new ResponseEntity<>(failedRegistrationErrorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
93 private boolean allRegistrationsSuccessful(
94 final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
95 return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
96 && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
97 && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty();
100 private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
101 final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
102 final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
103 new DmiPluginRegistrationErrorResponse();
104 dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
105 getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
106 dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
107 getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
108 dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
109 getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
111 return dmiPluginRegistrationErrorResponse;
114 private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
115 final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
116 return cmHandleRegistrationResponseList.stream()
117 .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
118 .map(this::toCmHandleRegistrationErrorResponse)
119 .collect(Collectors.toList());
122 private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
123 final CmHandleRegistrationResponse registrationResponse) {
124 return new CmHandlerRegistrationErrorResponse()
125 .cmHandle(registrationResponse.getCmHandle())
126 .errorCode(registrationResponse.getRegistrationError().errorCode)
127 .errorText(registrationResponse.getErrorText());