X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=webapp-backend%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fric%2Fportal%2Fdashboard%2Fcontroller%2FE2ManagerController.java;h=6b621f4fd132141f245420cfb16f434db94a6416;hb=refs%2Fchanges%2F14%2F414%2F9;hp=53593a642f1afdfa031b88c37e25216628f35ade;hpb=f660cae7a447b60d84ef75f7c2bcbf62412d4579;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/E2ManagerController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/E2ManagerController.java index 53593a64..6b621f4f 100644 --- a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/E2ManagerController.java +++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/E2ManagerController.java @@ -1,6 +1,6 @@ /*- * ========================LICENSE_START================================= - * ORAN-OSC + * O-RAN-SC * %% * Copyright (C) 2019 AT&T Intellectual Property and Nokia * %% @@ -20,34 +20,48 @@ package org.oransc.ric.portal.dashboard.controller; import java.lang.invoke.MethodHandles; -import java.util.HashSet; -import java.util.Set; +import java.util.ArrayList; +import java.util.List; import javax.servlet.http.HttpServletResponse; import org.oransc.ric.e2mgr.client.api.HealthCheckApi; -import org.oransc.ric.e2mgr.client.api.X2SetupRequestApi; +import org.oransc.ric.e2mgr.client.api.NodebApi; +import org.oransc.ric.e2mgr.client.model.GetNodebResponse; +import org.oransc.ric.e2mgr.client.model.NodebIdentity; +import org.oransc.ric.e2mgr.client.model.NodebIdentityGlobalNbId; import org.oransc.ric.e2mgr.client.model.SetupRequest; +import org.oransc.ric.portal.dashboard.DashboardApplication; import org.oransc.ric.portal.dashboard.DashboardConstants; +import org.oransc.ric.portal.dashboard.model.ErrorTransport; +import org.oransc.ric.portal.dashboard.model.RanDetailsTransport; +import org.oransc.ric.portal.dashboard.model.SuccessTransport; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; +import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; import org.springframework.util.Assert; +import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.client.HttpStatusCodeException; import io.swagger.annotations.ApiOperation; /** - * Provides methods to contact the E2 Manager. + * Proxies calls from the front end to the E2 Manager API. All methods answer + * 502 on failure and wrap the remote details:
HTTP server received + * an invalid response from a server it consulted when acting as a proxy or + * gateway.
* - * As of this writing the E2 interface only supports setup connection and check - * health actions; it does not support query or close operations on existing - * connections. So this class mocks up some of that needed functionality. + * In R1 the E2 interface does not yet implement the get-ID-list method, so this + * class mocks up some functionality. */ @Configuration @RestController @@ -56,65 +70,151 @@ public class E2ManagerController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - // Populated by the autowired constructor - private final HealthCheckApi healthCheckApi; - private final X2SetupRequestApi x2SetupRequestApi; + private final List mockNodebIdList; - // Tracks the requests previously submitted. - // TODO remove when the E2 manager is extended. - private Set requests = new HashSet<>(); + // Path parameters + private static final String PP_RANNAME = "ranName"; - @Autowired - public E2ManagerController(final HealthCheckApi healthCheckApi, final X2SetupRequestApi x2SetupRequestApi) { - Assert.notNull(healthCheckApi, "API must not be null"); - this.healthCheckApi = healthCheckApi; - this.x2SetupRequestApi = x2SetupRequestApi; - } + // Populated by the autowired constructor + private final HealthCheckApi e2HealthCheckApi; + private final NodebApi e2NodebApi; - private void assertNotNull(Object o) { - if (o == null) - throw new IllegalArgumentException("Null not permitted"); + @Autowired + public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi, + @Value("${e2mgr.mock.rannames:#{null}}") final String mockRanNames) { + Assert.notNull(e2HealthCheckApi, "API must not be null"); + Assert.notNull(e2NodebApi, "API must not be null"); + this.e2HealthCheckApi = e2HealthCheckApi; + this.e2NodebApi = e2NodebApi; + mockNodebIdList = new ArrayList<>(); + if (mockRanNames != null) { + logger.debug("ctor: Mocking RAN names: {}", mockRanNames); + for (String id : mockRanNames.split(",")) { + NodebIdentityGlobalNbId globalNbId = new NodebIdentityGlobalNbId().nbId("mockNbId").plmnId("mockPlmId"); + mockNodebIdList.add(new NodebIdentity().globalNbId(globalNbId).inventoryName(id.trim())); + } + } } - private void assertNotEmpty(String s) { - assertNotNull(s); - if (s.isEmpty()) - throw new IllegalArgumentException("Empty not permitted"); + @ApiOperation(value = "Gets the E2 manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) + @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET) + public SuccessTransport getE2ManagerClientVersion() { + return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthCheckApi.class)); } @ApiOperation(value = "Gets the health from the E2 manager, expressed as the response code.") @RequestMapping(value = "/health", method = RequestMethod.GET) - public void getHealth(HttpServletResponse response) { - logger.debug("getHealth"); - healthCheckApi.healthCheck(); - response.setStatus(healthCheckApi.getApiClient().getStatusCode().value()); + public Object healthGet(HttpServletResponse response) { + logger.debug("healthGet"); + try { + e2HealthCheckApi.healthGet(); + response.setStatus(e2HealthCheckApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("healthGet failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); + } } - @ApiOperation(value = "Gets the unique requests submitted to the E2 manager.", response = SetupRequest.class, responseContainer = "List") - @RequestMapping(value = "/setup", method = RequestMethod.GET) - public Iterable getRequests() { - logger.debug("getRequests"); - return requests; + // This calls other methods to simplify the task of the front-end. + @ApiOperation(value = "Gets all RAN identities and statuses from the E2 manager.", response = RanDetailsTransport.class, responseContainer = "List") + @RequestMapping(value = "/ran", method = RequestMethod.GET) + public Object getRanDetails() { + logger.debug("getRanDetails"); + List nodebIdList = null; + try { + // TODO: remove mock when e2mgr delivers the getNodebIdList() method + nodebIdList = mockNodebIdList.isEmpty() ? e2NodebApi.getNodebIdList() : mockNodebIdList; + } catch (HttpStatusCodeException ex) { + logger.warn("getRanDetails: getNodebIdList failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); + } + List details = new ArrayList<>(); + for (NodebIdentity nbid : nodebIdList) { + GetNodebResponse nbResp = null; + try { + // Keep looping despite failures + nbResp = e2NodebApi.getNb(nbid.getInventoryName()); + } catch (HttpStatusCodeException ex) { + logger.warn("getRanDetails failed for name {}: {}", nbid.getInventoryName(), ex.toString()); + nbResp = new GetNodebResponse().connectionStatus("UNKNOWN").ip("UNKNOWN").port(-1) + .ranName(nbid.getInventoryName()); + } + details.add(new RanDetailsTransport(nbid, nbResp)); + } + return details; } - @ApiOperation(value = "Sets up a RAN connection via the E2 manager.") - @RequestMapping(value = "/setup", method = RequestMethod.POST) - public void setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { - logger.debug("setup {}", setupRequest); + @ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List") + @RequestMapping(value = "/nodeb/id", method = RequestMethod.GET) + public Object getNodebIdList() { + logger.debug("getNodebIdList"); try { - assertNotEmpty(setupRequest.getRanIp()); - assertNotEmpty(setupRequest.getRanName()); - assertNotNull(setupRequest.getRanPort()); - } catch (Exception ex) { - logger.error("Bad request", ex); - response.setStatus(HttpServletResponse.SC_BAD_REQUEST); + return e2NodebApi.getNodebIdList(); + } catch (HttpStatusCodeException ex) { + logger.warn("getNodebIdList failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); } + } + + @ApiOperation(value = "Get RAN by name.", response = GetNodebResponse.class) + @RequestMapping(value = "/nodeb/{" + PP_RANNAME + "}", method = RequestMethod.GET) + public Object getNb(@PathVariable(PP_RANNAME) String ranName) { + logger.debug("getNb {}", ranName); + try { + return e2NodebApi.getNb(ranName); + } catch (HttpStatusCodeException ex) { + logger.warn("getNb failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); + } + } + + @ApiOperation(value = "Close all connections to the RANs and delete the data from the nodeb-rnib DB.") + @RequestMapping(value = "/nodeb", method = RequestMethod.DELETE) + public Object nodebDelete(HttpServletResponse response) { + logger.debug("nodebDelete"); + try { + e2NodebApi.nodebDelete(); + response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("nodebDelete failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); + } + } + + @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.") + @RequestMapping(value = "/endcSetup", method = RequestMethod.POST) + public Object endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { + logger.debug("endcSetup {}", setupRequest); + try { + e2NodebApi.endcSetup(setupRequest); + response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("endcSetup failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); + } + } + + @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.") + @RequestMapping(value = "/x2Setup", method = RequestMethod.POST) + public Object x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { + logger.debug("x2Setup {}", setupRequest); try { - requests.add(setupRequest); - x2SetupRequestApi.setup(setupRequest); - } catch (Exception ex) { - logger.error("Failed", ex); - response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); + e2NodebApi.x2Setup(setupRequest); + response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("x2Setup failed: {}", ex.toString()); + return new ResponseEntity(new ErrorTransport(ex.getRawStatusCode(), ex.toString()), + HttpStatus.BAD_GATEWAY); } }