[cps.git] /

/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2021-2022 Bell Canada
 *  Modifications Copyright (C) 2022-2025 OpenInfra Foundation Europe. All rights reserved.
 *  ================================================================================
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.cps.ncmp.rest.controller;

import io.micrometer.core.annotation.Timed;
import jakarta.validation.Valid;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
import lombok.RequiredArgsConstructor;
import org.onap.cps.ncmp.api.inventory.NetworkCmProxyInventoryFacade;
import org.onap.cps.ncmp.api.inventory.models.CmHandleQueryApiParameters;
import org.onap.cps.ncmp.api.inventory.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.inventory.models.CmHandleRegistrationResponse;
import org.onap.cps.ncmp.api.inventory.models.CmHandleRegistrationResponse.Status;
import org.onap.cps.ncmp.api.inventory.models.DmiPluginRegistrationResponse;
import org.onap.cps.ncmp.rest.api.NetworkCmProxyInventoryApi;
import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
import org.onap.cps.ncmp.rest.model.CmHandlerRegistrationErrorResponse;
import org.onap.cps.ncmp.rest.model.DmiPluginRegistrationErrorResponse;
import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
import org.onap.cps.ncmp.rest.util.CountCmHandleSearchExecution;
import org.onap.cps.ncmp.rest.util.DeprecationHelper;
import org.onap.cps.ncmp.rest.util.NcmpRestInputMapper;
import org.onap.cps.ncmp.rest.util.RestOutputCmHandleMapper;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("${rest.api.ncmp-inventory-base-path}")
@RequiredArgsConstructor
public class NetworkCmProxyInventoryController implements NetworkCmProxyInventoryApi {

    private final NetworkCmProxyInventoryFacade networkCmProxyInventoryFacade;
    private final NcmpRestInputMapper ncmpRestInputMapper;
    private final DeprecationHelper deprecationHelper;
    private final RestOutputCmHandleMapper restOutputCmHandleMapper;

    /**
     * Get all cm handle references under a registered DMI plugin.
     *
     * @param cmHandleQueryParameters DMI plugin identifier
     * @param outputAlternateId       Boolean for cm handle reference type either
     *                                cm handle id (False) or alternate id (True)
     * @return                        list of cm handle IDs
     */
    @Override
    @CountCmHandleSearchExecution(methodName = "searchCmHandleIds", interfaceName = "CPS-NCMP-I-01",
        description = "Search for cm handle ids within CPS-NCMP-I-01 interface")
    public ResponseEntity<List<String>> searchCmHandleIds(final CmHandleQueryParameters cmHandleQueryParameters,
                                                          final Boolean outputAlternateId) {
        final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = ncmpRestInputMapper
                .toCmHandleQueryServiceParameters(cmHandleQueryParameters);

        final Collection<String> cmHandleIds = networkCmProxyInventoryFacade
                .southboundCmHandleIdSearch(cmHandleQueryServiceParameters, outputAlternateId);
        return ResponseEntity.ok(List.copyOf(cmHandleIds));
    }

    /**
     * Execute cm handle query search and return a list of cm handle details. Any number of conditions can be applied.
     *
     * @param cmHandleQueryParameters the cm handle query parameters
     * @param outputDmiProperties boolean value to determine the inclusion of additional properties
     * @return collection of cm handles
     */
    @Override
    @SuppressWarnings("deprecation") // mapOldConditionProperties method will be removed in Release 17
    public ResponseEntity<List<RestOutputCmHandle>> searchCmHandles(
            final CmHandleQueryParameters cmHandleQueryParameters,
            final Boolean outputDmiProperties) {
        final CmHandleQueryApiParameters cmHandleQueryApiParameters =
                deprecationHelper.mapOldConditionProperties(cmHandleQueryParameters);
        final boolean outputDmiPropertiesAsPrimitive = Boolean.TRUE.equals(outputDmiProperties);
        final List<RestOutputCmHandle> restOutputCmHandles =
                networkCmProxyInventoryFacade.southboundCmHandleSearch(cmHandleQueryApiParameters)
                        .map(handle -> restOutputCmHandleMapper
                                .toRestOutputCmHandle(handle, outputDmiPropertiesAsPrimitive))
                        .collectList().block();
        return ResponseEntity.ok(restOutputCmHandles);
    }

    /**
     * Get all cm-handle IDs under a registered DMI plugin.
     *
     * @param dmiPluginIdentifier DMI plugin identifier
     * @param outputAlternateId   Boolean for cm handle reference type either
     *                            cm handle id (False) or alternate id (True)
     * @return list of cm handle IDs
     */
    @Override
    public ResponseEntity<List<String>> getAllCmHandleReferencesForRegisteredDmi(final String dmiPluginIdentifier,
                                                                                 final Boolean outputAlternateId) {

        final Collection<String> cmHandleIds =
            networkCmProxyInventoryFacade.getAllCmHandleReferencesByDmiPluginIdentifier(dmiPluginIdentifier,
                outputAlternateId);
        return ResponseEntity.ok(List.copyOf(cmHandleIds));
    }

    /**
     * Update DMI Plugin Registration (used for first registration also).
     *
     * @param restDmiPluginRegistration the registration data
     */
    @Override
    @Timed(value = "cps.ncmp.inventory.controller.update",
        description = "Time taken to handle registration request")
    public ResponseEntity updateDmiPluginRegistration(
        final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
        final DmiPluginRegistrationResponse dmiPluginRegistrationResponse =
            networkCmProxyInventoryFacade.updateDmiRegistration(
                ncmpRestInputMapper.toDmiPluginRegistration(restDmiPluginRegistration));
        final DmiPluginRegistrationErrorResponse failedRegistrationErrorResponse =
            getFailureRegistrationResponse(dmiPluginRegistrationResponse);
        return allRegistrationsSuccessful(failedRegistrationErrorResponse)
            ? new ResponseEntity<>(HttpStatus.OK)
            : new ResponseEntity<>(failedRegistrationErrorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    private boolean allRegistrationsSuccessful(
        final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse) {
        return dmiPluginRegistrationErrorResponse.getFailedCreatedCmHandles().isEmpty()
                && dmiPluginRegistrationErrorResponse.getFailedUpdatedCmHandles().isEmpty()
                && dmiPluginRegistrationErrorResponse.getFailedRemovedCmHandles().isEmpty()
                && dmiPluginRegistrationErrorResponse.getFailedUpgradeCmHandles().isEmpty();
    }

    private DmiPluginRegistrationErrorResponse getFailureRegistrationResponse(
        final DmiPluginRegistrationResponse dmiPluginRegistrationResponse) {
        final DmiPluginRegistrationErrorResponse dmiPluginRegistrationErrorResponse =
            new DmiPluginRegistrationErrorResponse();
        dmiPluginRegistrationErrorResponse.setFailedCreatedCmHandles(
            getFailedResponses(dmiPluginRegistrationResponse.getCreatedCmHandles()));
        dmiPluginRegistrationErrorResponse.setFailedUpdatedCmHandles(
            getFailedResponses(dmiPluginRegistrationResponse.getUpdatedCmHandles()));
        dmiPluginRegistrationErrorResponse.setFailedRemovedCmHandles(
            getFailedResponses(dmiPluginRegistrationResponse.getRemovedCmHandles()));
        dmiPluginRegistrationErrorResponse.setFailedUpgradeCmHandles(
                getFailedResponses(dmiPluginRegistrationResponse.getUpgradedCmHandles()));
        return dmiPluginRegistrationErrorResponse;
    }

    private List<CmHandlerRegistrationErrorResponse> getFailedResponses(
            final List<CmHandleRegistrationResponse> cmHandleRegistrationResponseList) {
        return cmHandleRegistrationResponseList.stream()
                .filter(cmHandleRegistrationResponse -> cmHandleRegistrationResponse.getStatus() == Status.FAILURE)
                .map(this::toCmHandleRegistrationErrorResponse).collect(Collectors.toList());
    }

    private CmHandlerRegistrationErrorResponse toCmHandleRegistrationErrorResponse(
        final CmHandleRegistrationResponse registrationResponse) {
        return new CmHandlerRegistrationErrorResponse()
            .cmHandle(registrationResponse.getCmHandle())
            .errorCode(registrationResponse.getNcmpResponseStatus().getCode())
            .errorText(registrationResponse.getErrorText());
    }

}