Improved java class documentation
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / clients / SdncOnapA1Client.java
index d39c211..cfabf51 100644 (file)
@@ -2,7 +2,7 @@
  * ========================LICENSE_START=================================
  * O-RAN-SC
  * %%
- * Copyright (C) 2019 Nordix Foundation
+ * Copyright (C) 2020 Nordix Foundation
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 package org.oransc.policyagent.clients;
 
-import com.google.gson.FieldNamingPolicy;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-
 import java.lang.invoke.MethodHandles;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 
-import org.json.JSONArray;
-import org.json.JSONException;
-import org.json.JSONObject;
+import org.immutables.gson.Gson;
+import org.immutables.value.Value;
 import org.oransc.policyagent.configuration.RicConfig;
 import org.oransc.policyagent.repository.Policy;
 import org.slf4j.Logger;
@@ -39,7 +35,25 @@ import org.slf4j.LoggerFactory;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
+/**
+ * Client for accessing the A1 adapter in the SDNC controller in ONAP
+ */
+@SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
 public class SdncOnapA1Client implements A1Client {
+    @Value.Immutable
+    @Gson.TypeAdapters
+    interface SdncOnapAdapterInput {
+        public String nearRtRicId();
+
+        public Optional<String> policyTypeId();
+
+        public Optional<String> policyInstanceId();
+
+        public Optional<String> policyInstance();
+
+        public Optional<List<String>> properties();
+    }
+
     private static final String URL_PREFIX = "/A1-ADAPTER-API:";
 
     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
@@ -49,15 +63,9 @@ public class SdncOnapA1Client implements A1Client {
     private final RicConfig ricConfig;
     private final AsyncRestClient restClient;
 
-    private static Gson gson = new GsonBuilder() //
-        .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) //
-        .create(); //
-
     public SdncOnapA1Client(RicConfig ricConfig, String baseUrl, String username, String password) {
         this(ricConfig, username, password, new AsyncRestClient(baseUrl + "/restconf/operations"));
-        if (logger.isDebugEnabled()) {
-            logger.debug("SdnrOnapA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
-        }
+        logger.debug("SdncOnapA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl);
     }
 
     public SdncOnapA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) {
@@ -69,57 +77,31 @@ public class SdncOnapA1Client implements A1Client {
 
     @Override
     public Mono<List<String>> getPolicyTypeIdentities() {
-        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
-            .nearRtRicId(ricConfig.baseUrl()) //
-            .build();
-        String inputJsonString = createInputJsonString(inputParams);
-        logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
-
-        return restClient
-            .postWithAuthHeader(URL_PREFIX + "getPolicyTypes", inputJsonString, a1ControllerUsername,
-                a1ControllerPassword) //
-            .flatMap(response -> getValueFromResponse(response, "policy-type-id-list")) //
-            .flatMap(this::parseJsonArrayOfString);
+        return getPolicyTypeIds() //
+            .collectList();
     }
 
     @Override
     public Mono<List<String>> getPolicyIdentities() {
-        return getPolicyTypeIdentities() //
-            .flatMapMany(types -> Flux.fromIterable(types)) //
-            .flatMap(type -> getPolicyIdentities(type)) //
-            .flatMap(policyIds -> Flux.fromIterable(policyIds)) //
+        return getPolicyTypeIds() //
+            .flatMap(this::getPolicyIdentitiesByType) //
             .collectList();
     }
 
-    public Mono<List<String>> getPolicyIdentities(String policyTypeId) {
-        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
-            .nearRtRicId(ricConfig.baseUrl()) //
-            .policyTypeId(policyTypeId) //
-            .build();
-        String inputJsonString = createInputJsonString(inputParams);
-        logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
-
-        return restClient
-            .postWithAuthHeader(URL_PREFIX + "getPolicyInstances", inputJsonString, a1ControllerUsername,
-                a1ControllerPassword) //
-            .flatMap(response -> getValueFromResponse(response, "policy-instance-id-list")) //
-            .flatMap(this::parseJsonArrayOfString);
-    }
-
     @Override
     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
         SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
             .nearRtRicId(ricConfig.baseUrl()) //
             .policyTypeId(policyTypeId) //
             .build();
-        String inputJsonString = createInputJsonString(inputParams);
+        String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
         logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString);
 
         return restClient
             .postWithAuthHeader(URL_PREFIX + "getPolicyType", inputJsonString, a1ControllerUsername,
                 a1ControllerPassword) //
-            .flatMap(response -> getValueFromResponse(response, "policy-type")) //
-            .flatMap(this::extractPolicySchema);
+            .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-type")) //
+            .flatMap(SdncJsonHelper::extractPolicySchema);
     }
 
     @Override
@@ -131,42 +113,29 @@ public class SdncOnapA1Client implements A1Client {
             .policyInstance(policy.json()) //
             .properties(new ArrayList<String>()) //
             .build();
-        String inputJsonString = createInputJsonString(inputParams);
-        logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
-
-        return restClient.postWithAuthHeader(URL_PREFIX + "createPolicyInstance", inputJsonString,
-            a1ControllerUsername, a1ControllerPassword);
-    }
 
-    public Mono<String> deletePolicyByIds(String policyTypeId, String policyId) {
-        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
-            .nearRtRicId(ricConfig.baseUrl()) //
-            .policyTypeId(policyTypeId) //
-            .policyInstanceId(policyId) //
-            .build();
-        String inputJsonString = createInputJsonString(inputParams);
-        logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
+        String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
+        logger.debug("POST putPolicy inputJsonString = {}", inputJsonString);
 
-        return restClient.postWithAuthHeader(URL_PREFIX + "deletePolicyInstance", inputJsonString,
-            a1ControllerUsername, a1ControllerPassword);
+        return restClient.postWithAuthHeader(URL_PREFIX + "createPolicyInstance", inputJsonString, a1ControllerUsername,
+            a1ControllerPassword);
     }
 
     @Override
     public Mono<String> deletePolicy(Policy policy) {
-        return deletePolicyByIds(policy.type().name(), policy.id());
+        return deletePolicyByTypeId(policy.type().name(), policy.id());
     }
 
     @Override
     public Flux<String> deleteAllPolicies() {
-        return getPolicyTypeIdentities() //
-            .flatMapMany(types -> Flux.fromIterable(types)) //
-            .flatMap(typeId -> deletePoliciesForType(typeId)); //
+        return getPolicyTypeIds() //
+            .flatMap(this::deletePoliciesForType); //
     }
 
     @Override
     public Mono<A1ProtocolType> getProtocolVersion() {
         return getPolicyTypeIdentities() //
-            .flatMap(x -> Mono.just(A1ProtocolType.SDNC_ONAP));
+            .flatMap(notUsed -> Mono.just(A1ProtocolType.SDNC_ONAP));
     }
 
     @Override
@@ -174,58 +143,50 @@ public class SdncOnapA1Client implements A1Client {
         return Mono.error(new Exception("Status not implemented in the controller"));
     }
 
-    private Mono<String> getValueFromResponse(String response, String key) {
-        logger.debug("A1 client: response = {}", response);
-        try {
-            JSONObject outputJson = new JSONObject(response);
-            JSONObject responseParams = outputJson.getJSONObject("output");
-            if (!responseParams.has(key)) {
-                return Mono.just("");
-            }
-            String value = responseParams.get(key).toString();
-            return Mono.just(value);
-        } catch (JSONException ex) { // invalid json
-            return Mono.error(ex);
-        }
-    }
+    private Flux<String> getPolicyTypeIds() {
+        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
+            .nearRtRicId(ricConfig.baseUrl()) //
+            .build();
+        String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
+        logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString);
 
-    private Mono<List<String>> parseJsonArrayOfString(String inputString) {
-        try {
-            List<String> arrayList = new ArrayList<>();
-            if (inputString.isEmpty()) {
-                return Mono.just(arrayList);
-            }
-            JSONArray jsonArray = new JSONArray(inputString);
-            for (int i = 0; i < jsonArray.length(); i++) {
-                arrayList.add(jsonArray.getString(i));
-            }
-            logger.debug("A1 client: received list = {}", arrayList);
-            return Mono.just(arrayList);
-        } catch (JSONException ex) { // invalid json
-            return Mono.error(ex);
-        }
+        return restClient
+            .postWithAuthHeader("/A1-ADAPTER-API:getPolicyTypes", inputJsonString, a1ControllerUsername,
+                a1ControllerPassword) //
+            .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-type-id-list")) //
+            .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
     }
 
-    private Mono<String> extractPolicySchema(String inputString) {
-        try {
-            JSONObject jsonObject = new JSONObject(inputString);
-            JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
-            String schemaString = schemaObject.toString();
-            return Mono.just(schemaString);
-        } catch (JSONException ex) { // invalid json
-            return Mono.error(ex);
-        }
+    private Flux<String> getPolicyIdentitiesByType(String policyTypeId) {
+        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
+            .nearRtRicId(ricConfig.baseUrl()) //
+            .policyTypeId(policyTypeId) //
+            .build();
+        String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
+        logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString);
+
+        return restClient
+            .postWithAuthHeader("/A1-ADAPTER-API:getPolicyInstances", inputJsonString, a1ControllerUsername,
+                a1ControllerPassword) //
+            .flatMap(response -> SdncJsonHelper.getValueFromResponse(response, "policy-instance-id-list")) //
+            .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
     }
 
     private Flux<String> deletePoliciesForType(String typeId) {
-        return getPolicyIdentities(typeId) //
-            .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) //
-            .flatMap(policyId -> deletePolicyByIds(typeId, policyId)); //
+        return getPolicyIdentitiesByType(typeId) //
+            .flatMap(policyId -> deletePolicyByTypeId(typeId, policyId)); //
     }
 
-    private String createInputJsonString(SdncOnapAdapterInput inputParams) {
-        JSONObject inputJson = new JSONObject();
-        inputJson.put("input", new JSONObject(gson.toJson(inputParams)));
-        return inputJson.toString();
+    private Mono<String> deletePolicyByTypeId(String policyTypeId, String policyId) {
+        SdncOnapAdapterInput inputParams = ImmutableSdncOnapAdapterInput.builder() //
+            .nearRtRicId(ricConfig.baseUrl()) //
+            .policyTypeId(policyTypeId) //
+            .policyInstanceId(policyId) //
+            .build();
+        String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
+        logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString);
+
+        return restClient.postWithAuthHeader("/A1-ADAPTER-API:deletePolicyInstance", inputJsonString,
+            a1ControllerUsername, a1ControllerPassword);
     }
 }