2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 package org.oransc.portal.nonrtric.controlpanel.controller;
22 import com.google.gson.GsonBuilder;
23 import com.google.gson.JsonArray;
24 import com.google.gson.JsonElement;
25 import com.google.gson.JsonParser;
27 import io.swagger.annotations.ApiOperation;
29 import java.lang.invoke.MethodHandles;
30 import java.util.ArrayList;
31 import java.util.List;
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.RequestMapping;
46 import org.springframework.web.bind.annotation.RestController;
49 * Proxies calls from the front end to the EI Producer API.
51 * If a method throws RestClientResponseException, it is handled by
52 * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
53 * which returns status 502. All other exceptions are handled by Spring which
57 @RequestMapping(value = EnrichmentController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
58 public class EnrichmentController {
60 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
62 private static com.google.gson.Gson gson = new GsonBuilder().create();
64 // Publish paths in constants so tests are easy to write
65 public static final String CONTROLLER_PATH = ControlPanelConstants.ENDPOINT_PREFIX + "/enrichment";
67 public static final String EI_TYPES = "eitypes";
68 public static final String EI_PRODUCERS = "eiproducers";
69 public static final String EI_JOBS = "eijobs";
70 public static final String EI_TYPE_ID = "ei_type_id";
71 public static final String EI_PRODUCER_ID = "ei_producer_id";
72 public static final String STATUS = "status";
74 // Populated by the autowired constructor
75 private final EiProducerApi eiProducerApi;
78 public EnrichmentController(final EiProducerApi eiProducerApi) {
79 Assert.notNull(eiProducerApi, "API must not be null");
80 this.eiProducerApi = eiProducerApi;
81 logger.debug("enrichment: configured with client type {}", eiProducerApi.getClass().getName());
84 @ApiOperation(value = "Get the EI job definitions for one EI producer")
86 public ResponseEntity<List<JobInfo>> getEiJobs() {
87 logger.debug("getEiJobs");
88 ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
89 JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
90 List<JobInfo> allJobs = new ArrayList<>();
91 for (JsonElement producerId : bodyJson) {
92 allJobs.addAll(getJobs(producerId));
94 return new ResponseEntity<>(allJobs, HttpStatus.OK);
97 private List<JobInfo> getJobs(JsonElement producerId) {
98 List<JobInfo> jobs = new ArrayList<>();
99 ResponseEntity<String> jobsResponse = this.eiProducerApi.getEiJobsForOneEiProducer(producerId.getAsString());
100 JsonArray jobsJson = JsonParser.parseString(jobsResponse.getBody()).getAsJsonArray();
101 for (JsonElement jobJson : jobsJson) {
102 JobInfo jobInfo = gson.fromJson(jobJson, JobInfo.class);
108 @ApiOperation(value = "Get EI producers")
109 @GetMapping(EI_PRODUCERS)
110 public ResponseEntity<List<ProducerInfo>> getEiProducers() {
111 logger.debug("getEiProducers");
112 ResponseEntity<String> response = this.eiProducerApi.getAllEiProducerIds();
113 JsonArray bodyJson = JsonParser.parseString(response.getBody()).getAsJsonArray();
114 List<ProducerInfo> producers = new ArrayList<>();
115 for (JsonElement producerId : bodyJson) {
116 ProducerInfo producerInfo = ProducerInfo.builder() //
117 .id(producerId.getAsString()) //
118 .types(getSupportedTypes(producerId)) //
119 .status(getProducerStatus(producerId)) //
121 producers.add(producerInfo);
124 return new ResponseEntity<>(producers, HttpStatus.OK);
127 private String[] getSupportedTypes(JsonElement producerId) {
128 ResponseEntity<String> producerResponse = this.eiProducerApi.getEiProducer(producerId.getAsString());
129 JsonArray supportedTypesJson = JsonParser.parseString(producerResponse.getBody()).getAsJsonObject()
130 .get("supported_ei_types").getAsJsonArray();
131 List<String> supportedTypes = new ArrayList<>();
132 for (JsonElement typeJson : supportedTypesJson) {
133 supportedTypes.add(typeJson.getAsJsonObject().get("ei_type_identity").getAsString());
135 return supportedTypes.toArray(new String[0]);
138 private String getProducerStatus(JsonElement producerId) {
139 ResponseEntity<String> statusResponse = this.eiProducerApi.getEiProducerStatus(producerId.getAsString());
140 return JsonParser.parseString(statusResponse.getBody()).getAsJsonObject().get("operational_state")