webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/controller/EnrichmentController.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 package org.oransc.portal.nonrtric.controlpanel.controller;
  21
  22 import com.google.gson.GsonBuilder;
  23 import com.google.gson.JsonArray;
  24 import com.google.gson.JsonElement;
  25 import com.google.gson.JsonParser;
  26
  27 import io.swagger.annotations.ApiOperation;
  28
  29 import java.lang.invoke.MethodHandles;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32
  33 import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants;
  34 import org.oransc.portal.nonrtric.controlpanel.eiproducerapi.EiProducerApi;
  35 import org.oransc.portal.nonrtric.controlpanel.model.JobInfo;
  36 import org.oransc.portal.nonrtric.controlpanel.model.ProducerInfo;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.springframework.beans.factory.annotation.Autowired;
  40 import org.springframework.http.HttpStatus;
  41 import org.springframework.http.MediaType;
  42 import org.springframework.http.ResponseEntity;
  43 import org.springframework.util.Assert;
  44 import org.springframework.web.bind.annotation.GetMapping;
  45 import org.springframework.web.bind.annotation.PathVariable;
  46 import org.springframework.web.bind.annotation.RequestMapping;
  47 import org.springframework.web.bind.annotation.RestController;
  48
  49 /**
  50  * Proxies calls from the front end to the EI Producer API.
  51  *
  52  * If a method throws RestClientResponseException, it is handled by
  53  * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
  54  * which returns status 502. All other exceptions are handled by Spring which
  55  * returns status 500.
  56  */
  57 @RestController
  58 @RequestMapping(value = EnrichmentController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  59 public class EnrichmentController {
  60
  61     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  62
  63     private static com.google.gson.Gson gson = new GsonBuilder().create();
  64
  65     // Publish paths in constants so tests are easy to write
  66     public static final String CONTROLLER_PATH = ControlPanelConstants.ENDPOINT_PREFIX + "/enrichment";
  67     // Endpoints
  68     public static final String EI_TYPES = "eitypes";
  69     public static final String EI_PRODUCERS = "eiproducers";
  70     public static final String EI_JOBS = "eijobs";
  71     public static final String EI_TYPE_ID = "ei_type_id";
  72     public static final String EI_PRODUCER_ID = "ei_producer_id";
  73     public static final String STATUS = "status";
  74
  75     // Populated by the autowired constructor
  76     private final EiProducerApi eiProducerApi;
  77
  78     @Autowired
  79     public EnrichmentController(final EiProducerApi eiProducerApi) {
  80         Assert.notNull(eiProducerApi, "API must not be null");
  81         this.eiProducerApi = eiProducerApi;
  82         logger.debug("enrichment: configured with client type {}", eiProducerApi.getClass().getName());
  83     }
  84
  85     /*
  86      * The fields are defined in the Enrichment Control Typescript interface.
  87      */
  88     @ApiOperation(value = "Get the EI type identifiers")
  89     @GetMapping(EI_TYPES)
  90     public ResponseEntity<String> getAllEiTypeIds() {
  91         logger.debug("getAllEiTypeIds");
  92         return this.eiProducerApi.getAllEiTypeIds();
  93     }
  94
  95     @ApiOperation(value = "Get an individual EI type")
  96     @GetMapping(EI_TYPES + "/{" + EI_TYPE_ID + "}")
  97     public ResponseEntity<String> getEiType(@PathVariable(EI_TYPE_ID) String eiTypeId) {
  98         logger.debug("getEiType {}", eiTypeId);
  99         return this.eiProducerApi.getEiType(eiTypeId);
 100     }
 101
 102     @ApiOperation(value = "Get an individual EI producer")
 103     @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}")
 104     public ResponseEntity<String> getEiProducer(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
 105         logger.debug("getEiProducer {}", eiProducerId);
 106         return this.eiProducerApi.getEiProducer(eiProducerId);
 107     }
 108
 109     @ApiOperation(value = "Get the EI job definitions for one EI producer")
 110     @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}/" + EI_JOBS)
 111     public ResponseEntity<String> getEiJobsForOneEiProducer(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
 112         logger.debug("getEiJobsForOneEiProducer {}", eiProducerId);
 113         return this.eiProducerApi.getEiJobsForOneEiProducer(eiProducerId);
 114     }
 115
 116     @ApiOperation(value = "Get the EI job definitions for one EI producer")
 117     @GetMapping(EI_JOBS)
 118     public ResponseEntity<List<JobInfo>> getEiJobs() {
 119         logger.debug("getEiJobs");
 120         ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
 121         JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
 122         List<JobInfo> allJobs = new ArrayList<>();
 123         for (JsonElement producerId : bodyJson) {
 124             allJobs.addAll(getJobs(producerId));
 125         }
 126         return new ResponseEntity<>(allJobs, HttpStatus.OK);
 127     }
 128
 129     private List<JobInfo> getJobs(JsonElement producerId) {
 130         List<JobInfo> jobs = new ArrayList<>();
 131         ResponseEntity<String> jobsResponse = this.eiProducerApi.getEiJobsForOneEiProducer(producerId.getAsString());
 132         JsonArray jobsJson = JsonParser.parseString(jobsResponse.getBody()).getAsJsonArray();
 133         for (JsonElement jobJson : jobsJson) {
 134             JobInfo jobInfo = gson.fromJson(jobJson, JobInfo.class);
 135             jobs.add(jobInfo);
 136         }
 137         return jobs;
 138     }
 139
 140     @ApiOperation(value = "Get EI producers")
 141     @GetMapping(EI_PRODUCERS)
 142     public ResponseEntity<List<ProducerInfo>> getEiProducers() {
 143         logger.debug("getEiProducers");
 144         ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
 145         JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
 146         List<ProducerInfo> producers = new ArrayList<>();
 147         for (JsonElement producerId : bodyJson) {
 148             ProducerInfo producerInfo = ProducerInfo.builder() //
 149                 .id(producerId.getAsString()) //
 150                 .types(getSupportedTypes(producerId)) //
 151                 .status(getProducerStatus(producerId)) //
 152                 .build();
 153             producers.add(producerInfo);
 154         }
 155
 156         return new ResponseEntity<>(producers, HttpStatus.OK);
 157     }
 158
 159     private String[] getSupportedTypes(JsonElement producerId) {
 160         ResponseEntity<String> producerResponse = this.eiProducerApi.getEiProducer(producerId.getAsString());
 161         JsonArray supportedTypesJson = JsonParser.parseString(producerResponse.getBody()).getAsJsonObject()
 162             .get("supported_ei_types").getAsJsonArray();
 163         List<String> supportedTypes = new ArrayList<>();
 164         for (JsonElement typeJson : supportedTypesJson) {
 165             supportedTypes.add(typeJson.getAsJsonObject().get("ei_type_identity").getAsString());
 166         }
 167         return supportedTypes.toArray(new String[0]);
 168     }
 169
 170     private String getProducerStatus(JsonElement producerId) {
 171         ResponseEntity<String> statusResponse = this.eiProducerApi.getEiProducerStatus(producerId.getAsString());
 172         return JsonParser.parseString(statusResponse.getBody()).getAsJsonObject().get("operational_state")
 173             .getAsString();
 174     }
 175
 176     @ApiOperation(value = "Get the status of an EI producer")
 177     @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}/" + STATUS)
 178     public ResponseEntity<String> getEiProducerStatus(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
 179         logger.debug("getEiProducerStatus {}", eiProducerId);
 180         return this.eiProducerApi.getEiProducerStatus(eiProducerId);
 181     }
 182 }