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.ArrayList;
  32 import java.util.Collection;
  33 import java.util.List;
  34 import java.util.Map;
  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;
  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         this(urlPrefix, new RestTemplate());
  70         logger.debug("ctor prefix '{}'", urlPrefix);
  71     }
  72
  73     public PolicyAgentApiImpl(String urlPrefix, RestTemplate restTemplate) {
  74         this.urlPrefix = urlPrefix;
  75         this.restTemplate = restTemplate;
  76     }
  77
  78     private String baseUrl() {
  79         return urlPrefix;
  80     }
  81
  82     @Value.Immutable
  83     @Gson.TypeAdapters
  84     interface PolicyTypeInfo {
  85
  86         public String name();
  87
  88         public String schema();
  89     }
  90
  91     @Override
  92     public ResponseEntity<String> getAllPolicyTypes() {
  93         try {
  94             String url = baseUrl() + "/policy_schemas";
  95             ResponseEntity<String> rsp = this.restTemplate.getForEntity(url, String.class);
  96             if (!rsp.getStatusCode().is2xxSuccessful()) {
  97                 return rsp;
  98             }
  99
 100             PolicyTypes result = new PolicyTypes();
 101             JsonParser jsonParser = new JsonParser();
 102
 103             JsonArray schemas = jsonParser.parse(rsp.getBody()).getAsJsonArray();
 104             for (JsonElement schema : schemas) {
 105                 JsonObject schemaObj = schema.getAsJsonObject();
 106                 String title = schemaObj.get("title").getAsString();
 107                 String schemaAsStr = schemaObj.toString();
 108                 PolicyType pt = new PolicyType(title, schemaAsStr);
 109                 result.add(pt);
 110             }
 111             return new ResponseEntity<>(gson.toJson(result), rsp.getStatusCode());
 112         } catch (Exception e) {
 113             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
 114         }
 115     }
 116
 117     @Override
 118     public ResponseEntity<String> getPolicyInstancesForType(String type) {
 119         String url = baseUrl() + "/policies?type={type}";
 120         Map<String, ?> uriVariables = Map.of("type", type);
 121         ResponseEntity<String> rsp = this.restTemplate.getForEntity(url, String.class, uriVariables);
 122         if (!rsp.getStatusCode().is2xxSuccessful()) {
 123             return rsp;
 124         }
 125
 126         try {
 127             Type listType = new TypeToken<List<ImmutablePolicyInfo>>() {}.getType();
 128             List<PolicyInfo> rspParsed = gson.fromJson(rsp.getBody(), listType);
 129             PolicyInstances result = new PolicyInstances();
 130             for (PolicyInfo p : rspParsed) {
 131                 result.add(p);
 132             }
 133             return new ResponseEntity<>(gson.toJson(result), rsp.getStatusCode());
 134         } catch (Exception e) {
 135             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
 136         }
 137     }
 138
 139     @Override
 140     public ResponseEntity<Object> getPolicyInstance(String id) {
 141         String url = baseUrl() + "/policy?instance={id}";
 142         Map<String, ?> uriVariables = Map.of("id", id);
 143
 144         return this.restTemplate.getForEntity(url, Object.class, uriVariables);
 145     }
 146
 147     @Override
 148     public ResponseEntity<String> putPolicy(String policyTypeIdString, String policyInstanceId, Object json,
 149         String ric) {
 150         String url = baseUrl() + "/policy?type={type}&instance={instance}&ric={ric}&service={service}";
 151         Map<String, ?> uriVariables = Map.of( //
 152             "type", policyTypeIdString, //
 153             "instance", policyInstanceId, //
 154             "ric", ric, //
 155             "service", "dashboard");
 156
 157         try {
 158             this.restTemplate.put(url, createJsonHttpEntity(json), uriVariables);
 159             return new ResponseEntity<>(HttpStatus.OK);
 160         } catch (Exception e) {
 161             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
 162         }
 163     }
 164
 165     @Override
 166     public ResponseEntity<String> deletePolicy(String policyInstanceId) {
 167         String url = baseUrl() + "/policy?instance={instance}";
 168         Map<String, ?> uriVariables = Map.of("instance", policyInstanceId);
 169         try {
 170             this.restTemplate.delete(url, uriVariables);
 171             return new ResponseEntity<>(HttpStatus.OK);
 172         } catch (Exception e) {
 173             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
 174         }
 175
 176     }
 177
 178     @Value.Immutable
 179     @Gson.TypeAdapters
 180     interface RicInfo {
 181         public String ricName();
 182
 183         public Collection<String> nodeNames();
 184
 185         public Collection<String> policyTypes();
 186     }
 187
 188     @Override
 189     public ResponseEntity<String> getRicsSupportingType(String typeName) {
 190         String url = baseUrl() + "/rics?policyType={typeName}";
 191         Map<String, ?> uriVariables = Map.of("typeName", typeName);
 192         String rsp = this.restTemplate.getForObject(url, String.class, uriVariables);
 193
 194         try {
 195             Type listType = new TypeToken<List<ImmutableRicInfo>>() {}.getType();
 196             List<RicInfo> rspParsed = gson.fromJson(rsp, listType);
 197             Collection<String> result = new ArrayList<>(rspParsed.size());
 198             for (RicInfo ric : rspParsed) {
 199                 result.add(ric.ricName());
 200             }
 201             return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
 202         } catch (Exception e) {
 203             return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
 204         }
 205     }
 206
 207     private HttpEntity<Object> createJsonHttpEntity(Object content) {
 208         HttpHeaders headers = new HttpHeaders();
 209         headers.setContentType(MediaType.APPLICATION_JSON);
 210         return new HttpEntity<>(content, headers);
 211     }
 212
 213 }