2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.policyagent.clients;
23 import com.google.gson.FieldNamingPolicy;
24 import com.google.gson.GsonBuilder;
26 import java.lang.invoke.MethodHandles;
27 import java.nio.charset.StandardCharsets;
28 import java.util.Arrays;
29 import java.util.List;
30 import java.util.Optional;
32 import org.immutables.value.Value;
33 import org.json.JSONObject;
34 import org.oransc.policyagent.configuration.ControllerConfig;
35 import org.oransc.policyagent.configuration.RicConfig;
36 import org.oransc.policyagent.repository.Policy;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
39 import org.springframework.http.HttpStatus;
40 import org.springframework.web.reactive.function.client.WebClientResponseException;
42 import reactor.core.publisher.Flux;
43 import reactor.core.publisher.Mono;
46 * Client for accessing the A1 adapter in the SDNC controller in OSC.
48 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
49 public class SdncOscA1Client implements A1Client {
52 @org.immutables.gson.Gson.TypeAdapters
53 public interface AdapterRequest {
54 public String nearRtRicUrl();
56 public Optional<String> body();
60 @org.immutables.gson.Gson.TypeAdapters
61 public interface AdapterOutput {
62 public Optional<String> body();
64 public int httpStatus();
67 static com.google.gson.Gson gson = new GsonBuilder() //
68 .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES) //
71 private static final String GET_POLICY_RPC = "getA1Policy";
72 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
73 private final ControllerConfig controllerConfig;
74 private final AsyncRestClient restClient;
75 private final RicConfig ricConfig;
76 private final A1ProtocolType protocolType;
81 * @param protocolType the southbound protocol of the controller. Supported
82 * protocols are SDNC_OSC_STD_V1_1 and SDNC_OSC_OSC_V1
84 * @param controllerBaseUrl the base URL of the SDNC controller
85 * @param username username to accesss the SDNC controller
86 * @param password password to accesss the SDNC controller
88 public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig) {
89 this(protocolType, ricConfig, controllerConfig,
90 new AsyncRestClient(controllerConfig.baseUrl() + "/restconf/operations"));
91 logger.debug("SdncOscA1Client for ric: {}, a1Controller: {}", ricConfig.name(), controllerConfig);
94 public SdncOscA1Client(A1ProtocolType protocolType, RicConfig ricConfig, ControllerConfig controllerConfig,
95 AsyncRestClient restClient) {
96 this.restClient = restClient;
97 this.ricConfig = ricConfig;
98 this.protocolType = protocolType;
99 this.controllerConfig = controllerConfig;
103 public Mono<List<String>> getPolicyTypeIdentities() {
104 if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) {
105 return Mono.just(Arrays.asList(""));
106 } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) {
107 OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig);
108 final String ricUrl = uri.createPolicyTypesUri();
109 return post(GET_POLICY_RPC, ricUrl, Optional.empty()) //
110 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString) //
113 return Mono.error(createIllegalProtocolException());
118 private Exception createIllegalProtocolException() {
119 return new NullPointerException("Bug, unhandeled protocoltype: " + this.protocolType);
123 public Mono<List<String>> getPolicyIdentities() {
124 return getPolicyIds() //
129 public Mono<String> getPolicyTypeSchema(String policyTypeId) {
130 if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) {
131 return Mono.just("{}");
132 } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) {
133 OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig);
134 final String ricUrl = uri.createGetSchemaUri(policyTypeId);
135 return post(GET_POLICY_RPC, ricUrl, Optional.empty());
137 return Mono.error(createIllegalProtocolException());
142 public Mono<String> putPolicy(Policy policy) {
143 return getUriBuilder() //
144 .flatMap(builder -> {
145 String ricUrl = builder.createPutPolicyUri(policy.type().name(), policy.id());
146 return post("putA1Policy", ricUrl, Optional.of(policy.json()));
151 public Mono<String> deletePolicy(Policy policy) {
152 return deletePolicyById(policy.type().name(), policy.id());
156 public Flux<String> deleteAllPolicies() {
157 if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) {
158 return getPolicyIds() //
159 .flatMap(policyId -> deletePolicyById("", policyId)); //
160 } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) {
161 OscA1Client.UriBuilder uriBuilder = new OscA1Client.UriBuilder(ricConfig);
162 return getPolicyTypeIdentities() //
163 .flatMapMany(Flux::fromIterable)
164 .flatMap(type -> post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(type), Optional.empty())) //
165 .flatMap(SdncJsonHelper::parseJsonArrayOfString);
167 return Flux.error(createIllegalProtocolException());
172 public Mono<A1ProtocolType> getProtocolVersion() {
173 return tryStdProtocolVersion() //
174 .onErrorResume(t -> tryOscProtocolVersion());
178 public Mono<String> getPolicyStatus(Policy policy) {
179 return getUriBuilder() //
180 .flatMap(builder -> {
181 String ricUrl = builder.createGetPolicyStatusUri(policy.type().name(), policy.id());
182 return post("getA1PolicyStatus", ricUrl, Optional.empty());
186 private Mono<A1UriBuilder> getUriBuilder() {
187 if (protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) {
188 return Mono.just(new StdA1ClientVersion1.UriBuilder(ricConfig));
189 } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) {
190 return Mono.just(new OscA1Client.UriBuilder(ricConfig));
192 return Mono.error(createIllegalProtocolException());
196 private Mono<A1ProtocolType> tryOscProtocolVersion() {
197 OscA1Client.UriBuilder oscApiuriBuilder = new OscA1Client.UriBuilder(ricConfig);
198 return post(GET_POLICY_RPC, oscApiuriBuilder.createHealtcheckUri(), Optional.empty()) //
199 .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC_OSC_V1));
202 private Mono<A1ProtocolType> tryStdProtocolVersion() {
203 StdA1ClientVersion1.UriBuilder uriBuilder = new StdA1ClientVersion1.UriBuilder(ricConfig);
204 return post(GET_POLICY_RPC, uriBuilder.createGetPolicyIdsUri(), Optional.empty()) //
205 .flatMap(x -> Mono.just(A1ProtocolType.SDNC_OSC_STD_V1_1));
208 private Flux<String> getPolicyIds() {
209 if (this.protocolType == A1ProtocolType.SDNC_OSC_STD_V1_1) {
210 StdA1ClientVersion1.UriBuilder uri = new StdA1ClientVersion1.UriBuilder(ricConfig);
211 final String ricUrl = uri.createGetPolicyIdsUri();
212 return post(GET_POLICY_RPC, ricUrl, Optional.empty()) //
213 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
214 } else if (this.protocolType == A1ProtocolType.SDNC_OSC_OSC_V1) {
215 OscA1Client.UriBuilder uri = new OscA1Client.UriBuilder(ricConfig);
216 return getPolicyTypeIdentities() //
217 .flatMapMany(Flux::fromIterable)
218 .flatMap(type -> post(GET_POLICY_RPC, uri.createGetPolicyIdsUri(type), Optional.empty())) //
219 .flatMap(SdncJsonHelper::parseJsonArrayOfString);
221 return Flux.error(createIllegalProtocolException());
225 private Mono<String> deletePolicyById(String type, String policyId) {
226 return getUriBuilder() //
227 .flatMap(builder -> {
228 String ricUrl = builder.createDeleteUri(type, policyId);
229 return post("deleteA1Policy", ricUrl, Optional.empty());
233 private Mono<String> post(String rpcName, String ricUrl, Optional<String> body) {
234 AdapterRequest inputParams = ImmutableAdapterRequest.builder() //
235 .nearRtRicUrl(ricUrl) //
238 final String inputJsonString = SdncJsonHelper.createInputJsonString(inputParams);
239 logger.debug("POST inputJsonString = {}", inputJsonString);
242 .postWithAuthHeader(controllerUrl(rpcName), inputJsonString, this.controllerConfig.userName(),
243 this.controllerConfig.password()) //
244 .flatMap(this::extractResponseBody);
247 private Mono<String> extractResponse(JSONObject responseOutput) {
248 AdapterOutput output = gson.fromJson(responseOutput.toString(), ImmutableAdapterOutput.class);
249 Optional<String> optionalBody = output.body();
250 String body = optionalBody.isPresent() ? optionalBody.get() : "";
251 if (HttpStatus.valueOf(output.httpStatus()).is2xxSuccessful()) {
252 return Mono.just(body);
254 logger.debug("Error response: {} {}", output.httpStatus(), body);
255 byte[] responseBodyBytes = body.getBytes(StandardCharsets.UTF_8);
256 WebClientResponseException e = new WebClientResponseException(output.httpStatus(), "statusText", null,
257 responseBodyBytes, StandardCharsets.UTF_8, null);
259 return Mono.error(e);
263 private Mono<String> extractResponseBody(String responseStr) {
264 return SdncJsonHelper.getOutput(responseStr) //
265 .flatMap(this::extractResponse);
268 private String controllerUrl(String rpcName) {
269 return "/A1-ADAPTER-API:" + rpcName;