policy-agent/src/main/java/org/oransc/policyagent/clients/OscA1Client.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2020 Nordix Foundation
   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.oransc.policyagent.clients;
  22
  23 import java.lang.invoke.MethodHandles;
  24 import java.util.List;
  25
  26 import org.json.JSONObject;
  27 import org.oransc.policyagent.configuration.RicConfig;
  28 import org.oransc.policyagent.repository.Policy;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 import reactor.core.publisher.Flux;
  33 import reactor.core.publisher.Mono;
  34
  35 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  36 public class OscA1Client implements A1Client {
  37
  38     public static class UriBuilder implements A1UriBuilder {
  39         private final RicConfig ricConfig;
  40
  41         public UriBuilder(RicConfig ricConfig) {
  42             this.ricConfig = ricConfig;
  43         }
  44
  45         @Override
  46         public String createPutPolicyUri(String type, String policyId) {
  47             return createPolicyUri(type, policyId);
  48         }
  49
  50         public String createGetPolicyIdsUri(String type) {
  51             return createPolicyTypeUri(type) + "/policies";
  52         }
  53
  54         @Override
  55         public String createDeleteUri(String type, String policyId) {
  56             return createPolicyUri(type, policyId);
  57         }
  58
  59         @Override
  60         public String createGetPolicyStatusUri(String type, String policyId) {
  61             return createPolicyUri(type, policyId) + "/status";
  62         }
  63
  64         public String createHealtcheckUri() {
  65             return baseUri() + "/healthcheck";
  66         }
  67
  68         public String createGetSchemaUri(String type) {
  69             return this.createPolicyTypeUri(type);
  70         }
  71
  72         public String createPolicyTypesUri() {
  73             return baseUri() + "/policytypes";
  74         }
  75
  76         private String createPolicyUri(String type, String id) {
  77             return createPolicyTypeUri(type) + "/policies/" + id;
  78         }
  79
  80         private String createPolicyTypeUri(String type) {
  81             return createPolicyTypesUri() + "/" + type;
  82         }
  83
  84         private String baseUri() {
  85             return ricConfig.baseUrl() + "/a1-p";
  86         }
  87     }
  88
  89     private static final String TITLE = "title";
  90     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  91     private final AsyncRestClient restClient;
  92     private final UriBuilder uri;
  93
  94     public OscA1Client(RicConfig ricConfig) {
  95         this(ricConfig, new AsyncRestClient(""));
  96     }
  97
  98     public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) {
  99         this.restClient = restClient;
 100         logger.debug("OscA1Client for ric: {}", ricConfig.name());
 101
 102         uri = new UriBuilder(ricConfig);
 103     }
 104
 105     @Override
 106     public Mono<List<String>> getPolicyTypeIdentities() {
 107         return getPolicyTypeIds() //
 108             .collectList();
 109     }
 110
 111     @Override
 112     public Mono<List<String>> getPolicyIdentities() {
 113         return getPolicyTypeIds() //
 114             .flatMap(this::getPolicyIdentitiesByType) //
 115             .collectList();
 116     }
 117
 118     @Override
 119     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
 120         String schemaUri = uri.createGetSchemaUri(policyTypeId);
 121         return restClient.get(schemaUri) //
 122             .flatMap(response -> getCreateSchema(response, policyTypeId));
 123     }
 124
 125     @Override
 126     public Mono<String> putPolicy(Policy policy) {
 127         String policyUri = this.uri.createPutPolicyUri(policy.type().name(), policy.id());
 128         return restClient.put(policyUri, policy.json());
 129     }
 130
 131     @Override
 132     public Mono<String> deletePolicy(Policy policy) {
 133         return deletePolicyById(policy.type().name(), policy.id());
 134     }
 135
 136     @Override
 137     public Mono<A1ProtocolType> getProtocolVersion() {
 138         return restClient.get(uri.createHealtcheckUri()) //
 139             .flatMap(notUsed -> Mono.just(A1ProtocolType.OSC_V1));
 140     }
 141
 142     @Override
 143     public Flux<String> deleteAllPolicies() {
 144         return getPolicyTypeIds() //
 145             .flatMap(this::deletePoliciesForType);
 146     }
 147
 148     @Override
 149     public Mono<String> getPolicyStatus(Policy policy) {
 150         String statusUri = uri.createGetPolicyStatusUri(policy.type().name(), policy.id());
 151         return restClient.get(statusUri);
 152
 153     }
 154
 155     private Flux<String> getPolicyTypeIds() {
 156         return restClient.get(uri.createPolicyTypesUri()) //
 157             .flatMapMany(JsonHelper::parseJsonArrayOfString);
 158     }
 159
 160     private Flux<String> getPolicyIdentitiesByType(String typeId) {
 161         return restClient.get(uri.createGetPolicyIdsUri(typeId)) //
 162             .flatMapMany(JsonHelper::parseJsonArrayOfString);
 163     }
 164
 165     private Mono<String> getCreateSchema(String policyTypeResponse, String policyTypeId) {
 166         try {
 167             JSONObject obj = new JSONObject(policyTypeResponse);
 168             JSONObject schemaObj = obj.getJSONObject("create_schema");
 169             schemaObj.put(TITLE, policyTypeId);
 170             return Mono.just(schemaObj.toString());
 171         } catch (Exception e) {
 172             String exceptionString = e.toString();
 173             logger.error("Unexpected response for policy type: {}, exception: {}", policyTypeResponse, exceptionString);
 174             return Mono.error(e);
 175         }
 176     }
 177
 178     private Mono<String> deletePolicyById(String typeId, String policyId) {
 179         String policyUri = uri.createDeleteUri(typeId, policyId);
 180         return restClient.delete(policyUri);
 181     }
 182
 183     private Flux<String> deletePoliciesForType(String typeId) {
 184         return getPolicyIdentitiesByType(typeId) //
 185             .flatMap(policyId -> deletePolicyById(typeId, policyId));
 186     }
 187 }