aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NcmpDatastoreRequestHandler.java
blob: 302ba449c77a41c323458bcc7c93953efd213599 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2022-2024 Nordix Foundation
 *  ================================================================================
 *  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.api.impl;

import java.util.Map;
import java.util.UUID;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.ncmp.api.models.CmResourceAddress;
import org.onap.cps.ncmp.utils.TopicValidator;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import reactor.core.publisher.Mono;

@Slf4j
@Service
public abstract class NcmpDatastoreRequestHandler {

    private static final String NO_REQUEST_ID = null;
    private static final String NO_TOPIC = null;

    @Value("${notification.async.executor.time-out-value-in-ms:60000}")
    protected int timeOutInMilliSeconds;
    @Value("${notification.enabled:true}")
    protected boolean notificationFeatureEnabled;

    /**
     * Executes synchronous/asynchronous get request for given cm handle.
     *
     * @param cmResourceAddress   the name of the datastore, cm handle and resource identifier
     * @param options             options to pass through to dmi client
     * @param topic               topic (optional) for asynchronous responses
     * @param includeDescendants  whether include descendants
     * @param authorization       contents of Authorization header, or null if not present
     * @return the result object, depends on use op topic. With topic a map object with request id is returned
     *         otherwise the result of the request.
     */
    public Object executeRequest(final CmResourceAddress cmResourceAddress,
                                 final String options,
                                 final String topic,
                                 final boolean includeDescendants,
                                 final String authorization) {

        final boolean asyncResponseRequested = topic != null;
        if (asyncResponseRequested && notificationFeatureEnabled) {
            return getResourceDataAsynchronously(cmResourceAddress, options, topic, includeDescendants, authorization);
        }

        if (asyncResponseRequested) {
            log.warn("Asynchronous request is unavailable as notification feature is currently disabled, "
                    + "will use synchronous operation.");
        }
        final Mono<Object> resourceDataMono = getResourceDataForCmHandle(cmResourceAddress, options,
                NO_TOPIC, NO_REQUEST_ID, includeDescendants, authorization);
        return resourceDataMono.block();
    }

    private Map<String, String> getResourceDataAsynchronously(final CmResourceAddress cmResourceAddress,
                                                              final String options,
                                                              final String topic,
                                                              final boolean includeDescendants,
                                                              final String authorization) {
        TopicValidator.validateTopicName(topic);
        final String requestId = UUID.randomUUID().toString();
        getResourceDataForCmHandle(cmResourceAddress, options, topic, requestId, includeDescendants, authorization)
                .doOnSuccess(result ->
                    log.debug("Async operation succeeded for request id {}: {}", requestId, result))
                .subscribe();
        log.debug("Received Async request with id {}", requestId);
        return Map.of("requestId", requestId);
    }

    protected abstract Mono<Object> getResourceDataForCmHandle(final CmResourceAddress cmResourceAddress,
                                                               final String optionsParamInQuery,
                                                               final String topicParamInQuery,
                                                               final String requestId,
                                                               final boolean includeDescendant,
                                                               final String authorization);
}