NBI documentation using swagger UI
[nonrtric.git] / dashboard / webapp-backend / src / main / java / org / oransc / ric / portal / dashboard / policyagentapi / PolicyAgentApiImpl.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 AT&T Intellectual Property
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 package org.oransc.ric.portal.dashboard.policyagentapi;
21
22 import com.google.gson.GsonBuilder;
23 import com.google.gson.JsonArray;
24 import com.google.gson.JsonElement;
25 import com.google.gson.JsonObject;
26 import com.google.gson.JsonParser;
27 import com.google.gson.reflect.TypeToken;
28
29 import java.lang.invoke.MethodHandles;
30 import java.lang.reflect.Type;
31 import java.util.Collection;
32 import java.util.List;
33 import java.util.Map;
34 import java.util.Vector;
35
36 import org.immutables.gson.Gson;
37 import org.immutables.value.Value;
38 import org.oransc.ric.portal.dashboard.model.ImmutablePolicyInfo;
39 import org.oransc.ric.portal.dashboard.model.PolicyInfo;
40 import org.oransc.ric.portal.dashboard.model.PolicyInstances;
41 import org.oransc.ric.portal.dashboard.model.PolicyType;
42 import org.oransc.ric.portal.dashboard.model.PolicyTypes;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45 import org.springframework.beans.factory.annotation.Autowired;
46 import org.springframework.http.HttpEntity;
47 import org.springframework.http.HttpHeaders;
48 import org.springframework.http.HttpStatus;
49 import org.springframework.http.MediaType;
50 import org.springframework.http.ResponseEntity;
51 import org.springframework.stereotype.Component;
52 import org.springframework.web.client.RestTemplate;
53
54 @Component("PolicyAgentApi")
55 public class PolicyAgentApiImpl implements PolicyAgentApi {
56     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
57
58     RestTemplate restTemplate = new RestTemplate();
59
60     private static com.google.gson.Gson gson = new GsonBuilder() //
61         .serializeNulls() //
62         .create(); //
63
64     private final String urlPrefix;
65
66     @Autowired
67     public PolicyAgentApiImpl(
68         @org.springframework.beans.factory.annotation.Value("${policycontroller.url.prefix}") final String urlPrefix) {
69         logger.debug("ctor prefix '{}'", urlPrefix);
70         this.urlPrefix = urlPrefix;
71     }
72
73     private String baseUrl() {
74         return urlPrefix;
75     }
76
77     @Value.Immutable
78     @Gson.TypeAdapters
79     interface PolicyTypeInfo {
80
81         public String name();
82
83         public String schema();
84     }
85
86     @Override
87     public ResponseEntity<String> getAllPolicyTypes() {
88         try {
89             String url = baseUrl() + "/policy_schemas";
90             ResponseEntity<String> rsp = this.restTemplate.getForEntity(url, String.class);
91             if (!rsp.getStatusCode().is2xxSuccessful()) {
92                 return rsp;
93             }
94
95             PolicyTypes result = new PolicyTypes();
96             JsonParser jsonParser = new JsonParser();
97
98             JsonArray schemas = jsonParser.parse(rsp.getBody()).getAsJsonArray();
99             for (JsonElement schema : schemas) {
100                 JsonObject schemaObj = schema.getAsJsonObject();
101                 String title = schemaObj.get("title").getAsString();
102                 String schemaAsStr = schemaObj.toString();
103                 PolicyType pt = new PolicyType(title, schemaAsStr);
104                 result.add(pt);
105             }
106             return new ResponseEntity<>(gson.toJson(result), rsp.getStatusCode());
107         } catch (Exception e) {
108             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
109         }
110     }
111
112     @Override
113     public ResponseEntity<String> getPolicyInstancesForType(String type) {
114         String url = baseUrl() + "/policies?type={type}";
115         Map<String, ?> uriVariables = Map.of("type", type);
116         ResponseEntity<String> rsp = this.restTemplate.getForEntity(url, String.class, uriVariables);
117         if (!rsp.getStatusCode().is2xxSuccessful()) {
118             return rsp;
119         }
120
121         try {
122             Type listType = new TypeToken<List<ImmutablePolicyInfo>>() {}.getType();
123             List<PolicyInfo> rspParsed = gson.fromJson(rsp.getBody(), listType);
124             PolicyInstances result = new PolicyInstances();
125             for (PolicyInfo p : rspParsed) {
126                 result.add(p);
127             }
128             return new ResponseEntity<>(gson.toJson(result), rsp.getStatusCode());
129         } catch (Exception e) {
130             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
131         }
132     }
133
134     @Override
135     public ResponseEntity<String> getPolicyInstance(String id) {
136         String url = baseUrl() + "/policy?instance={id}";
137         Map<String, ?> uriVariables = Map.of("id", id);
138
139         return this.restTemplate.getForEntity(url, String.class, uriVariables);
140     }
141
142     @Override
143     public ResponseEntity<String> putPolicy(String policyTypeIdString, String policyInstanceId, String json,
144         String ric) {
145         String url = baseUrl() + "/policy?type={type}&instance={instance}&ric={ric}&service={service}";
146         Map<String, ?> uriVariables = Map.of( //
147             "type", policyTypeIdString, //
148             "instance", policyInstanceId, //
149             "ric", ric, //
150             "service", "dashboard");
151
152         try {
153             this.restTemplate.put(url, createJsonHttpEntity(json), uriVariables);
154             return new ResponseEntity<>(HttpStatus.OK);
155         } catch (Exception e) {
156             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
157         }
158     }
159
160     @Override
161     public ResponseEntity<String> deletePolicy(String policyInstanceId) {
162         String url = baseUrl() + "/policy?instance={instance}";
163         Map<String, ?> uriVariables = Map.of("instance", policyInstanceId);
164         try {
165             this.restTemplate.delete(url, uriVariables);
166             return new ResponseEntity<>(HttpStatus.OK);
167         } catch (Exception e) {
168             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
169         }
170
171     }
172
173     @Value.Immutable
174     @Gson.TypeAdapters
175     interface RicInfo {
176         public String name();
177
178         public Collection<String> nodeNames();
179
180         public Collection<String> policyTypes();
181     }
182
183     @Override
184     public ResponseEntity<String> getRicsSupportingType(String typeName) {
185         String url = baseUrl() + "/rics?policyType={typeName}";
186         Map<String, ?> uriVariables = Map.of("typeName", typeName);
187         String rsp = this.restTemplate.getForObject(url, String.class, uriVariables);
188
189         try {
190             Type listType = new TypeToken<List<ImmutableRicInfo>>() {}.getType();
191             List<RicInfo> rspParsed = gson.fromJson(rsp, listType);
192             Collection<String> result = new Vector<>(rspParsed.size());
193             for (RicInfo ric : rspParsed) {
194                 result.add(ric.name());
195             }
196             return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
197         } catch (Exception e) {
198             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
199         }
200     }
201
202     private HttpEntity<String> createJsonHttpEntity(String content) {
203         HttpHeaders headers = new HttpHeaders();
204         headers.setContentType(MediaType.APPLICATION_JSON);
205         return new HttpEntity<String>(content, headers);
206     }
207
208 }