X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fpolicyagent%2Fclients%2FSdncOscA1Client.java;h=79a2a5ef45ae2374dd6520fa78dfcfb21d2a859b;hb=19d9a443acc89baf4de4213b02f3233f0e62ad18;hp=d9aea5913edf331545f3f24dc4d77a971a7c4f0a;hpb=d15a3b60b7dc968bd17f32063508c7dc6defc03a;p=nonrtric.git diff --git a/policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOscA1Client.java b/policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOscA1Client.java index d9aea591..79a2a5ef 100644 --- a/policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOscA1Client.java +++ b/policy-agent/src/main/java/org/oransc/policyagent/clients/SdncOscA1Client.java @@ -30,7 +30,10 @@ import java.util.List; import java.util.Optional; import org.immutables.value.Value; +import org.json.JSONObject; +import org.oransc.policyagent.configuration.ControllerConfig; 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; @@ -40,9 +43,14 @@ import org.springframework.web.reactive.function.client.WebClientResponseExcepti import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; +/** + * Client for accessing the A1 adapter in the SDNC controller in OSC. + */ @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally public class SdncOscA1Client implements A1Client { + static final int CONCURRENCY_RIC = 1; // How may paralell requests that is sent to one NearRT RIC + @Value.Immutable @org.immutables.gson.Gson.TypeAdapters public interface AdapterRequest { @@ -53,8 +61,8 @@ public class SdncOscA1Client implements A1Client { @Value.Immutable @org.immutables.gson.Gson.TypeAdapters - public interface AdapterResponse { - public String body(); + public interface AdapterOutput { + public Optional body(); public int httpStatus(); } @@ -64,43 +72,65 @@ public class SdncOscA1Client implements A1Client { .create(); // private static final String GET_POLICY_RPC = "getA1Policy"; - private static final String UNHANDELED_PROTOCOL = "Bug, unhandeled protocoltype: "; private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - private final String a1ControllerUsername; - private final String a1ControllerPassword; + private final ControllerConfig controllerConfig; private final AsyncRestClient restClient; private final RicConfig ricConfig; private final A1ProtocolType protocolType; - public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, String controllerBaseUrl, String username, - String password) { - this(protocolType, ricConfig, username, password, - new AsyncRestClient(controllerBaseUrl + "/restconf/operations")); - logger.debug("SdncOscA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), controllerBaseUrl); + /** + * Constructor that creates the REST client to use. + * + * @param protocolType the southbound protocol of the controller. Supported protocols are SDNC_OSC_STD_V1_1 and + * SDNC_OSC_OSC_V1 + * @param ricConfig the configuration of the Ric to communicate with + * @param controllerConfig the configuration of the SDNC controller to use + * + * @throws IllegalArgumentException when the protocolType is wrong. + */ + public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig, + WebClientConfig clientConfig) { + this(protocolType, ricConfig, controllerConfig, + new AsyncRestClient(controllerConfig.baseUrl() + "/restconf/operations", clientConfig)); + logger.debug("SdncOscA1Client for ric: {}, a1Controller: {}", ricConfig.name(), controllerConfig); } - public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, String username, String password, + /** + * Constructor where the REST client to use is provided. + * + * @param protocolType the southbound protocol of the controller. Supported protocols are SDNC_OSC_STD_V1_1 and + * SDNC_OSC_OSC_V1 + * @param ricConfig the configuration of the Ric to communicate with + * @param controllerConfig the configuration of the SDNC controller to use + * @param restClient the REST client to use + * + * @throws IllegalArgumentException when the protocolType is wrong. + */ + public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig, AsyncRestClient restClient) { - this.a1ControllerUsername = username; - this.a1ControllerPassword = password; + if (!(A1ProtocolType.SDNC_OSC_STD_V1_1.equals(protocolType) + || A1ProtocolType.SDNC_OSC_OSC_V1.equals(protocolType))) { + throw new IllegalArgumentException("Protocol type must be " + A1ProtocolType.SDNC_OSC_STD_V1_1 + " or " + + A1ProtocolType.SDNC_OSC_OSC_V1 + ", was: " + protocolType); + } this.restClient = restClient; this.ricConfig = ricConfig; this.protocolType = protocolType; - + this.controllerConfig = controllerConfig; } @Override public Mono> getPolicyTypeIdentities() { if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { return Mono.just(Arrays.asList("")); - } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + } else { OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); final String ricUrl = uri.createPolicyTypesUri(); return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // - .flatMapMany(JsonHelper::parseJsonArrayOfString) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString) // .collectList(); } - throw new NullPointerException(UNHANDELED_PROTOCOL + this.protocolType); + } @Override @@ -113,18 +143,21 @@ public class SdncOscA1Client implements A1Client { public Mono getPolicyTypeSchema(String policyTypeId) { if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { return Mono.just("{}"); - } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + } else { OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); final String ricUrl = uri.createGetSchemaUri(policyTypeId); - return post(GET_POLICY_RPC, ricUrl, Optional.empty()); + return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // + .flatMap(response -> OscA1Client.extractCreateSchema(response, policyTypeId)); } - throw new NullPointerException(UNHANDELED_PROTOCOL + this.protocolType); } @Override public Mono putPolicy(Policy policy) { - final String ricUrl = getUriBuilder().createPutPolicyUri(policy.type().name(), policy.id()); - return post("putA1Policy", ricUrl, Optional.of(policy.json())); + return getUriBuilder() // + .flatMap(builder -> { + String ricUrl = builder.createPutPolicyUri(policy.type().name(), policy.id()); + return post("putA1Policy", ricUrl, Optional.of(policy.json())); + }); } @Override @@ -136,15 +169,23 @@ public class SdncOscA1Client implements A1Client { public Flux deleteAllPolicies() { if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { return getPolicyIds() // - .flatMap(policyId -> deletePolicyById("", policyId)); // - } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + .flatMap(policyId -> deletePolicyById("", policyId), CONCURRENCY_RIC); // + } else { OscA1Client.UriBuilder uriBuilder = new OscA1Client.UriBuilder(ricConfig); return getPolicyTypeIdentities() // - .flatMapMany(Flux::fromIterable) - .flatMap(type -> post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(type), Optional.empty())) // - .flatMap(JsonHelper::parseJsonArrayOfString); + .flatMapMany(Flux::fromIterable) // + .flatMap(type -> oscDeleteInstancesForType(uriBuilder, type), CONCURRENCY_RIC); } - throw new NullPointerException(UNHANDELED_PROTOCOL + this.protocolType); + } + + private Flux oscGetInstancesForType(OscA1Client.UriBuilder uriBuilder, String type) { + return post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(type), Optional.empty()) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString); + } + + private Flux oscDeleteInstancesForType(OscA1Client.UriBuilder uriBuilder, String type) { + return oscGetInstancesForType(uriBuilder, type) // + .flatMap(instance -> deletePolicyById(type, instance), CONCURRENCY_RIC); } @Override @@ -155,17 +196,19 @@ public class SdncOscA1Client implements A1Client { @Override public Mono getPolicyStatus(Policy policy) { - final String ricUrl = getUriBuilder().createGetPolicyStatusUri(policy.type().name(), policy.id()); - return post("getA1PolicyStatus", ricUrl, Optional.empty()); + return getUriBuilder() // + .flatMap(builder -> { + String ricUrl = builder.createGetPolicyStatusUri(policy.type().name(), policy.id()); + return post("getA1PolicyStatus", ricUrl, Optional.empty()); + }); } - private A1UriBuilder getUriBuilder() { + private Mono getUriBuilder() { if (protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { - return new StdA1ClientVersion1.UriBuilder(ricConfig); - } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { - return new OscA1Client.UriBuilder(ricConfig); + return Mono.just(new StdA1ClientVersion1.UriBuilder(ricConfig)); + } else { + return Mono.just(new OscA1Client.UriBuilder(ricConfig)); } - throw new NullPointerException(UNHANDELED_PROTOCOL + this.protocolType); } private Mono tryOscProtocolVersion() { @@ -185,20 +228,22 @@ public class SdncOscA1Client implements A1Client { StdA1ClientVersion1.UriBuilder uri = new StdA1ClientVersion1.UriBuilder(ricConfig); final String ricUrl = uri.createGetPolicyIdsUri(); return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // - .flatMapMany(JsonHelper::parseJsonArrayOfString); - } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString); + } else { OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); return getPolicyTypeIdentities() // .flatMapMany(Flux::fromIterable) .flatMap(type -> post(GET_POLICY_RPC, uri.createGetPolicyIdsUri(type), Optional.empty())) // - .flatMap(JsonHelper::parseJsonArrayOfString); + .flatMap(SdncJsonHelper::parseJsonArrayOfString); } - throw new NullPointerException(UNHANDELED_PROTOCOL + this.protocolType); } private Mono deletePolicyById(String type, String policyId) { - final String ricUrl = getUriBuilder().createDeleteUri(type, policyId); - return post("deleteA1Policy", ricUrl, Optional.empty()); + return getUriBuilder() // + .flatMap(builder -> { + String ricUrl = builder.createDeleteUri(type, policyId); + return post("deleteA1Policy", ricUrl, Optional.empty()); + }); } private Mono post(String rpcName, String ricUrl, Optional body) { @@ -206,24 +251,34 @@ public class SdncOscA1Client implements A1Client { .nearRtRicUrl(ricUrl) // .body(body) // .build(); - final String inputJsonString = JsonHelper.createInputJsonString(inputParams); + final String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams); + logger.debug("POST inputJsonString = {}", inputJsonString); return restClient - .postWithAuthHeader(controllerUrl(rpcName), inputJsonString, a1ControllerUsername, a1ControllerPassword) + .postWithAuthHeader(controllerUrl(rpcName), inputJsonString, this.controllerConfig.userName(), + this.controllerConfig.password()) // .flatMap(this::extractResponseBody); } - private Mono extractResponseBody(String response) { - AdapterResponse output = gson.fromJson(response, ImmutableAdapterResponse.class); - String body = output.body(); + private Mono extractResponse(JSONObject responseOutput) { + AdapterOutput output = gson.fromJson(responseOutput.toString(), ImmutableAdapterOutput.class); + Optional optionalBody = output.body(); + String body = optionalBody.isPresent() ? optionalBody.get() : ""; if (HttpStatus.valueOf(output.httpStatus()).is2xxSuccessful()) { return Mono.just(body); + } else { + logger.debug("Error response: {} {}", output.httpStatus(), body); + byte[] responseBodyBytes = body.getBytes(StandardCharsets.UTF_8); + WebClientResponseException responseException = new WebClientResponseException(output.httpStatus(), + "statusText", null, responseBodyBytes, StandardCharsets.UTF_8, null); + + return Mono.error(responseException); } - byte[] responseBodyBytes = body.getBytes(StandardCharsets.UTF_8); - WebClientResponseException e = new WebClientResponseException(output.httpStatus(), "statusText", null, - responseBodyBytes, StandardCharsets.UTF_8, null); + } - return Mono.error(e); + private Mono extractResponseBody(String responseStr) { + return SdncJsonHelper.getOutput(responseStr) // + .flatMap(this::extractResponse); } private String controllerUrl(String rpcName) {