X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fpolicyagent%2Fclients%2FOscA1Client.java;h=a388267e344dbe362e4446591262c09bfbdbc016;hb=6a39814272307d0207222c9229b0d765ac062bf0;hp=5c18103de2aa4570ff980c6c9cb87f94787266e9;hpb=1b8d76de3262675c5afe45351929b0d5d2c0bab1;p=nonrtric.git diff --git a/policy-agent/src/main/java/org/oransc/policyagent/clients/OscA1Client.java b/policy-agent/src/main/java/org/oransc/policyagent/clients/OscA1Client.java index 5c18103d..a388267e 100644 --- a/policy-agent/src/main/java/org/oransc/policyagent/clients/OscA1Client.java +++ b/policy-agent/src/main/java/org/oransc/policyagent/clients/OscA1Client.java @@ -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. @@ -21,13 +21,11 @@ package org.oransc.policyagent.clients; import java.lang.invoke.MethodHandles; -import java.util.ArrayList; import java.util.List; -import org.json.JSONArray; -import org.json.JSONException; import org.json.JSONObject; import org.oransc.policyagent.configuration.RicConfig; +import org.oransc.policyagent.configuration.WebClientConfig; import org.oransc.policyagent.repository.Policy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -35,106 +33,181 @@ import org.slf4j.LoggerFactory; import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; +/** + * Client for accessing OSC A1 REST API + */ +@SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally public class OscA1Client implements A1Client { - private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + static final int CONCURRENCY_RIC = 1; // How may paralell requests that is sent to one NearRT RIC - private final AsyncRestClient restClient; + public static class UriBuilder implements A1UriBuilder { + private final RicConfig ricConfig; - public OscA1Client(RicConfig ricConfig) { - String baseUrl = ricConfig.baseUrl() + "/a1-p"; - this.restClient = new AsyncRestClient(baseUrl); - logger.debug("OscA1Client for ric: {}", ricConfig.name()); - } + public UriBuilder(RicConfig ricConfig) { + this.ricConfig = ricConfig; + } - @Override - public Mono> getPolicyTypeIdentities() { - return restClient.get("/policytypes") // - .flatMap(this::parseJsonArrayOfString); - } + @Override + public String createPutPolicyUri(String type, String policyId) { + return createPolicyUri(type, policyId); + } - @Override - public Mono> getPolicyIdentities() { - return getPolicyTypeIdentities() // - .flatMapMany(types -> Flux.fromIterable(types)) // - .flatMap(type -> getPolicyIdentities(type)) // - .flatMap(policyIds -> Flux.fromIterable(policyIds)) // - .collectList(); + /** + * /a1-p/policytypes/{policy_type_id}/policies + */ + public String createGetPolicyIdsUri(String type) { + return createPolicyTypeUri(type) + "/policies"; + } + + @Override + public String createDeleteUri(String type, String policyId) { + return createPolicyUri(type, policyId); + } + + /** + * ​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id}​/status + */ + @Override + public String createGetPolicyStatusUri(String type, String policyId) { + return createPolicyUri(type, policyId) + "/status"; + } + + /** + * ​/a1-p​/healthcheck + */ + public String createHealtcheckUri() { + return baseUri() + "/healthcheck"; + } + + /** + * /a1-p/policytypes/{policy_type_id} + */ + public String createGetSchemaUri(String type) { + return this.createPolicyTypeUri(type); + } + + /** + * ​/a1-p​/policytypes​/{policy_type_id} + */ + public String createPolicyTypesUri() { + return baseUri() + "/policytypes"; + } + + /** + * ​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id} + */ + private String createPolicyUri(String type, String id) { + return createPolicyTypeUri(type) + "/policies/" + id; + } + + /** + * /a1-p/policytypes/{policy_type_id} + */ + private String createPolicyTypeUri(String type) { + return createPolicyTypesUri() + "/" + type; + } + + private String baseUri() { + return ricConfig.baseUrl() + "/a1-p"; + } } - private Mono> getPolicyIdentities(String typeId) { - return restClient.get("/policytypes/" + typeId + "/policies") // - .flatMap(this::parseJsonArrayOfString); + private static final String TITLE = "title"; + private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final AsyncRestClient restClient; + private final UriBuilder uri; + + public OscA1Client(RicConfig ricConfig, WebClientConfig clientConfig) { + this(ricConfig, new AsyncRestClient("", clientConfig)); } - @Override - public Mono getPolicyTypeSchema(String policyTypeId) { - return restClient.get("/policytypes/" + policyTypeId) // - .flatMap(response -> getCreateSchema(response, policyTypeId)); + public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) { + this.restClient = restClient; + logger.debug("OscA1Client for ric: {}", ricConfig.name()); + + uri = new UriBuilder(ricConfig); } - private Mono getCreateSchema(String policyTypeResponse, String policyTypeId) { + public static Mono extractCreateSchema(String policyTypeResponse, String policyTypeId) { try { JSONObject obj = new JSONObject(policyTypeResponse); JSONObject schemaObj = obj.getJSONObject("create_schema"); - schemaObj.put("title", policyTypeId); + schemaObj.put(TITLE, policyTypeId); return Mono.just(schemaObj.toString()); } catch (Exception e) { - logger.error("Unexcpected response for policy type: {}", policyTypeResponse, e); + String exceptionString = e.toString(); + logger.error("Unexpected response for policy type: {}, exception: {}", policyTypeResponse, exceptionString); return Mono.error(e); } } @Override - public Mono putPolicy(Policy policy) { - return restClient.put("/policytypes/" + policy.type().name() + "/policies/" + policy.id(), policy.json()); + public Mono> getPolicyTypeIdentities() { + return getPolicyTypeIds() // + .collectList(); } @Override - public Mono deletePolicy(Policy policy) { - return deletePolicy(policy.type().name(), policy.id()); + public Mono> getPolicyIdentities() { + return getPolicyTypeIds() // + .flatMap(this::getPolicyIdentitiesByType) // + .collectList(); } - private Mono deletePolicy(String typeId, String policyId) { - return restClient.delete("/policytypes/" + typeId + "/policies/" + policyId); + @Override + public Mono getPolicyTypeSchema(String policyTypeId) { + String schemaUri = uri.createGetSchemaUri(policyTypeId); + return restClient.get(schemaUri) // + .flatMap(response -> extractCreateSchema(response, policyTypeId)); } @Override - public Mono getProtocolVersion() { - return restClient.get("/healthcheck") // - .flatMap(resp -> Mono.just(A1ProtocolType.OSC_V1)); + public Mono putPolicy(Policy policy) { + String policyUri = this.uri.createPutPolicyUri(policy.type().name(), policy.id()); + return restClient.put(policyUri, policy.json()); } @Override - public Flux deleteAllPolicies() { - return getPolicyTypeIdentities() // - .flatMapMany(types -> Flux.fromIterable(types)) // - .flatMap(typeId -> deletePoliciesForType(typeId)); // + public Mono deletePolicy(Policy policy) { + return deletePolicyById(policy.type().name(), policy.id()); } - private Flux deletePoliciesForType(String typeId) { - return getPolicyIdentities(typeId) // - .flatMapMany(policyIds -> Flux.fromIterable(policyIds)) // - .flatMap(policyId -> deletePolicy(typeId, policyId)); // + @Override + public Mono getProtocolVersion() { + return restClient.get(uri.createHealtcheckUri()) // + .flatMap(notUsed -> Mono.just(A1ProtocolType.OSC_V1)); } - private Mono> parseJsonArrayOfString(String inputString) { - try { - List arrayList = new 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); - } + @Override + public Flux deleteAllPolicies() { + return getPolicyTypeIds() // + .flatMap(this::deletePoliciesForType, CONCURRENCY_RIC); } @Override public Mono getPolicyStatus(Policy policy) { - // /a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status - return restClient.get("/policytypes/" + policy.type().name() + "/policies/" + policy.id() + "/status"); + String statusUri = uri.createGetPolicyStatusUri(policy.type().name(), policy.id()); + return restClient.get(statusUri); + + } + + private Flux getPolicyTypeIds() { + return restClient.get(uri.createPolicyTypesUri()) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString); + } + + private Flux getPolicyIdentitiesByType(String typeId) { + return restClient.get(uri.createGetPolicyIdsUri(typeId)) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString); + } + + private Mono deletePolicyById(String typeId, String policyId) { + String policyUri = uri.createDeleteUri(typeId, policyId); + return restClient.delete(policyUri); + } + private Flux deletePoliciesForType(String typeId) { + return getPolicyIdentitiesByType(typeId) // + .flatMap(policyId -> deletePolicyById(typeId, policyId), CONCURRENCY_RIC); } }