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