aboutsummaryrefslogtreecommitdiffstats
path: root/rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/api/CbsRequests.java
blob: 99ad3b20cb9ac4959c68600d30853464be984f28 (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
/*
 * ============LICENSE_START====================================
 * DCAEGEN2-SERVICES-SDK
 * =========================================================
 * Copyright (C) 2019 Nokia. 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.
 * ============LICENSE_END=====================================
 */

package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api;

import org.jetbrains.annotations.NotNull;
import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest;
import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableCbsRequest;
import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;

/**
 * A factory to various of requests supported by Config Binding Service.
 *
 * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
 * @since 1.1.4
 */
public final class CbsRequests {

    /**
     * <p>A get-configuration request.</p>
     *
     * <p>Will bind the configuration for given service and return the bound configuration.</p>
     *
     * @param diagnosticContext logging diagnostic context (MDC)
     * @return the CbsRequest ready to be used when calling {@link CbsClient}
     */
    public static @NotNull CbsRequest getConfiguration(RequestDiagnosticContext diagnosticContext) {
        return ImmutableCbsRequest.builder()
                .diagnosticContext(diagnosticContext)
                .requestPath(serviceName -> "/service_component/" + serviceName)
                .build();
    }

    /**
     * <p>A get-by-key request.</p>
     *
     * <p>This will call an endpoint that fetches a generic service_component_name:key out of Consul</p>
     *
     * @param diagnosticContext logging diagnostic context (MDC)
     * @return the CbsRequest ready to be used when calling {@link CbsClient}
     */
    public static @NotNull CbsRequest getByKey(
            RequestDiagnosticContext diagnosticContext,
            String key) {
        return ImmutableCbsRequest.builder()
                .diagnosticContext(diagnosticContext)
                .requestPath(serviceName -> "/" + key + "/" + serviceName)
                .build();
    }

    /**
     * <p>A get-all request.</p>
     *
     * <p>Will bind the configuration for given service and return the bound configuration, policies, and any other
     * keys that are in Consul</p>
     *
     * @param diagnosticContext logging diagnostic context (MDC)
     * @return the CbsRequest ready to be used when calling {@link CbsClient}
     */
    public static @NotNull CbsRequest getAll(RequestDiagnosticContext diagnosticContext) {
        return ImmutableCbsRequest.builder()
                .diagnosticContext(diagnosticContext)
                .requestPath(serviceName -> "/service_component_all/" + serviceName)
                .build();
    }

}