2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ========================LICENSE_END===================================
21 package org.oransc.policyagent.clients;
23 import java.lang.invoke.MethodHandles;
24 import java.util.ArrayList;
25 import java.util.List;
26 import java.util.Optional;
28 import org.immutables.gson.Gson;
29 import org.immutables.value.Value;
30 import org.oransc.policyagent.configuration.RicConfig;
31 import org.oransc.policyagent.repository.Policy;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
35 import reactor.core.publisher.Flux;
36 import reactor.core.publisher.Mono;
39 * Client for accessing the A1 adapter in the SDNC controller in ONAP
41 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
42 public class SdncOnapA1Client implements A1Client {
45 interface SdncOnapAdapterInput {
46 public String nearRtRicId();
48 public Optional<String> policyTypeId();
50 public Optional<String> policyInstanceId();
52 public Optional<String> policyInstance();
54 public Optional<List<String>> properties();
57 private static final String URL_PREFIX = "/A1-ADAPTER-API:";
59 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
61 private final String a1ControllerUsername;
62 private final String a1ControllerPassword;
63 private final RicConfig ricConfig;
64 private final AsyncRestClient restClient;
66 public SdncOnapA1Client(RicConfig ricConfig, String baseUrl, String username, String password) {
67 this(ricConfig, username, password, new AsyncRestClient(baseUrl + "/restconf/operations"));
68 logger.debug("SdncOnapA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
71 public SdncOnapA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) {
72 this.ricConfig = ricConfig;
73 this.a1ControllerUsername = username;
74 this.a1ControllerPassword = password;
75 this.restClient = restClient;
79 public Mono<List<String>> getPolicyTypeIdentities() {
80 return getPolicyTypeIds() //
85 public Mono<List<String>> getPolicyIdentities() {
86 return getPolicyTypeIds() //
87 .flatMap(this::getPolicyIdentitiesByType) //
92 public Mono<String> getPolicyTypeSchema(String policyTypeId) {
93 SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
94 .nearRtRicId(ricConfig.baseUrl()) //
95 .policyTypeId(policyTypeId) //
97 String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
98 logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
101 .postWithAuthHeader(URL_PREFIX + "getPolicyType", inputJsonString, a1ControllerUsername,
102 a1ControllerPassword) //
103 .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-type")) //
104 .flatMap(SdncJsonHelper::extractPolicySchema);
108 public Mono<String> putPolicy(Policy policy) {
109 SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
110 .nearRtRicId(ricConfig.baseUrl()) //
111 .policyTypeId(policy.type().name()) //
112 .policyInstanceId(policy.id()) //
113 .policyInstance(policy.json()) //
114 .properties(new ArrayList<String>()) //
117 String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
118 logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
120 return restClient.postWithAuthHeader(URL_PREFIX + "createPolicyInstance", inputJsonString, a1ControllerUsername,
121 a1ControllerPassword);
125 public Mono<String> deletePolicy(Policy policy) {
126 return deletePolicyByTypeId(policy.type().name(), policy.id());
130 public Flux<String> deleteAllPolicies() {
131 return getPolicyTypeIds() //
132 .flatMap(this::deletePoliciesForType); //
136 public Mono<A1ProtocolType> getProtocolVersion() {
137 return getPolicyTypeIdentities() //
138 .flatMap(notUsed -> Mono.just(A1ProtocolType.SDNC_ONAP));
142 public Mono<String> getPolicyStatus(Policy policy) {
143 return Mono.error(new Exception("Status not implemented in the controller"));
146 private Flux<String> getPolicyTypeIds() {
147 SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
148 .nearRtRicId(ricConfig.baseUrl()) //
150 String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
151 logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
154 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyTypes", inputJsonString, a1ControllerUsername,
155 a1ControllerPassword) //
156 .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-type-id-list")) //
157 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
160 private Flux<String> getPolicyIdentitiesByType(String policyTypeId) {
161 SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
162 .nearRtRicId(ricConfig.baseUrl()) //
163 .policyTypeId(policyTypeId) //
165 String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
166 logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
169 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyInstances", inputJsonString, a1ControllerUsername,
170 a1ControllerPassword) //
171 .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-instance-id-list")) //
172 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
175 private Flux<String> deletePoliciesForType(String typeId) {
176 return getPolicyIdentitiesByType(typeId) //
177 .flatMap(policyId -> deletePolicyByTypeId(typeId, policyId)); //
180 private Mono<String> deletePolicyByTypeId(String policyTypeId, String policyId) {
181 SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
182 .nearRtRicId(ricConfig.baseUrl()) //
183 .policyTypeId(policyTypeId) //
184 .policyInstanceId(policyId) //
186 String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
187 logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
189 return restClient.postWithAuthHeader("/A1-ADAPTER-API:deletePolicyInstance", inputJsonString,
190 a1ControllerUsername, a1ControllerPassword);