2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 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 com.google.gson.FieldNamingPolicy;
24 import com.google.gson.Gson;
25 import com.google.gson.GsonBuilder;
27 import java.lang.invoke.MethodHandles;
28 import java.util.ArrayList;
29 import java.util.List;
31 import org.json.JSONArray;
32 import org.json.JSONException;
33 import org.json.JSONObject;
34 import org.oransc.policyagent.configuration.RicConfig;
35 import org.oransc.policyagent.repository.Policy;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 import reactor.core.publisher.Flux;
40 import reactor.core.publisher.Mono;
42 public class SdnrOnapA1Client implements A1Client {
43 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
45 private final String a1ControllerUsername;
46 private final String a1ControllerPassword;
47 private final RicConfig ricConfig;
48 private final AsyncRestClient restClient;
50 private static Gson gson = new GsonBuilder() //
51 .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) //
54 public SdnrOnapA1Client(RicConfig ricConfig, String baseUrl, String username, String password) {
55 this(ricConfig, username, password, new AsyncRestClient(baseUrl + "/restconf/operations"));
56 if (logger.isDebugEnabled()) {
57 logger.debug("SdnrOnapA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
61 public SdnrOnapA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) {
62 this.ricConfig = ricConfig;
63 this.a1ControllerUsername = username;
64 this.a1ControllerPassword = password;
65 this.restClient = restClient;
69 public Mono<List<String>> getPolicyTypeIdentities() {
70 SdnrOnapAdapterInput inputParams = ImmutableSdnrOnapAdapterInput.builder() //
71 .nearRtRicId(ricConfig.baseUrl()) //
73 String inputJsonString = createInputJsonString(inputParams);
74 logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
77 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyTypes", inputJsonString, a1ControllerUsername,
78 a1ControllerPassword) //
79 .flatMap(response -> getValueFromResponse(response, "policy-type-id-list")) //
80 .flatMap(this::parseJsonArrayOfString);
84 public Mono<List<String>> getPolicyIdentities() {
85 return getPolicyTypeIdentities() //
86 .flatMapMany(types -> Flux.fromIterable(types)) //
87 .flatMap(type -> getPolicyIdentities(type)) //
88 .flatMap(policyIds -> Flux.fromIterable(policyIds)) //
92 public Mono<List<String>> getPolicyIdentities(String policyTypeId) {
93 SdnrOnapAdapterInput inputParams = ImmutableSdnrOnapAdapterInput.builder() //
94 .nearRtRicId(ricConfig.baseUrl()) //
95 .policyTypeId(policyTypeId) //
97 String inputJsonString = createInputJsonString(inputParams);
98 logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
101 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyInstances", inputJsonString, a1ControllerUsername,
102 a1ControllerPassword) //
103 .flatMap(response -> getValueFromResponse(response, "policy-instance-id-list")) //
104 .flatMap(this::parseJsonArrayOfString);
108 public Mono<String> getPolicyTypeSchema(String policyTypeId) {
109 SdnrOnapAdapterInput inputParams = ImmutableSdnrOnapAdapterInput.builder() //
110 .nearRtRicId(ricConfig.baseUrl()) //
111 .policyTypeId(policyTypeId) //
113 String inputJsonString = createInputJsonString(inputParams);
114 logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
117 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyType", inputJsonString, a1ControllerUsername,
118 a1ControllerPassword) //
119 .flatMap(response -> getValueFromResponse(response, "policy-type")) //
120 .flatMap(this::extractPolicySchema);
124 public Mono<String> putPolicy(Policy policy) {
125 SdnrOnapAdapterInput inputParams = ImmutableSdnrOnapAdapterInput.builder() //
126 .nearRtRicId(ricConfig.baseUrl()) //
127 .policyTypeId(policy.type().name()) //
128 .policyInstanceId(policy.id()) //
129 .policyInstance(policy.json()) //
130 .properties(new ArrayList<String>()) //
132 String inputJsonString = createInputJsonString(inputParams);
133 logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
135 return restClient.postWithAuthHeader("/A1-ADAPTER-API:createPolicyInstance", inputJsonString,
136 a1ControllerUsername, a1ControllerPassword);
139 public Mono<String> deletePolicy(String policyTypeId, String policyId) {
140 SdnrOnapAdapterInput inputParams = ImmutableSdnrOnapAdapterInput.builder() //
141 .nearRtRicId(ricConfig.baseUrl()) //
142 .policyTypeId(policyTypeId) //
143 .policyInstanceId(policyId) //
145 String inputJsonString = createInputJsonString(inputParams);
146 logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
148 return restClient.postWithAuthHeader("/A1-ADAPTER-API:deletePolicyInstance", inputJsonString,
149 a1ControllerUsername, a1ControllerPassword);
153 public Mono<String> deletePolicy(Policy policy) {
154 return deletePolicy(policy.type().name(), policy.id());
158 public Flux<String> deleteAllPolicies() {
159 return getPolicyTypeIdentities() //
160 .flatMapMany(types -> Flux.fromIterable(types)) //
161 .flatMap(typeId -> deletePoliciesForType(typeId)); //
164 private Flux<String> deletePoliciesForType(String typeId) {
165 return getPolicyIdentities(typeId) //
166 .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) //
167 .flatMap(policyId -> deletePolicy(typeId, policyId)); //
171 public Mono<A1ProtocolType> getProtocolVersion() {
172 return getPolicyTypeIdentities() //
173 .flatMap(x -> Mono.just(A1ProtocolType.SDNR_ONAP));
176 private String createInputJsonString(SdnrOnapAdapterInput inputParams) {
177 JSONObject inputJson = new JSONObject();
178 inputJson.put("input", new JSONObject(gson.toJson(inputParams)));
179 return inputJson.toString();
182 private Mono<String> getValueFromResponse(String response, String key) {
183 logger.debug("A1 client: response = {}", response);
185 JSONObject outputJson = new JSONObject(response);
186 JSONObject responseParams = outputJson.getJSONObject("output");
187 if (!responseParams.has(key)) {
188 return Mono.just("");
190 String value = responseParams.get(key).toString();
191 return Mono.just(value);
192 } catch (JSONException ex) { // invalid json
193 return Mono.error(ex);
197 private Mono<List<String>> parseJsonArrayOfString(String inputString) {
199 List<String> arrayList = new ArrayList<>();
200 if (inputString.isEmpty()) {
201 return Mono.just(arrayList);
203 JSONArray jsonArray = new JSONArray(inputString);
204 for (int i = 0; i < jsonArray.length(); i++) {
205 arrayList.add(jsonArray.getString(i));
207 logger.debug("A1 client: received list = {}", arrayList);
208 return Mono.just(arrayList);
209 } catch (JSONException ex) { // invalid json
210 return Mono.error(ex);
214 private Mono<String> extractPolicySchema(String inputString) {
216 JSONObject jsonObject = new JSONObject(inputString);
217 JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
218 String schemaString = schemaObject.toString();
219 return Mono.just(schemaString);
220 } catch (JSONException ex) { // invalid json
221 return Mono.error(ex);
226 public Mono<String> getPolicyStatus(Policy policy) {
227 return Mono.error(new Exception("Status not implemented in the controller"));