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=749ecaeb28206623949c3b2b62feb15d6518d4cf;hb=6ae7be6cac43f44625e76ae65007d6372d59afdb;hp=97ea3344fe66726a91b532bcc3f75d48cbf37fdd;hpb=4d6f9a14931a6aaaab28b482d73380e0960a82d6;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 97ea3344..749ecaeb 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 @@ -2,7 +2,7 @@ * ========================LICENSE_START================================= * O-RAN-SC * %% - * Copyright (C) 2019 AT&T Intellectual Property and Nokia + * Copyright (C) 2019 AT&T Intellectual Property * %% * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,136 +20,192 @@ 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.ResetRequest; 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.config.E2ManagerApiBuilder; +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.context.annotation.Configuration; import org.springframework.http.MediaType; +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.PostMapping; +import org.springframework.web.bind.annotation.PutMapping; 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. * - * 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 functionality. + * 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. */ @Configuration @RestController -@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr", produces = MediaType.APPLICATION_JSON_VALUE) +@RequestMapping(value = E2ManagerController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE) public class E2ManagerController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - // Populated by the autowired constructor - private final HealthCheckApi e2HealthCheckApi; - private final NodebApi e2NodebApi; + // Publish paths in constants for tests + public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr"; + // Dashboard only + public static final String HEALTH_METHOD = "health"; + // Keep these consistent with the E2M implementation + /* package */ static final String NODEB_PREFIX = "nodeb"; + public static final String RAN_METHOD = NODEB_PREFIX + "/ran"; + public static final String NODEB_SHUTDOWN_METHOD = NODEB_PREFIX + "/shutdown"; + public static final String NODEB_LIST_METHOD = NODEB_PREFIX + "/ids"; + public static final String ENDC_SETUP_METHOD = NODEB_PREFIX + "/endc-setup"; + public static final String X2_SETUP_METHOD = NODEB_PREFIX + "/x2-setup"; + // Reset uses prefix, adds a path parameter below + public static final String RESET_METHOD = "reset"; + // Path parameters + private static final String PP_RANNAME = "ranName"; - // Stores the requests and results. - // TODO remove when the E2 manager is extended. - private Set responses = new HashSet<>(); + // Populated by the autowired constructor + private final E2ManagerApiBuilder e2ManagerApiBuilder; @Autowired - public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi) { - Assert.notNull(e2HealthCheckApi, "API must not be null"); - Assert.notNull(e2NodebApi, "API must not be null"); - this.e2HealthCheckApi = e2HealthCheckApi; - this.e2NodebApi = e2NodebApi; + public E2ManagerController(final E2ManagerApiBuilder e2ManagerApiBuilder) { + Assert.notNull(e2ManagerApiBuilder, "builder must not be null"); + this.e2ManagerApiBuilder = e2ManagerApiBuilder; + if (logger.isDebugEnabled()) + logger.debug("ctor: configured with builder type {}", e2ManagerApiBuilder.getClass().getName()); } - private void assertNotNull(Object o) { - if (o == null) - throw new IllegalArgumentException("Null not permitted"); + @ApiOperation(value = "Gets the E2 manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) + @GetMapping(DashboardConstants.VERSION_METHOD) + // No role required + public SuccessTransport getClientVersion() { + return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthCheckApi.class)); } - private void assertNotEmpty(String s) { - assertNotNull(s); - if (s.isEmpty()) - throw new IllegalArgumentException("Empty not permitted"); + @ApiOperation(value = "Gets the health from the E2 manager, expressed as the response code.") + @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + HEALTH_METHOD) + // No role required + public void healthGet(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + HttpServletResponse response) { + logger.debug("healthGet instance {}", instanceKey); + HealthCheckApi api = e2ManagerApiBuilder.getHealthCheckApi(instanceKey); + api.healthGet(); + response.setStatus(api.getApiClient().getStatusCode().value()); } - @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 getVersion() { - logger.debug("getVersion enter"); - return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthCheckApi.class)); + // 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") + @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + RAN_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) + public List getRanDetails( + @PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) { + logger.debug("getRanDetails instance {}", instanceKey); + NodebApi api = e2ManagerApiBuilder.getNodebApi(instanceKey); + List nodebIdList = api.getNodebIdList(); + logger.debug("getRanDetails: nodebIdList {}", nodebIdList); + List details = new ArrayList<>(); + for (NodebIdentity nbid : nodebIdList) { + GetNodebResponse nbResp = null; + try { + // Catch exceptions to keep looping despite failures + nbResp = api.getNb(nbid.getInventoryName()); + } catch (HttpStatusCodeException ex) { + logger.warn("E2 getNb 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 health from the E2 manager, expressed as the response code.") - @RequestMapping(value = "/health", method = RequestMethod.GET) - public void getHealth(HttpServletResponse response) { - logger.debug("getHealth"); - e2HealthCheckApi.healthGet(); - response.setStatus(e2HealthCheckApi.getApiClient().getStatusCode().value()); + @ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List") + @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + + NODEB_LIST_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) + public List getNodebIdList(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) { + logger.debug("getNodebIdList instance {}", instanceKey); + return e2ManagerApiBuilder.getNodebApi(instanceKey).getNodebIdList(); } - @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 by name.", response = GetNodebResponse.class) + @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + NODEB_PREFIX + + "/{" + PP_RANNAME + "}") + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) + public GetNodebResponse getNb(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + @PathVariable(PP_RANNAME) String ranName) { + logger.debug("getNb instance {} name {}", instanceKey, ranName); + return e2ManagerApiBuilder.getNodebApi(instanceKey).getNb(ranName); } - @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.", response = E2SetupResponse.class) - @RequestMapping(value = "/endcSetup", method = RequestMethod.POST) - public E2SetupResponse 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; - } - E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.ENDC, setupRequest, responseCode); - responses.add(r); - return r; + @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.") + @PostMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + + ENDC_SETUP_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void endcSetup(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + @RequestBody SetupRequest setupRequest, HttpServletResponse response) { + logger.debug("endcSetup instance {} request {}", instanceKey, setupRequest); + NodebApi api = e2ManagerApiBuilder.getNodebApi(instanceKey); + api.endcSetup(setupRequest); + response.setStatus(api.getApiClient().getStatusCode().value()); } - @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.", response = E2SetupResponse.class) - @RequestMapping(value = "/x2Setup", method = RequestMethod.POST) - public IDashboardResponse 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; - } - E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.X2, setupRequest, responseCode); - responses.add(r); - return r; + @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.") + @PostMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + + X2_SETUP_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void x2Setup(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + @RequestBody SetupRequest setupRequest, HttpServletResponse response) { + logger.debug("x2Setup instance {} request {}", instanceKey, setupRequest); + NodebApi api = e2ManagerApiBuilder.getNodebApi(instanceKey); + api.x2Setup(setupRequest); + response.setStatus(api.getApiClient().getStatusCode().value()); + } + + @ApiOperation(value = "Close all connections to the RANs and delete the data from the nodeb-rnib DB.") + @PutMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + + NODEB_SHUTDOWN_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void nodebShutdownPut(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + HttpServletResponse response) { + logger.debug("nodebShutdownPut instance {}", instanceKey); + NodebApi api = e2ManagerApiBuilder.getNodebApi(instanceKey); + api.nodebShutdownPut(); + response.setStatus(api.getApiClient().getStatusCode().value()); + } + + @ApiOperation(value = "Abort any other ongoing procedures over X2 between the RIC and the RAN.") + @PutMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/" + NODEB_PREFIX + + "/{" + PP_RANNAME + "}/" + RESET_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void reset(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, + @PathVariable(PP_RANNAME) String ranName, @RequestBody ResetRequest resetRequest, + HttpServletResponse response) { + logger.debug("reset instance {} name {}", instanceKey, ranName); + NodebApi api = e2ManagerApiBuilder.getNodebApi(instanceKey); + api.reset(ranName, resetRequest); + response.setStatus(api.getApiClient().getStatusCode().value()); } }