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

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   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
  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
  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;
  31 import org.springframework.web.util.DefaultUriBuilderFactory;
  32 import org.springframework.web.util.UriBuilderFactory;
  33
  34 import reactor.core.publisher.Flux;
  35 import reactor.core.publisher.Mono;
  36
  37 /**
  38  * Client for accessing ORAN A1-P Vesion 2.0 REST API
  39  */
  40 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  41 public class StdA1ClientVersion2 implements A1Client {
  42     static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
  43
  44     public static class OranV2UriBuilder implements A1UriBuilder {
  45         private final RicConfig ricConfig;
  46
  47         public OranV2UriBuilder(RicConfig ricConfig) {
  48             this.ricConfig = ricConfig;
  49         }
  50
  51         @Override
  52         public String createPutPolicyUri(String type, String policyId, String statusNotificationUri) {
  53             String policyUri = createPolicyUri(type, policyId);
  54             if (statusNotificationUri.isEmpty()) {
  55                 return policyUri;
  56             }
  57             UriBuilderFactory builderFactory = new DefaultUriBuilderFactory(policyUri);
  58             return builderFactory.builder() //
  59                     .queryParam("notificationDestination", statusNotificationUri) //
  60                     .build() //
  61                     .normalize() //
  62                     .toASCIIString();
  63         }
  64
  65         /**
  66          * /A1-P/v2/policytypes/{policy_type_id}/policies
  67          */
  68         @Override
  69         public String createGetPolicyIdsUri(String type) {
  70             return createPolicyTypeUri(type) + "/policies";
  71         }
  72
  73         @Override
  74         public String createDeleteUri(String type, String policyId) {
  75             return createPolicyUri(type, policyId);
  76         }
  77
  78         /**
  79          * /A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}/status
  80          */
  81         @Override
  82         public String createGetPolicyStatusUri(String type, String policyId) {
  83             return createPolicyUri(type, policyId) + "/status";
  84         }
  85
  86         /**
  87          * /A1-P/v2/policytypes/{policy_type_id}
  88          */
  89         @Override
  90         public String createGetSchemaUri(String type) {
  91             return this.createPolicyTypeUri(type);
  92         }
  93
  94         /**
  95          * /A1-P/v2/policytypes/{policy_type_id}
  96          */
  97         @Override
  98         public String createPolicyTypesUri() {
  99             return baseUri() + "/policytypes";
 100         }
 101
 102         /**
 103          * /A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}
 104          */
 105         private String createPolicyUri(String type, String id) {
 106             return createPolicyTypeUri(type) + "/policies/" + id;
 107         }
 108
 109         /**
 110          * /A1-P/v2/policytypes/{policy_type_id}
 111          */
 112         private String createPolicyTypeUri(String type) {
 113             return createPolicyTypesUri() + "/" + type;
 114         }
 115
 116         private String baseUri() {
 117             return ricConfig.baseUrl() + "/A1-P/v2";
 118         }
 119     }
 120
 121     private static final String TITLE = "title";
 122     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 123     private final AsyncRestClient restClient;
 124     private final OranV2UriBuilder uriBuiler;
 125
 126     public StdA1ClientVersion2(RicConfig ricConfig, AsyncRestClientFactory restClientFactory) {
 127         this(ricConfig, restClientFactory.createRestClient(""));
 128     }
 129
 130     public StdA1ClientVersion2(RicConfig ricConfig, AsyncRestClient restClient) {
 131         this.restClient = restClient;
 132         logger.debug("OscA1Client for ric: {}", ricConfig.ricId());
 133
 134         uriBuiler = new OranV2UriBuilder(ricConfig);
 135     }
 136
 137     public static Mono<String> extractPolicySchema(String policyTypeResponse, String policyTypeId) {
 138         try {
 139             JSONObject obj = new JSONObject(policyTypeResponse);
 140             JSONObject schemaObj = obj.getJSONObject("policySchema");
 141             schemaObj.put(TITLE, policyTypeId);
 142             return Mono.just(schemaObj.toString());
 143         } catch (Exception e) {
 144             String exceptionString = e.toString();
 145             logger.error("Unexpected response for policy type: {}, exception: {}", policyTypeResponse, exceptionString);
 146             return Mono.error(e);
 147         }
 148     }
 149
 150     @Override
 151     public Mono<List<String>> getPolicyTypeIdentities() {
 152         return getPolicyTypeIds() //
 153                 .collectList();
 154     }
 155
 156     @Override
 157     public Mono<List<String>> getPolicyIdentities() {
 158         return getPolicyTypeIds() //
 159                 .flatMap(this::getPolicyIdentitiesByType) //
 160                 .collectList();
 161     }
 162
 163     @Override
 164     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 165         String schemaUri = uriBuiler.createGetSchemaUri(policyTypeId);
 166         return restClient.get(schemaUri) //
 167                 .flatMap(response -> extractPolicySchema(response, policyTypeId));
 168     }
 169
 170     @Override
 171     public Mono<String> putPolicy(Policy policy) {
 172         String policyUri =
 173                 this.uriBuiler.createPutPolicyUri(policy.type().id(), policy.id(), policy.statusNotificationUri());
 174         return restClient.put(policyUri, policy.json());
 175     }
 176
 177     @Override
 178     public Mono<String> deletePolicy(Policy policy) {
 179         return deletePolicyById(policy.type().id(), policy.id());
 180     }
 181
 182     @Override
 183     public Mono<A1ProtocolType> getProtocolVersion() {
 184         return restClient.get(uriBuiler.createPolicyTypesUri()) //
 185                 .flatMap(notUsed -> Mono.just(A1ProtocolType.STD_V2_0_0));
 186     }
 187
 188     @Override
 189     public Flux<String> deleteAllPolicies() {
 190         return getPolicyTypeIds() //
 191                 .flatMap(this::deletePoliciesForType, CONCURRENCY_RIC);
 192     }
 193
 194     @Override
 195     public Mono<String> getPolicyStatus(Policy policy) {
 196         String statusUri = uriBuiler.createGetPolicyStatusUri(policy.type().id(), policy.id());
 197         return restClient.get(statusUri);
 198
 199     }
 200
 201     private Flux<String> getPolicyTypeIds() {
 202         return restClient.get(uriBuiler.createPolicyTypesUri()) //
 203                 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
 204     }
 205
 206     private Flux<String> getPolicyIdentitiesByType(String typeId) {
 207         return restClient.get(uriBuiler.createGetPolicyIdsUri(typeId)) //
 208                 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
 209     }
 210
 211     private Mono<String> deletePolicyById(String typeId, String policyId) {
 212         String policyUri = uriBuiler.createDeleteUri(typeId, policyId);
 213         return restClient.delete(policyUri);
 214     }
 215
 216     private Flux<String> deletePoliciesForType(String typeId) {
 217         return getPolicyIdentitiesByType(typeId) //
 218                 .flatMap(policyId -> deletePolicyById(typeId, policyId), CONCURRENCY_RIC);
 219     }
 220 }