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=f4888fc76e9ad39b8144475199e1dd0101ddca02;hpb=0b44138e09b41a42ee1f87afd39616478911dde5;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 f4888fc7..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 @@ -20,41 +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.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.E2SetupRequestType; -import org.oransc.ric.portal.dashboard.model.E2SetupResponse; -import org.oransc.ric.portal.dashboard.model.IDashboardResponse; +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, and query by RAN name. But it does not support get-all, oo - * this class mocks up some of that functionality. + * In R1 the E2 interface does not yet implement the get-ID-list method, so this + * class mocks up some functionality. */ @Configuration @RestController @@ -63,6 +70,8 @@ public class E2ManagerController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final List mockNodebIdList; + // Path parameters private static final String PP_RANNAME = "ranName"; @@ -70,27 +79,21 @@ public class E2ManagerController { private final HealthCheckApi e2HealthCheckApi; private final NodebApi e2NodebApi; - // Stores the requests and results. - // TODO remove when the E2 manager is extended. - private Set responses = new HashSet<>(); - @Autowired - public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi) { + 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; - } - - private void assertNotNull(Object o) { - if (o == null) - throw new IllegalArgumentException("Null not permitted"); - } - - private void assertNotEmpty(String s) { - assertNotNull(s); - if (s.isEmpty()) - throw new IllegalArgumentException("Empty not permitted"); + 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())); + } + } } @ApiOperation(value = "Gets the E2 manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) @@ -101,73 +104,118 @@ public class E2ManagerController { @ApiOperation(value = "Gets the health from the E2 manager, expressed as the response code.") @RequestMapping(value = "/health", method = RequestMethod.GET) - public void getE2ManagerHealth(HttpServletResponse response) { - e2HealthCheckApi.healthGet(); - response.setStatus(e2HealthCheckApi.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); + } + } + + // 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 = "Gets the unique requests submitted to the E2 manager.", response = E2SetupResponse.class, responseContainer = "List") - @RequestMapping(value = "/setup", method = RequestMethod.GET) - public Iterable getRequests() { - logger.debug("getRequests"); - return responses; + @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 { + 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 GetNodebResponse getNb(@PathVariable(PP_RANNAME) String ranName) { + public Object getNb(@PathVariable(PP_RANNAME) String ranName) { logger.debug("getNb {}", ranName); - return e2NodebApi.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); + } } - // TODO replace with actual delete all RAN connections functionality - @ApiOperation(value = "Disconnect all RAN Connections.") - @RequestMapping(value = "/disconnectAllRAN", method = RequestMethod.DELETE) - public void disconnectAllRANConnections() { - logger.debug("disconnectAllRANConnections"); - responses.clear(); + @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.", response = E2SetupResponse.class) + @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.") @RequestMapping(value = "/endcSetup", method = RequestMethod.POST) - public E2SetupResponse endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { + public Object endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { logger.debug("endcSetup {}", setupRequest); - int responseCode = -1; try { - assertNotEmpty(setupRequest.getRanIp()); - assertNotEmpty(setupRequest.getRanName()); - assertNotNull(setupRequest.getRanPort()); e2NodebApi.endcSetup(setupRequest); - responseCode = e2NodebApi.getApiClient().getStatusCode().value(); - } catch (Exception ex) { - logger.warn("endcSetup failed", ex); - response.setStatus(HttpServletResponse.SC_BAD_REQUEST); - responseCode = HttpServletResponse.SC_BAD_REQUEST; + 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); } - E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.ENDC, setupRequest, responseCode); - responses.add(r); - return r; } - @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.", response = E2SetupResponse.class) + @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.") @RequestMapping(value = "/x2Setup", method = RequestMethod.POST) - public IDashboardResponse x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { + public Object x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { logger.debug("x2Setup {}", setupRequest); - int responseCode = -1; try { - assertNotEmpty(setupRequest.getRanIp()); - assertNotEmpty(setupRequest.getRanName()); - assertNotNull(setupRequest.getRanPort()); e2NodebApi.x2Setup(setupRequest); - responseCode = e2NodebApi.getApiClient().getStatusCode().value(); - } catch (Exception ex) { - logger.warn("x2Setup failed", ex); - response.setStatus(HttpServletResponse.SC_BAD_REQUEST); - responseCode = HttpServletResponse.SC_BAD_REQUEST; + 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); } - E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.X2, setupRequest, responseCode); - responses.add(r); - return r; } }