policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOscA1Client.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   6  * %%
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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===================================
  19  */
  20
  21 package org.oransc.policyagent.clients;
  22
  23 import com.google.gson.FieldNamingPolicy;
  24 import com.google.gson.Gson;
  25 import com.google.gson.GsonBuilder;
  26
  27 import java.lang.invoke.MethodHandles;
  28 import java.util.ArrayList;
  29 import java.util.List;
  30
  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;
  38
  39 import reactor.core.publisher.Flux;
  40 import reactor.core.publisher.Mono;
  41
  42 public class SdncOscA1Client implements A1Client {
  43     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  44
  45     private final String a1ControllerUsername;
  46     private final String a1ControllerPassword;
  47     private final RicConfig ricConfig;
  48     private final AsyncRestClient restClient;
  49
  50     private static Gson gson = new GsonBuilder() //
  51         .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) //
  52         .create(); //
  53
  54     public SdncOscA1Client(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("SdncOscA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
  58         }
  59     }
  60
  61     public SdncOscA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) {
  62         this.ricConfig = ricConfig;
  63         this.a1ControllerUsername = username;
  64         this.a1ControllerPassword = password;
  65         this.restClient = restClient;
  66     }
  67
  68     @Override
  69     public Mono<List<String>> getPolicyTypeIdentities() {
  70         SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() //
  71             .nearRtRicUrl(ricConfig.baseUrl()) //
  72             .build();
  73         String inputJsonString = createInputJsonString(gson.toJson(inputParams));
  74         logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
  75
  76         return restClient
  77             .postWithAuthHeader("/A1-ADAPTER-API:getPolicyTypeIdentities", inputJsonString, a1ControllerUsername,
  78                 a1ControllerPassword) //
  79             .flatMap(response -> getValueFromResponse(response, "policy-type-id-list")) //
  80             .flatMap(this::parseJsonArrayOfString);
  81     }
  82
  83     @Override
  84     public Mono<List<String>> getPolicyIdentities() {
  85         SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() //
  86             .nearRtRicUrl(ricConfig.baseUrl()) //
  87             .build();
  88         String inputJsonString = createInputJsonString(gson.toJson(inputParams));
  89         logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
  90
  91         return restClient
  92             .postWithAuthHeader("/A1-ADAPTER-API:getPolicyIdentities", inputJsonString, a1ControllerUsername,
  93                 a1ControllerPassword) //
  94             .flatMap(response -> getValueFromResponse(response, "policy-id-list")) //
  95             .flatMap(this::parseJsonArrayOfString);
  96     }
  97
  98     @Override
  99     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 100         SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() //
 101             .nearRtRicUrl(ricConfig.baseUrl()) //
 102             .policyTypeId(policyTypeId) //
 103             .build();
 104         String inputJsonString = createInputJsonString(gson.toJson(inputParams));
 105         logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
 106
 107         return restClient
 108             .postWithAuthHeader("/A1-ADAPTER-API:getPolicyType", inputJsonString, a1ControllerUsername,
 109                 a1ControllerPassword) //
 110             .flatMap(response -> getValueFromResponse(response, "policy-type")) //
 111             .flatMap(this::extractPolicySchema);
 112     }
 113
 114     @Override
 115     public Mono<String> putPolicy(Policy policy) {
 116         SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() //
 117             .nearRtRicUrl(ricConfig.baseUrl()) //
 118             .policyTypeId(policy.type().name()) //
 119             .policyId(policy.id()) //
 120             .policy(policy.json()) //
 121             .build();
 122         String inputJsonString = createInputJsonString(gson.toJson(inputParams));
 123         logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
 124
 125         return restClient
 126             .postWithAuthHeader("/A1-ADAPTER-API:putPolicy", inputJsonString, a1ControllerUsername,
 127                 a1ControllerPassword) //
 128             .flatMap(response -> getValueFromResponse(response, "returned-policy")) //
 129             .flatMap(this::validateJson);
 130     }
 131
 132     @Override
 133     public Mono<String> deletePolicy(Policy policy) {
 134         return deletePolicy(policy.id());
 135     }
 136
 137     @Override
 138     public Flux<String> deleteAllPolicies() {
 139         return getPolicyIdentities() //
 140             .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) // )
 141             .flatMap(policyId -> deletePolicy(policyId)); //
 142     }
 143
 144     public Mono<String> deletePolicy(String policyId) {
 145         SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() //
 146             .nearRtRicUrl(ricConfig.baseUrl()) //
 147             .policyId(policyId) //
 148             .build();
 149         String inputJsonString = createInputJsonString(gson.toJson(inputParams));
 150         logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
 151
 152         return restClient.postWithAuthHeader("/A1-ADAPTER-API:deletePolicy", inputJsonString, a1ControllerUsername,
 153             a1ControllerPassword);
 154     }
 155
 156     @Override
 157     public Mono<A1ProtocolType> getProtocolVersion() {
 158         return getPolicyTypeIdentities() //
 159             .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC));
 160     }
 161
 162     private String createInputJsonString(String paramsJson) {
 163         JSONObject inputJson = new JSONObject();
 164         inputJson.put("input", new JSONObject(paramsJson));
 165         return inputJson.toString();
 166     }
 167
 168     private Mono<String> getValueFromResponse(String response, String key) {
 169         logger.debug("A1 client: response = {}", response);
 170         try {
 171             JSONObject outputJson = new JSONObject(response);
 172             JSONObject responseParams = outputJson.getJSONObject("output");
 173             if (!responseParams.has(key)) {
 174                 return Mono.just("");
 175             }
 176             String value = responseParams.get(key).toString();
 177             return Mono.just(value);
 178         } catch (JSONException ex) { // invalid json
 179             return Mono.error(ex);
 180         }
 181     }
 182
 183     private Mono<List<String>> parseJsonArrayOfString(String inputString) {
 184         try {
 185             List<String> arrayList = new ArrayList<>();
 186             if (inputString.isEmpty()) {
 187                 return Mono.just(arrayList);
 188             }
 189             JSONArray jsonArray = new JSONArray(inputString);
 190             for (int i = 0; i < jsonArray.length(); i++) {
 191                 arrayList.add(jsonArray.getString(i));
 192             }
 193             logger.debug("A1 client: received list = {}", arrayList);
 194             return Mono.just(arrayList);
 195         } catch (JSONException ex) { // invalid json
 196             return Mono.error(ex);
 197         }
 198     }
 199
 200     private Mono<String> extractPolicySchema(String inputString) {
 201         try {
 202             JSONObject jsonObject = new JSONObject(inputString);
 203             JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
 204             String schemaString = schemaObject.toString();
 205             return Mono.just(schemaString);
 206         } catch (JSONException ex) { // invalid json
 207             return Mono.error(ex);
 208         }
 209     }
 210
 211     private Mono<String> validateJson(String inputString) {
 212         try {
 213             new JSONObject(inputString);
 214             return Mono.just(inputString);
 215         } catch (JSONException ex) { // invalid json
 216             return Mono.error(ex);
 217         }
 218     }
 219
 220     @Override
 221     public Mono<String> getPolicyStatus(Policy policy) {
 222         return Mono.error(new Exception("Status not implemented in the SDNC controller"));
 223     }
 224 }