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