policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOnapA1Client.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 SdncOnapA1Client implements A1Client {
  43     private static final String URL_PREFIX = "/A1-ADAPTER-API:";
  44
  45     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  46
  47     private final String a1ControllerUsername;
  48     private final String a1ControllerPassword;
  49     private final RicConfig ricConfig;
  50     private final AsyncRestClient restClient;
  51
  52     private static Gson gson = new GsonBuilder() //
  53         .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) //
  54         .create(); //
  55
  56     public SdncOnapA1Client(RicConfig ricConfig, String baseUrl, String username, String password) {
  57         this(ricConfig, username, password, new AsyncRestClient(baseUrl + "/restconf/operations"));
  58         if (logger.isDebugEnabled()) {
  59             logger.debug("SdnrOnapA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
  60         }
  61     }
  62
  63     public SdncOnapA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) {
  64         this.ricConfig = ricConfig;
  65         this.a1ControllerUsername = username;
  66         this.a1ControllerPassword = password;
  67         this.restClient = restClient;
  68     }
  69
  70     @Override
  71     public Mono<List<String>> getPolicyTypeIdentities() {
  72         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
  73             .nearRtRicId(ricConfig.baseUrl()) //
  74             .build();
  75         String inputJsonString = createInputJsonString(inputParams);
  76         logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
  77
  78         return restClient
  79             .postWithAuthHeader(URL_PREFIX + "getPolicyTypes", inputJsonString, a1ControllerUsername,
  80                 a1ControllerPassword) //
  81             .flatMap(response -> getValueFromResponse(response, "policy-type-id-list")) //
  82             .flatMap(this::parseJsonArrayOfString);
  83     }
  84
  85     @Override
  86     public Mono<List<String>> getPolicyIdentities() {
  87         return getPolicyTypeIdentities() //
  88             .flatMapMany(types -> Flux.fromIterable(types)) //
  89             .flatMap(type -> getPolicyIdentities(type)) //
  90             .flatMap(policyIds -> Flux.fromIterable(policyIds)) //
  91             .collectList();
  92     }
  93
  94     public Mono<List<String>> getPolicyIdentities(String policyTypeId) {
  95         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
  96             .nearRtRicId(ricConfig.baseUrl()) //
  97             .policyTypeId(policyTypeId) //
  98             .build();
  99         String inputJsonString = createInputJsonString(inputParams);
 100         logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
 101
 102         return restClient
 103             .postWithAuthHeader(URL_PREFIX + "getPolicyInstances", inputJsonString, a1ControllerUsername,
 104                 a1ControllerPassword) //
 105             .flatMap(response -> getValueFromResponse(response, "policy-instance-id-list")) //
 106             .flatMap(this::parseJsonArrayOfString);
 107     }
 108
 109     @Override
 110     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 111         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
 112             .nearRtRicId(ricConfig.baseUrl()) //
 113             .policyTypeId(policyTypeId) //
 114             .build();
 115         String inputJsonString = createInputJsonString(inputParams);
 116         logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
 117
 118         return restClient
 119             .postWithAuthHeader(URL_PREFIX + "getPolicyType", inputJsonString, a1ControllerUsername,
 120                 a1ControllerPassword) //
 121             .flatMap(response -> getValueFromResponse(response, "policy-type")) //
 122             .flatMap(this::extractPolicySchema);
 123     }
 124
 125     @Override
 126     public Mono<String> putPolicy(Policy policy) {
 127         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
 128             .nearRtRicId(ricConfig.baseUrl()) //
 129             .policyTypeId(policy.type().name()) //
 130             .policyInstanceId(policy.id()) //
 131             .policyInstance(policy.json()) //
 132             .properties(new ArrayList<String>()) //
 133             .build();
 134         String inputJsonString = createInputJsonString(inputParams);
 135         logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
 136
 137         return restClient.postWithAuthHeader(URL_PREFIX + "createPolicyInstance", inputJsonString,
 138             a1ControllerUsername, a1ControllerPassword);
 139     }
 140
 141     public Mono<String> deletePolicyByIds(String policyTypeId, String policyId) {
 142         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
 143             .nearRtRicId(ricConfig.baseUrl()) //
 144             .policyTypeId(policyTypeId) //
 145             .policyInstanceId(policyId) //
 146             .build();
 147         String inputJsonString = createInputJsonString(inputParams);
 148         logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
 149
 150         return restClient.postWithAuthHeader(URL_PREFIX + "deletePolicyInstance", inputJsonString,
 151             a1ControllerUsername, a1ControllerPassword);
 152     }
 153
 154     @Override
 155     public Mono<String> deletePolicy(Policy policy) {
 156         return deletePolicyByIds(policy.type().name(), policy.id());
 157     }
 158
 159     @Override
 160     public Flux<String> deleteAllPolicies() {
 161         return getPolicyTypeIdentities() //
 162             .flatMapMany(types -> Flux.fromIterable(types)) //
 163             .flatMap(typeId -> deletePoliciesForType(typeId)); //
 164     }
 165
 166     @Override
 167     public Mono<A1ProtocolType> getProtocolVersion() {
 168         return getPolicyTypeIdentities() //
 169             .flatMap(x -> Mono.just(A1ProtocolType.SDNC_ONAP));
 170     }
 171
 172     @Override
 173     public Mono<String> getPolicyStatus(Policy policy) {
 174         return Mono.error(new Exception("Status not implemented in the controller"));
 175     }
 176
 177     private Mono<String> getValueFromResponse(String response, String key) {
 178         logger.debug("A1 client: response = {}", response);
 179         try {
 180             JSONObject outputJson = new JSONObject(response);
 181             JSONObject responseParams = outputJson.getJSONObject("output");
 182             if (!responseParams.has(key)) {
 183                 return Mono.just("");
 184             }
 185             String value = responseParams.get(key).toString();
 186             return Mono.just(value);
 187         } catch (JSONException ex) { // invalid json
 188             return Mono.error(ex);
 189         }
 190     }
 191
 192     private Mono<List<String>> parseJsonArrayOfString(String inputString) {
 193         try {
 194             List<String> arrayList = new ArrayList<>();
 195             if (inputString.isEmpty()) {
 196                 return Mono.just(arrayList);
 197             }
 198             JSONArray jsonArray = new JSONArray(inputString);
 199             for (int i = 0; i < jsonArray.length(); i++) {
 200                 arrayList.add(jsonArray.getString(i));
 201             }
 202             logger.debug("A1 client: received list = {}", arrayList);
 203             return Mono.just(arrayList);
 204         } catch (JSONException ex) { // invalid json
 205             return Mono.error(ex);
 206         }
 207     }
 208
 209     private Mono<String> extractPolicySchema(String inputString) {
 210         try {
 211             JSONObject jsonObject = new JSONObject(inputString);
 212             JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
 213             String schemaString = schemaObject.toString();
 214             return Mono.just(schemaString);
 215         } catch (JSONException ex) { // invalid json
 216             return Mono.error(ex);
 217         }
 218     }
 219
 220     private Flux<String> deletePoliciesForType(String typeId) {
 221         return getPolicyIdentities(typeId) //
 222             .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) //
 223             .flatMap(policyId -> deletePolicyByIds(typeId, policyId)); //
 224     }
 225
 226     private String createInputJsonString(SdncOnapAdapterInput inputParams) {
 227         JSONObject inputJson = new JSONObject();
 228         inputJson.put("input", new JSONObject(gson.toJson(inputParams)));
 229         return inputJson.toString();
 230     }
 231 }