gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2020-2023 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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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===================================
  19  */
  20
  21 package org.onap.ccsdk.oran.a1policymanagementservice.clients;
  22
  23 import java.lang.invoke.MethodHandles;
  24 import java.util.List;
  25 import java.util.Set;
  26
  27 import org.json.JSONObject;
  28 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  29 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 import reactor.core.publisher.Flux;
  34 import reactor.core.publisher.Mono;
  35
  36 /**
  37  * Client for accessing OSC A1 REST API
  38  */
  39 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  40 public class OscA1Client implements A1Client {
  41     static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
  42
  43     public static class UriBuilder implements A1UriBuilder {
  44         private final RicConfig ricConfig;
  45
  46         public UriBuilder(RicConfig ricConfig) {
  47             this.ricConfig = ricConfig;
  48         }
  49
  50         @Override
  51         public String createPutPolicyUri(String type, String policyId, String notificationDestinationUri) {
  52             return createPolicyUri(type, policyId);
  53         }
  54
  55         /**
  56          * /a1-p/policytypes/{policy_type_id}/policies
  57          */
  58         @Override
  59         public String createGetPolicyIdsUri(String type) {
  60             return createPolicyTypeUri(type) + "/policies";
  61         }
  62
  63         @Override
  64         public String createDeleteUri(String type, String policyId) {
  65             return createPolicyUri(type, policyId);
  66         }
  67
  68         /**
  69          * /a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status
  70          */
  71         @Override
  72         public String createGetPolicyStatusUri(String type, String policyId) {
  73             return createPolicyUri(type, policyId) + "/status";
  74         }
  75
  76         /**
  77          * /a1-p/healthcheck
  78          */
  79         public String createHealtcheckUri() {
  80             return baseUri() + "/healthcheck";
  81         }
  82
  83         /**
  84          * /a1-p/policytypes/{policy_type_id}
  85          */
  86         @Override
  87         public String createGetSchemaUri(String type) {
  88             return this.createPolicyTypeUri(type);
  89         }
  90
  91         /**
  92          * /a1-p/policytypes/{policy_type_id}
  93          */
  94         @Override
  95         public String createPolicyTypesUri() {
  96             return baseUri() + "/policytypes";
  97         }
  98
  99         /**
 100          * /a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}
 101          */
 102         private String createPolicyUri(String type, String id) {
 103             return createPolicyTypeUri(type) + "/policies/" + id;
 104         }
 105
 106         /**
 107          * /a1-p/policytypes/{policy_type_id}
 108          */
 109         private String createPolicyTypeUri(String type) {
 110             return createPolicyTypesUri() + "/" + type;
 111         }
 112
 113         private String baseUri() {
 114             return ricConfig.getBaseUrl() + "/a1-p";
 115         }
 116     }
 117
 118     private static final String TITLE = "title";
 119     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 120     private final AsyncRestClient restClient;
 121     private final UriBuilder uri;
 122
 123     public OscA1Client(RicConfig ricConfig, AsyncRestClientFactory restClientFactory) {
 124         this(ricConfig, restClientFactory.createRestClientUseHttpProxy(""));
 125     }
 126
 127     public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) {
 128         this.restClient = restClient;
 129         logger.debug("OscA1Client for ric: {}", ricConfig.getRicId());
 130
 131         uri = new UriBuilder(ricConfig);
 132     }
 133
 134     public static Mono<String> extractCreateSchema(String policyTypeResponse, String policyTypeId) {
 135         try {
 136             JSONObject obj = new JSONObject(policyTypeResponse);
 137             JSONObject schemaObj = obj.getJSONObject("create_schema");
 138             schemaObj.put(TITLE, policyTypeId);
 139             return Mono.just(schemaObj.toString());
 140         } catch (Exception e) {
 141             String exceptionString = e.toString();
 142             logger.error("Unexpected response for policy type: {}, exception: {}", policyTypeResponse, exceptionString);
 143             return Mono.error(e);
 144         }
 145     }
 146
 147     @Override
 148     public Mono<List<String>> getPolicyTypeIdentities() {
 149         return getPolicyTypeIds() //
 150                 .collectList();
 151     }
 152
 153     @Override
 154     public Mono<List<String>> getPolicyIdentities() {
 155         return getPolicyTypeIds() //
 156                 .flatMap(this::getPolicyIdentitiesByType) //
 157                 .collectList();
 158     }
 159
 160     @Override
 161     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 162         String schemaUri = uri.createGetSchemaUri(policyTypeId);
 163         return restClient.get(schemaUri) //
 164                 .flatMap(response -> extractCreateSchema(response, policyTypeId));
 165     }
 166
 167     @Override
 168     public Mono<String> putPolicy(Policy policy) {
 169         String policyUri = this.uri.createPutPolicyUri(policy.getType().getId(), policy.getId(),
 170                 policy.getStatusNotificationUri());
 171         return restClient.put(policyUri, policy.getJson());
 172     }
 173
 174     @Override
 175     public Mono<String> deletePolicy(Policy policy) {
 176         return deletePolicyById(policy.getType().getId(), policy.getId());
 177     }
 178
 179     @Override
 180     public Mono<A1ProtocolType> getProtocolVersion() {
 181         return restClient.get(uri.createHealtcheckUri()) //
 182                 .flatMap(notUsed -> Mono.just(A1ProtocolType.OSC_V1));
 183     }
 184
 185     @Override
 186     public Flux<String> deleteAllPolicies(Set<String> excludePolicyIds) {
 187         return getPolicyTypeIds() //
 188                 .flatMap(typeId -> deletePoliciesForType(typeId, excludePolicyIds), CONCURRENCY_RIC);
 189     }
 190
 191     @Override
 192     public Mono<String> getPolicyStatus(Policy policy) {
 193         String statusUri = uri.createGetPolicyStatusUri(policy.getType().getId(), policy.getId());
 194         return restClient.get(statusUri);
 195
 196     }
 197
 198     private Flux<String> getPolicyTypeIds() {
 199         return restClient.get(uri.createPolicyTypesUri()) //
 200                 .flatMapMany(A1AdapterJsonHelper::parseJsonArrayOfString);
 201     }
 202
 203     private Flux<String> getPolicyIdentitiesByType(String typeId) {
 204         return restClient.get(uri.createGetPolicyIdsUri(typeId)) //
 205                 .flatMapMany(A1AdapterJsonHelper::parseJsonArrayOfString);
 206     }
 207
 208     private Mono<String> deletePolicyById(String typeId, String policyId) {
 209         String policyUri = uri.createDeleteUri(typeId, policyId);
 210         return restClient.delete(policyUri);
 211     }
 212
 213     private Flux<String> deletePoliciesForType(String typeId, Set<String> excludePolicyIds) {
 214         return getPolicyIdentitiesByType(typeId) //
 215                 .filter(policyId -> !excludePolicyIds.contains(policyId)) //
 216                 .flatMap(policyId -> deletePolicyById(typeId, policyId), CONCURRENCY_RIC);
 217     }
 218 }