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=d9536a550eb70181b8533b1b65a64a83f2c2dc0b;hb=e2a037745508a3c1ada650ea3571ca57f0a90851;hp=06259c7a6ca709bcf58c942e9500614bfce378c2;hpb=deb5bb7b792ba3ac90e4c622cd804c83e4647b92;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 06259c7a..d9536a55 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 @@ -20,55 +20,103 @@ package org.oransc.policyagent.clients; +import com.google.gson.FieldNamingPolicy; +import com.google.gson.GsonBuilder; + import java.lang.invoke.MethodHandles; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; 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.repository.Policy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.http.HttpStatus; +import org.springframework.web.reactive.function.client.WebClientResponseException; 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 { - private static final String URL_PREFIX = "/A1-ADAPTER-API:"; - private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + @Value.Immutable + @org.immutables.gson.Gson.TypeAdapters + public interface AdapterRequest { + public String nearRtRicUrl(); - private final String a1ControllerUsername; - private final String a1ControllerPassword; - private final RicConfig ricConfig; + public Optional body(); + } + + @Value.Immutable + @org.immutables.gson.Gson.TypeAdapters + public interface AdapterOutput { + public Optional body(); + + public int httpStatus(); + } + + static com.google.gson.Gson gson = new GsonBuilder() // + .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) // + .create(); // + + private static final String GET_POLICY_RPC = "getA1Policy"; + private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final ControllerConfig controllerConfig; private final AsyncRestClient restClient; + private final RicConfig ricConfig; + private final A1ProtocolType protocolType; - public SdncOscA1Client(RicConfig ricConfig, String baseUrl, String username, String password) { - this(ricConfig, username, password, new AsyncRestClient(baseUrl + "/restconf/operations")); - if (logger.isDebugEnabled()) { - logger.debug("SdncOscA1Client for ric: {}, a1ControllerBaseUrl: {}", ricConfig.name(), baseUrl); - } + /** + * Constructor + * + * @param protocolType the southbound protocol of the controller. Supported + * protocols are SDNC_OSC_STD_V1_1 and SDNC_OSC_OSC_V1 + * @param ricConfig + * @param controllerBaseUrl the base URL of the SDNC controller + * @param username username to accesss the SDNC controller + * @param password password to accesss the SDNC controller + */ + public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig) { + this(protocolType, ricConfig, controllerConfig, + new AsyncRestClient(controllerConfig.baseUrl() + "/restconf/operations")); + logger.debug("SdncOscA1Client for ric: {}, a1Controller: {}", ricConfig.name(), controllerConfig); } - public SdncOscA1Client(RicConfig ricConfig, String username, String password, AsyncRestClient restClient) { - this.ricConfig = ricConfig; - this.a1ControllerUsername = username; - this.a1ControllerPassword = password; + public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig, + AsyncRestClient restClient) { this.restClient = restClient; + this.ricConfig = ricConfig; + this.protocolType = protocolType; + this.controllerConfig = controllerConfig; } @Override public Mono> getPolicyTypeIdentities() { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // - .build(); - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST getPolicyTypeIdentities inputJsonString = {}", inputJsonString); + if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { + return Mono.just(Arrays.asList("")); + } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); + final String ricUrl = uri.createPolicyTypesUri(); + return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString) // + .collectList(); + } else { + return Mono.error(createIllegalProtocolException()); + } - return restClient - .postWithAuthHeader(URL_PREFIX + "getPolicyTypeIdentities", inputJsonString, a1ControllerUsername, - a1ControllerPassword) // - .flatMap(response -> JsonHelper.getValueFromResponse(response, "policy-type-id-list")) // - .flatMapMany(JsonHelper::parseJsonArrayOfString) // - .collectList(); + } + + private Exception createIllegalProtocolException() { + return new NullPointerException("Bug, unhandeled protocoltype: " + this.protocolType); } @Override @@ -79,93 +127,146 @@ public class SdncOscA1Client implements A1Client { @Override public Mono getPolicyTypeSchema(String policyTypeId) { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // - .policyTypeId(policyTypeId) // - .build(); - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST getPolicyType inputJsonString = {}", inputJsonString); - - return restClient - .postWithAuthHeader(URL_PREFIX + "getPolicyType", inputJsonString, a1ControllerUsername, - a1ControllerPassword) // - .flatMap(response -> JsonHelper.getValueFromResponse(response, "policy-type")) // - .flatMap(JsonHelper::extractPolicySchema); + if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { + return Mono.just("{}"); + } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); + final String ricUrl = uri.createGetSchemaUri(policyTypeId); + return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // + .flatMap(response -> SdncJsonHelper.getCreateSchema(response, policyTypeId)); + } else { + return Mono.error(createIllegalProtocolException()); + } } @Override public Mono putPolicy(Policy policy) { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // - .policyTypeId(policy.type().name()) // - .policyId(policy.id()) // - .policy(policy.json()) // - .build(); - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST putPolicy inputJsonString = {}", inputJsonString); - - return restClient - .postWithAuthHeader(URL_PREFIX + "putPolicy", inputJsonString, a1ControllerUsername, a1ControllerPassword) - .flatMap(response -> JsonHelper.getValueFromResponse(response, "returned-policy")) // - .flatMap(JsonHelper::validateJson); + return getUriBuilder() // + .flatMap(builder -> { + String ricUrl = builder.createPutPolicyUri(policy.type().name(), policy.id()); + return post("putA1Policy", ricUrl, Optional.of(policy.json())); + }); } @Override public Mono deletePolicy(Policy policy) { - return deletePolicyById(policy.id()); + return deletePolicyById(policy.type().name(), policy.id()); } @Override public Flux deleteAllPolicies() { - return getPolicyIds() // - .flatMap(this::deletePolicyById); // + if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { + return getPolicyIds() // + .flatMap(policyId -> deletePolicyById("", policyId)); // + } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + OscA1Client.UriBuilder uriBuilder = new OscA1Client.UriBuilder(ricConfig); + return getPolicyTypeIdentities() // + .flatMapMany(Flux::fromIterable) + .flatMap(type -> post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(type), Optional.empty())) // + .flatMap(SdncJsonHelper::parseJsonArrayOfString); + } else { + return Flux.error(createIllegalProtocolException()); + } } @Override public Mono getProtocolVersion() { - return getPolicyTypeIdentities() // - .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC)); + return tryStdProtocolVersion() // + .onErrorResume(t -> tryOscProtocolVersion()); } @Override public Mono getPolicyStatus(Policy policy) { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // - .policyId(policy.id()) // - .build(); - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST getPolicyStatus inputJsonString = {}", inputJsonString); + return getUriBuilder() // + .flatMap(builder -> { + String ricUrl = builder.createGetPolicyStatusUri(policy.type().name(), policy.id()); + return post("getA1PolicyStatus", ricUrl, Optional.empty()); + }); + } - return restClient - .postWithAuthHeader(URL_PREFIX + "getPolicyStatus", inputJsonString, a1ControllerUsername, - a1ControllerPassword) // - .flatMap(response -> JsonHelper.getValueFromResponse(response, "policy-status")); + private Mono getUriBuilder() { + if (protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { + return Mono.just(new StdA1ClientVersion1.UriBuilder(ricConfig)); + } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + return Mono.just(new OscA1Client.UriBuilder(ricConfig)); + } else { + return Mono.error(createIllegalProtocolException()); + } + } + + private Mono tryOscProtocolVersion() { + OscA1Client.UriBuilder oscApiuriBuilder = new OscA1Client.UriBuilder(ricConfig); + return post(GET_POLICY_RPC, oscApiuriBuilder.createHealtcheckUri(), Optional.empty()) // + .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC_OSC_V1)); + } + + private Mono tryStdProtocolVersion() { + StdA1ClientVersion1.UriBuilder uriBuilder = new StdA1ClientVersion1.UriBuilder(ricConfig); + return post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(), Optional.empty()) // + .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC_STD_V1_1)); } private Flux getPolicyIds() { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // + if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) { + StdA1ClientVersion1.UriBuilder uri = new StdA1ClientVersion1.UriBuilder(ricConfig); + final String ricUrl = uri.createGetPolicyIdsUri(); + return post(GET_POLICY_RPC, ricUrl, Optional.empty()) // + .flatMapMany(SdncJsonHelper::parseJsonArrayOfString); + } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) { + OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig); + return getPolicyTypeIdentities() // + .flatMapMany(Flux::fromIterable) + .flatMap(type -> post(GET_POLICY_RPC, uri.createGetPolicyIdsUri(type), Optional.empty())) // + .flatMap(SdncJsonHelper::parseJsonArrayOfString); + } else { + return Flux.error(createIllegalProtocolException()); + } + } + + private Mono deletePolicyById(String type, String policyId) { + 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) { + AdapterRequest inputParams = ImmutableAdapterRequest.builder() // + .nearRtRicUrl(ricUrl) // + .body(body) // .build(); - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST getPolicyIdentities inputJsonString = {}", inputJsonString); + final String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams); + logger.debug("POST inputJsonString = {}", inputJsonString); return restClient - .postWithAuthHeader(URL_PREFIX + "getPolicyIdentities", inputJsonString, a1ControllerUsername, - a1ControllerPassword) // - .flatMap(response -> JsonHelper.getValueFromResponse(response, "policy-id-list")) // - .flatMapMany(JsonHelper::parseJsonArrayOfString); + .postWithAuthHeader(controllerUrl(rpcName), inputJsonString, this.controllerConfig.userName(), + this.controllerConfig.password()) // + .flatMap(this::extractResponseBody); } - private Mono deletePolicyById(String policyId) { - SdncOscAdapterInput inputParams = ImmutableSdncOscAdapterInput.builder() // - .nearRtRicUrl(ricConfig.baseUrl()) // - .policyId(policyId) // - .build(); + 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 e = new WebClientResponseException(output.httpStatus(), "statusText", null, + responseBodyBytes, StandardCharsets.UTF_8, null); + + return Mono.error(e); + } + } - String inputJsonString = JsonHelper.createInputJsonString(inputParams); - logger.debug("POST deletePolicy inputJsonString = {}", inputJsonString); + private Mono extractResponseBody(String responseStr) { + return SdncJsonHelper.getOutput(responseStr) // + .flatMap(this::extractResponse); + } - return restClient.postWithAuthHeader(URL_PREFIX + "deletePolicy", inputJsonString, a1ControllerUsername, - a1ControllerPassword); + private String controllerUrl(String rpcName) { + return "/A1-ADAPTER-API:" + rpcName; } }