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.oransc.portal.nonrtric.controlpanel.model.ProducerRegistrationInfo;
  38 import org.oransc.portal.nonrtric.controlpanel.model.ProducerRegistrationInfo.ProducerEiTypeRegistrationInfo;
  39 import org.oransc.portal.nonrtric.controlpanel.model.ProducerStatusInfo;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42 import org.springframework.beans.factory.annotation.Autowired;
  43 import org.springframework.http.HttpStatus;
  44 import org.springframework.http.MediaType;
  45 import org.springframework.http.ResponseEntity;
  46 import org.springframework.util.Assert;
  47 import org.springframework.web.bind.annotation.GetMapping;
  48 import org.springframework.web.bind.annotation.RequestMapping;
  49 import org.springframework.web.bind.annotation.RestController;
  50
  51 /**
  52  * Proxies calls from the front end to the EI Producer API.
  53  *
  54  * If a method throws RestClientResponseException, it is handled by
  55  * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
  56  * which returns status 502. All other exceptions are handled by Spring which
  57  * returns status 500.
  58  */
  59 @RestController
  60 @RequestMapping(value = EnrichmentController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  61 public class EnrichmentController {
  62
  63     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  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     public static com.google.gson.Gson gson = new GsonBuilder().create();
  78
  79     @Autowired
  80     public EnrichmentController(final EiProducerApi eiProducerApi) {
  81         Assert.notNull(eiProducerApi, "API must not be null");
  82         this.eiProducerApi = eiProducerApi;
  83         logger.debug("enrichment: configured with client type {}", eiProducerApi.getClass().getName());
  84     }
  85
  86     @ApiOperation(value = "Get the EI job definitions for one EI producer")
  87     @GetMapping(EI_JOBS)
  88     public ResponseEntity<String> getEiJobs() {
  89         logger.debug("getEiJobs");
  90         ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
  91         JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
  92         List<JobInfo> allJobs = new ArrayList<>();
  93         for (JsonElement producerId : bodyJson) {
  94             allJobs.addAll(getJobs(producerId));
  95         }
  96         return new ResponseEntity<>(gson.toJson(allJobs), HttpStatus.OK);
  97     }
  98
  99     private List<JobInfo> getJobs(JsonElement producerId) {
 100         ResponseEntity<List<JobInfo>> jobsResponse =
 101             this.eiProducerApi.getEiJobsForOneEiProducer(producerId.getAsString());
 102         return jobsResponse.getBody();
 103     }
 104
 105     @ApiOperation(value = "Get EI producers")
 106     @GetMapping(EI_PRODUCERS)
 107     public ResponseEntity<String> getEiProducers() {
 108         logger.debug("getEiProducers");
 109         ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
 110         JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
 111         List<ProducerInfo> producers = new ArrayList<>();
 112         for (JsonElement producerId : bodyJson) {
 113             ProducerInfo producerInfo = ProducerInfo.builder() //
 114                 .id(producerId.getAsString()) //
 115                 .types(getSupportedTypes(producerId)) //
 116                 .status(getProducerStatus(producerId)) //
 117                 .build();
 118             producers.add(producerInfo);
 119         }
 120
 121         return new ResponseEntity<>(gson.toJson(producers), HttpStatus.OK);
 122     }
 123
 124     private String[] getSupportedTypes(JsonElement producerId) {
 125         ResponseEntity<ProducerRegistrationInfo> producerResponse =
 126             this.eiProducerApi.getEiProducer(producerId.getAsString());
 127         List<String> supportedTypes = new ArrayList<>();
 128         for (ProducerEiTypeRegistrationInfo type : producerResponse.getBody().types) {
 129             supportedTypes.add(type.eiTypeId);
 130         }
 131         return supportedTypes.toArray(new String[0]);
 132     }
 133
 134     private String getProducerStatus(JsonElement producerId) {
 135         ResponseEntity<ProducerStatusInfo> statusResponse =
 136             this.eiProducerApi.getEiProducerStatus(producerId.getAsString());
 137         return statusResponse.getBody().opState.toString();
 138     }
 139 }