Improved java class documentation
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / clients / StdA1ClientVersion1.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 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.util.Arrays;
24 import java.util.List;
25
26 import org.oransc.policyagent.configuration.RicConfig;
27 import org.oransc.policyagent.repository.Policy;
28
29 import reactor.core.publisher.Flux;
30 import reactor.core.publisher.Mono;
31
32 /**
33  * Client for accessing standard A1 REST API version 1.1
34  */
35 public class StdA1ClientVersion1 implements A1Client {
36
37     public static class UriBuilder implements A1UriBuilder {
38
39         private final RicConfig ricConfig;
40
41         public UriBuilder(RicConfig ricConfig) {
42             this.ricConfig = ricConfig;
43         }
44
45         /**
46          * /A1-P/v1/policies/{policyId}
47          */
48         @Override
49         public String createPutPolicyUri(String type, String policyId) {
50             return policiesBaseUri() + policyId;
51         }
52
53         /**
54          * /A1-P/v1/policies
55          */
56         public String createGetPolicyIdsUri() {
57             return baseUri() + "/policies";
58         }
59
60         /**
61          * /A1-P/v1/policies/{policyId}
62          */
63         @Override
64         public String createDeleteUri(String type, String policyId) {
65             return policiesBaseUri() + policyId;
66         }
67
68         /**
69          * /A1-P/v1/policies/{policyId}/status
70          */
71         public String createGetPolicyStatusUri(String type, String policyId) {
72             return policiesBaseUri() + policyId + "/status";
73         }
74
75         private String baseUri() {
76             return ricConfig.baseUrl() + "/A1-P/v1";
77         }
78
79         private String policiesBaseUri() {
80             return createGetPolicyIdsUri() + "/";
81         }
82     }
83
84     private final AsyncRestClient restClient;
85     private final UriBuilder uri;
86
87     public StdA1ClientVersion1(RicConfig ricConfig) {
88         this(new AsyncRestClient(""), ricConfig);
89     }
90
91     public StdA1ClientVersion1(AsyncRestClient restClient, RicConfig ricConfig) {
92         this.restClient = restClient;
93         this.uri = new UriBuilder(ricConfig);
94     }
95
96     @Override
97     public Mono<List<String>> getPolicyIdentities() {
98         return getPolicyIds() //
99             .collectList();
100     }
101
102     @Override
103     public Mono<String> putPolicy(Policy policy) {
104         return restClient.put(uri.createPutPolicyUri(policy.type().name(), policy.id()), policy.json());
105     }
106
107     @Override
108     public Mono<List<String>> getPolicyTypeIdentities() {
109         return Mono.just(Arrays.asList(""));
110     }
111
112     @Override
113     public Mono<String> getPolicyTypeSchema(String policyTypeId) {
114         return Mono.just("{}");
115     }
116
117     @Override
118     public Mono<String> deletePolicy(Policy policy) {
119         return deletePolicyById(policy.id());
120     }
121
122     @Override
123     public Flux<String> deleteAllPolicies() {
124         return getPolicyIds() //
125             .flatMap(this::deletePolicyById); //
126     }
127
128     @Override
129     public Mono<A1ProtocolType> getProtocolVersion() {
130         return getPolicyIdentities() //
131             .flatMap(x -> Mono.just(A1ProtocolType.STD_V1_1));
132     }
133
134     @Override
135     public Mono<String> getPolicyStatus(Policy policy) {
136         return restClient.get(uri.createGetPolicyStatusUri(policy.type().name(), policy.id()));
137     }
138
139     private Flux<String> getPolicyIds() {
140         return restClient.get(uri.createGetPolicyIdsUri()) //
141             .flatMapMany(SdncJsonHelper::parseJsonArrayOfString);
142     }
143
144     private Mono<String> deletePolicyById(String policyId) {
145         return restClient.delete(uri.createDeleteUri("", policyId));
146     }
147 }