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 java.lang.invoke.MethodHandles;
24 import java.util.ArrayList;
25 import java.util.List;
27 import org.json.JSONArray;
28 import org.json.JSONException;
29 import org.json.JSONObject;
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;
38 public class SdncOscA1Client implements A1Client {
39 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
41 private String a1ControllerBaseUrl;
42 private String a1ControllerUsername;
43 private String a1ControllerPassword;
44 private final RicConfig ricConfig;
45 private final AsyncRestClient restClient;
47 public SdncOscA1Client(RicConfig ricConfig, String baseUrl, String username, String password) {
48 this.ricConfig = ricConfig;
49 this.a1ControllerBaseUrl = baseUrl;
50 this.a1ControllerUsername = username;
51 this.a1ControllerPassword = password;
52 this.restClient = new AsyncRestClient(a1ControllerBaseUrl + "/restconf/operations");
53 logger.debug("SdncOscA1Client for ric: {}, a1ControllerBaseUrl: {}", this.ricConfig.name(),
58 public Mono<List<String>> getPolicyTypeIdentities() {
59 JSONObject paramsJson = new JSONObject();
60 paramsJson.put("near-rt-ric-url", ricConfig.baseUrl());
61 String inputJsonString = createInputJsonString(paramsJson);
62 logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
65 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyTypeIdentities", inputJsonString, a1ControllerUsername,
66 a1ControllerPassword) //
67 .flatMap(response -> getValueFromResponse(response, "policy-type-id-list")) //
68 .flatMap(this::parseJsonArrayOfString);
72 public Mono<List<String>> getPolicyIdentities() {
73 JSONObject paramsJson = new JSONObject();
74 paramsJson.put("near-rt-ric-url", ricConfig.baseUrl());
75 String inputJsonString = createInputJsonString(paramsJson);
76 logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
79 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyIdentities", inputJsonString, a1ControllerUsername,
80 a1ControllerPassword) //
81 .flatMap(response -> getValueFromResponse(response, "policy-id-list")) //
82 .flatMap(this::parseJsonArrayOfString);
86 public Mono<String> getPolicyTypeSchema(String policyTypeId) {
87 JSONObject paramsJson = new JSONObject();
88 paramsJson.put("near-rt-ric-url", ricConfig.baseUrl());
89 paramsJson.put("policy-type-id", policyTypeId);
90 String inputJsonString = createInputJsonString(paramsJson);
91 logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
94 .postWithAuthHeader("/A1-ADAPTER-API:getPolicyType", inputJsonString, a1ControllerUsername,
95 a1ControllerPassword) //
96 .flatMap(response -> getValueFromResponse(response, "policy-type")) //
97 .flatMap(this::extractPolicySchema);
101 public Mono<String> putPolicy(Policy policy) {
102 JSONObject paramsJson = new JSONObject();
103 paramsJson.put("near-rt-ric-url", ricConfig.baseUrl());
104 paramsJson.put("policy-id", policy.id());
105 paramsJson.put("policy-type-id", policy.type().name());
106 paramsJson.put("policy", policy.json());
107 String inputJsonString = createInputJsonString(paramsJson);
108 logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
111 .postWithAuthHeader("/A1-ADAPTER-API:putPolicy", inputJsonString, a1ControllerUsername,
112 a1ControllerPassword) //
113 .flatMap(response -> getValueFromResponse(response, "returned-policy")) //
114 .flatMap(this::validateJson);
118 public Mono<String> deletePolicy(Policy policy) {
119 return deletePolicy(policy.id());
123 public Flux<String> deleteAllPolicies() {
124 return getPolicyIdentities() //
125 .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) // )
126 .flatMap(policyId -> deletePolicy(policyId)); //
129 public Mono<String> deletePolicy(String policyId) {
130 JSONObject paramsJson = new JSONObject();
131 paramsJson.put("near-rt-ric-url", ricConfig.baseUrl());
132 paramsJson.put("policy-id", policyId);
133 String inputJsonString = createInputJsonString(paramsJson);
134 logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
136 return restClient.postWithAuthHeader("/A1-ADAPTER-API:deletePolicy", inputJsonString, a1ControllerUsername,
137 a1ControllerPassword);
141 public Mono<A1ProtocolType> getProtocolVersion() {
142 return getPolicyTypeIdentities() //
143 .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC));
146 private String createInputJsonString(JSONObject paramsJson) {
147 JSONObject inputJson = new JSONObject();
148 inputJson.put("input", paramsJson);
149 return inputJson.toString();
152 private Mono<String> getValueFromResponse(String response, String key) {
153 logger.debug("A1 client: response = {}", response);
155 JSONObject outputJson = new JSONObject(response);
156 JSONObject responseParams = outputJson.getJSONObject("output");
157 if (!responseParams.has(key)) {
158 return Mono.just("");
160 String value = responseParams.get(key).toString();
161 return Mono.just(value);
162 } catch (JSONException ex) { // invalid json
163 return Mono.error(ex);
167 private Mono<List<String>> parseJsonArrayOfString(String inputString) {
169 List<String> arrayList = new ArrayList<>();
170 if (inputString.isEmpty()) {
171 return Mono.just(arrayList);
173 JSONArray jsonArray = new JSONArray(inputString);
174 for (int i = 0; i < jsonArray.length(); i++) {
175 arrayList.add(jsonArray.getString(i));
177 logger.debug("A1 client: received list = {}", arrayList);
178 return Mono.just(arrayList);
179 } catch (JSONException ex) { // invalid json
180 return Mono.error(ex);
184 private Mono<String> extractPolicySchema(String inputString) {
186 JSONObject jsonObject = new JSONObject(inputString);
187 JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
188 String schemaString = schemaObject.toString();
189 return Mono.just(schemaString);
190 } catch (JSONException ex) { // invalid json
191 return Mono.error(ex);
195 private Mono<String> validateJson(String inputString) {
197 new JSONObject(inputString);
198 return Mono.just(inputString);
199 } catch (JSONException ex) { // invalid json
200 return Mono.error(ex);
205 public Mono<String> getPolicyStatus(Policy policy) {
206 return Mono.error(new Exception("Status not implemented in the SDNC controller"));