f54dc2e0dc1e49c72a51d2f0f11a08c07ce76fdf
[ccsdk/oran.git] /
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
32 import reactor.core.publisher.Flux;
33 import reactor.core.publisher.Mono;
34
35 /**
36  * Client for accessing OSC A1 REST API
37  */
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
41
42     public static class UriBuilder implements A1UriBuilder {
43         private final RicConfig ricConfig;
44
45         public UriBuilder(RicConfig ricConfig) {
46             this.ricConfig = ricConfig;
47         }
48
49         @Override
50         public String createPutPolicyUri(String type, String policyId, String notificationDestinationUri) {
51             return createPolicyUri(type, policyId);
52         }
53
54         /**
55          * /a1-p/policytypes/{policy_type_id}/policies
56          */
57         @Override
58         public String createGetPolicyIdsUri(String type) {
59             return createPolicyTypeUri(type) + "/policies";
60         }
61
62         @Override
63         public String createDeleteUri(String type, String policyId) {
64             return createPolicyUri(type, policyId);
65         }
66
67         /**
68          * ​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id}​/status
69          */
70         @Override
71         public String createGetPolicyStatusUri(String type, String policyId) {
72             return createPolicyUri(type, policyId) + "/status";
73         }
74
75         /**
76          * ​/a1-p​/healthcheck
77          */
78         public String createHealtcheckUri() {
79             return baseUri() + "/healthcheck";
80         }
81
82         /**
83          * /a1-p/policytypes/{policy_type_id}
84          */
85         @Override
86         public String createGetSchemaUri(String type) {
87             return this.createPolicyTypeUri(type);
88         }
89
90         /**
91          * ​/a1-p​/policytypes​/{policy_type_id}
92          */
93         @Override
94         public String createPolicyTypesUri() {
95             return baseUri() + "/policytypes";
96         }
97
98         /**
99          * ​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id}
100          */
101         private String createPolicyUri(String type, String id) {
102             return createPolicyTypeUri(type) + "/policies/" + id;
103         }
104
105         /**
106          * /a1-p/policytypes/{policy_type_id}
107          */
108         private String createPolicyTypeUri(String type) {
109             return createPolicyTypesUri() + "/" + type;
110         }
111
112         private String baseUri() {
113             return ricConfig.baseUrl() + "/a1-p";
114         }
115     }
116
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;
121
122     public OscA1Client(RicConfig ricConfig, AsyncRestClientFactory restClientFactory) {
123         this(ricConfig, restClientFactory.createRestClient(""));
124     }
125
126     public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) {
127         this.restClient = restClient;
128         logger.debug("OscA1Client for ric: {}", ricConfig.ricId());
129
130         uri = new UriBuilder(ricConfig);
131     }
132
133     public static Mono<String> extractCreateSchema(String policyTypeResponse, String policyTypeId) {
134         try {
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);
143         }
144     }
145
146     @Override
147     public Mono<List<String>> getPolicyTypeIdentities() {
148         return getPolicyTypeIds() //
149                 .collectList();
150     }
151
152     @Override
153     public Mono<List<String>> getPolicyIdentities() {
154         return getPolicyTypeIds() //
155                 .flatMap(this::getPolicyIdentitiesByType) //
156                 .collectList();
157     }
158
159     @Override
160     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
161         String schemaUri = uri.createGetSchemaUri(policyTypeId);
162         return restClient.get(schemaUri) //
163                 .flatMap(response -> extractCreateSchema(response, policyTypeId));
164     }
165
166     @Override
167     public Mono<String> putPolicy(Policy policy) {
168         String policyUri = this.uri.createPutPolicyUri(policy.type().id(), policy.id(), policy.statusNotificationUri());
169         return restClient.put(policyUri, policy.json());
170     }
171
172     @Override
173     public Mono<String> deletePolicy(Policy policy) {
174         return deletePolicyById(policy.type().id(), policy.id());
175     }
176
177     @Override
178     public Mono<A1ProtocolType> getProtocolVersion() {
179         return restClient.get(uri.createHealtcheckUri()) //
180                 .flatMap(notUsed -> Mono.just(A1ProtocolType.OSC_V1));
181     }
182
183     @Override
184     public Flux<String> deleteAllPolicies() {
185         return getPolicyTypeIds() //
186                 .flatMap(this::deletePoliciesForType, CONCURRENCY_RIC);
187     }
188
189     @Override
190     public Mono<String> getPolicyStatus(Policy policy) {
191         String statusUri = uri.createGetPolicyStatusUri(policy.type().id(), policy.id());
192         return restClient.get(statusUri);
193
194     }
195
196     private Flux<String> getPolicyTypeIds() {
197         return restClient.get(uri.createPolicyTypesUri()) //
198                 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
199     }
200
201     private Flux<String> getPolicyIdentitiesByType(String typeId) {
202         return restClient.get(uri.createGetPolicyIdsUri(typeId)) //
203                 .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
204     }
205
206     private Mono<String> deletePolicyById(String typeId, String policyId) {
207         String policyUri = uri.createDeleteUri(typeId, policyId);
208         return restClient.delete(policyUri);
209     }
210
211     private Flux<String> deletePoliciesForType(String typeId) {
212         return getPolicyIdentitiesByType(typeId) //
213                 .flatMap(policyId -> deletePolicyById(typeId, policyId), CONCURRENCY_RIC);
214     }
215 }