--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * O-RAN-SC
+ * %%
+ * Copyright (C) 2020 Nordix Foundation
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+package org.oransc.portal.nonrtric.controlpanel.controller;
+
+import java.lang.invoke.MethodHandles;
+import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants;
+import org.oransc.portal.nonrtric.controlpanel.eiproducerapi.EiProducerApi;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.access.annotation.Secured;
+import org.springframework.util.Assert;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import io.swagger.annotations.ApiOperation;
+
+/**
+ * Proxies calls from the front end to the EI Producer API.
+ *
+ * If a method throws RestClientResponseException, it is handled by
+ * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
+ * which returns status 502. All other exceptions are handled by Spring which
+ * returns status 500.
+ */
+@RestController
+@RequestMapping(value = EnrichmentController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
+public class EnrichmentController {
+
+ private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ // Publish paths in constants so tests are easy to write
+ public static final String CONTROLLER_PATH = ControlPanelConstants.ENDPOINT_PREFIX + "/enrichment";
+ // Endpoints
+ public static final String VERSION_METHOD = ControlPanelConstants.VERSION_METHOD;
+ public static final String EI_TYPES = "eitypes";
+ public static final String EI_PRODUCERS = "eiproducers";
+ public static final String EI_JOBS = "eijobs";
+ public static final String EI_TYPE_ID = "ei_type_id";
+ public static final String EI_PRODUCER_ID = "ei_producer_id";
+ public static final String STATUS = "status";
+
+ // Populated by the autowired constructor
+ private final EiProducerApi eiProducerApi;
+
+ @Autowired
+ public EnrichmentController(final EiProducerApi eiProducerApi) {
+ Assert.notNull(eiProducerApi, "API must not be null");
+ this.eiProducerApi = eiProducerApi;
+ logger.debug("enrichment: configured with client type {}", eiProducerApi.getClass().getName());
+ }
+
+ /*
+ * The fields are defined in the Enrichment Control Typescript interface.
+ */
+ @ApiOperation(value = "Get the EI type identifiers")
+ @GetMapping(EI_TYPES)
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getAllEiTypeIds() {
+ logger.debug("getAllEiTypeIds");
+ return this.eiProducerApi.getAllEiTypeIds();
+ }
+
+ @ApiOperation(value = "Get an individual EI type")
+ @GetMapping(EI_TYPES + "/{" + EI_TYPE_ID + "}")
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getEiType(@PathVariable(EI_TYPE_ID) String eiTypeId) {
+ logger.debug("getEiType {}", eiTypeId);
+ return this.eiProducerApi.getEiType(eiTypeId);
+ }
+
+ @ApiOperation(value = "Get the EI producer identifiers")
+ @GetMapping(EI_PRODUCERS)
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getAllEiProducerIds() {
+ logger.debug("getAllEiProducerIds");
+ return this.eiProducerApi.getAllEiProducerIds();
+ }
+
+ @ApiOperation(value = "Get an individual EI producer")
+ @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}")
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getEiProducer(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
+ logger.debug("getEiProducer {}", eiProducerId);
+ return this.eiProducerApi.getEiProducer(eiProducerId);
+ }
+
+ @ApiOperation(value = "Get the EI job definitions for one EI producer")
+ @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}/" + EI_JOBS)
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getEiJobsForOneEiProducer(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
+ logger.debug("getEiJobsForOneEiProducer {}", eiProducerId);
+ return this.eiProducerApi.getEiJobsForOneEiProducer(eiProducerId);
+ }
+
+ @ApiOperation(value = "Get the status of an EI producer")
+ @GetMapping(EI_PRODUCERS + "/{" + EI_PRODUCER_ID + "}/" + STATUS)
+ @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD})
+ public ResponseEntity<String> getEiProducerStatus(@PathVariable(EI_PRODUCER_ID) String eiProducerId) {
+ logger.debug("getEiProducerStatus {}", eiProducerId);
+ return this.eiProducerApi.getEiProducerStatus(eiProducerId);
+ }
+}
\ No newline at end of file
Code Review / portal / nonrtric-controlpanel.git / blobdiff