2  * ========================LICENSE_START=================================
 
   4  * ======================================================================
 
   5  * Copyright (C) 2020 Nordix Foundation. All rights reserved.
 
   6  * ======================================================================
 
   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.onap.ccsdk.oran.a1policymanagementservice.clients;
 
  23 import java.lang.invoke.MethodHandles;
 
  24 import java.util.List;
 
  26 import org.json.JSONObject;
 
  27 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
 
  28 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
 
  29 import org.slf4j.Logger;
 
  30 import org.slf4j.LoggerFactory;
 
  32 import reactor.core.publisher.Flux;
 
  33 import reactor.core.publisher.Mono;
 
  36  * Client for accessing OSC A1 REST API
 
  38 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
 
  39 public class OscA1Client implements A1Client {
 
  40     static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
 
  42     public static class UriBuilder implements A1UriBuilder {
 
  43         private final RicConfig ricConfig;
 
  45         public UriBuilder(RicConfig ricConfig) {
 
  46             this.ricConfig = ricConfig;
 
  50         public String createPutPolicyUri(String type, String policyId, String notificationDestinationUri) {
 
  51             return createPolicyUri(type, policyId);
 
  55          * /a1-p/policytypes/{policy_type_id}/policies
 
  58         public String createGetPolicyIdsUri(String type) {
 
  59             return createPolicyTypeUri(type) + "/policies";
 
  63         public String createDeleteUri(String type, String policyId) {
 
  64             return createPolicyUri(type, policyId);
 
  68          * /a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status
 
  71         public String createGetPolicyStatusUri(String type, String policyId) {
 
  72             return createPolicyUri(type, policyId) + "/status";
 
  78         public String createHealtcheckUri() {
 
  79             return baseUri() + "/healthcheck";
 
  83          * /a1-p/policytypes/{policy_type_id}
 
  86         public String createGetSchemaUri(String type) {
 
  87             return this.createPolicyTypeUri(type);
 
  91          * /a1-p/policytypes/{policy_type_id}
 
  94         public String createPolicyTypesUri() {
 
  95             return baseUri() + "/policytypes";
 
  99          * /a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}
 
 101         private String createPolicyUri(String type, String id) {
 
 102             return createPolicyTypeUri(type) + "/policies/" + id;
 
 106          * /a1-p/policytypes/{policy_type_id}
 
 108         private String createPolicyTypeUri(String type) {
 
 109             return createPolicyTypesUri() + "/" + type;
 
 112         private String baseUri() {
 
 113             return ricConfig.baseUrl() + "/a1-p";
 
 117     private static final String TITLE = "title";
 
 118     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
 119     private final AsyncRestClient restClient;
 
 120     private final UriBuilder uri;
 
 122     public OscA1Client(RicConfig ricConfig, AsyncRestClientFactory restClientFactory) {
 
 123         this(ricConfig, restClientFactory.createRestClient(""));
 
 126     public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) {
 
 127         this.restClient = restClient;
 
 128         logger.debug("OscA1Client for ric: {}", ricConfig.ricId());
 
 130         uri = new UriBuilder(ricConfig);
 
 133     public static Mono<String> extractCreateSchema(String policyTypeResponse, String policyTypeId) {
 
 135             JSONObject obj = new JSONObject(policyTypeResponse);
 
 136             JSONObject schemaObj = obj.getJSONObject("create_schema");
 
 137             schemaObj.put(TITLE, policyTypeId);
 
 138             return Mono.just(schemaObj.toString());
 
 139         } catch (Exception e) {
 
 140             String exceptionString = e.toString();
 
 141             logger.error("Unexpected response for policy type: {}, exception: {}", policyTypeResponse, exceptionString);
 
 142             return Mono.error(e);
 
 147     public Mono<List<String>> getPolicyTypeIdentities() {
 
 148         return getPolicyTypeIds() //
 
 153     public Mono<List<String>> getPolicyIdentities() {
 
 154         return getPolicyTypeIds() //
 
 155                 .flatMap(this::getPolicyIdentitiesByType) //
 
 160     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 
 161         String schemaUri = uri.createGetSchemaUri(policyTypeId);
 
 162         return restClient.get(schemaUri) //
 
 163                 .flatMap(response -> extractCreateSchema(response, policyTypeId));
 
 167     public Mono<String> putPolicy(Policy policy) {
 
 168         String policyUri = this.uri.createPutPolicyUri(policy.getType().getId(), policy.getId(),
 
 169                 policy.getStatusNotificationUri());
 
 170         return restClient.put(policyUri, policy.getJson());
 
 174     public Mono<String> deletePolicy(Policy policy) {
 
 175         return deletePolicyById(policy.getType().getId(), policy.getId());
 
 179     public Mono<A1ProtocolType> getProtocolVersion() {
 
 180         return restClient.get(uri.createHealtcheckUri()) //
 
 181                 .flatMap(notUsed -> Mono.just(A1ProtocolType.OSC_V1));
 
 185     public Flux<String> deleteAllPolicies() {
 
 186         return getPolicyTypeIds() //
 
 187                 .flatMap(this::deletePoliciesForType, CONCURRENCY_RIC);
 
 191     public Mono<String> getPolicyStatus(Policy policy) {
 
 192         String statusUri = uri.createGetPolicyStatusUri(policy.getType().getId(), policy.getId());
 
 193         return restClient.get(statusUri);
 
 197     private Flux<String> getPolicyTypeIds() {
 
 198         return restClient.get(uri.createPolicyTypesUri()) //
 
 199                 .flatMapMany(A1AdapterJsonHelper::parseJsonArrayOfString);
 
 202     private Flux<String> getPolicyIdentitiesByType(String typeId) {
 
 203         return restClient.get(uri.createGetPolicyIdsUri(typeId)) //
 
 204                 .flatMapMany(A1AdapterJsonHelper::parseJsonArrayOfString);
 
 207     private Mono<String> deletePolicyById(String typeId, String policyId) {
 
 208         String policyUri = uri.createDeleteUri(typeId, policyId);
 
 209         return restClient.delete(policyUri);
 
 212     private Flux<String> deletePoliciesForType(String typeId) {
 
 213         return getPolicyIdentitiesByType(typeId) //
 
 214                 .flatMap(policyId -> deletePolicyById(typeId, policyId), CONCURRENCY_RIC);