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=104cb1dbf597c9d9c46507ebd4c63afa1b6e3b45;hb=refs%2Fchanges%2F76%2F876%2F3;hp=ad75c88d325981f3db689a8b41bcc3406f65f7bd;hpb=93a44cb851a49c923126f32016646860d104075c;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 ad75c88d..104cb1db 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 @@ -29,7 +29,7 @@ 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.ResetRequest; import org.oransc.ric.e2mgr.client.model.SetupRequest; import org.oransc.ric.portal.dashboard.DashboardApplication; import org.oransc.ric.portal.dashboard.DashboardConstants; @@ -38,14 +38,14 @@ 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.MediaType; +import org.springframework.security.access.annotation.Secured; import org.springframework.util.Assert; -import org.springframework.web.bind.annotation.DeleteMapping; 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.RestController; @@ -54,13 +54,12 @@ import org.springframework.web.client.HttpStatusCodeException; import io.swagger.annotations.ApiOperation; /** - * 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.
+ * Proxies calls from the front end to the E2 Manager API. * - * In R1 the E2 interface does not yet implement the get-ID-list method, so this - * class mocks up some 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 @@ -71,14 +70,17 @@ public class E2ManagerController { // Publish paths in constants so tests are easy to write public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr"; - // Endpoints + // Dashboard only public static final String HEALTH_METHOD = "health"; - public static final String NODEB_METHOD = "/nodeb"; - public static final String NODEB_LIST_METHOD = "/nodeb-ids"; public static final String RAN_METHOD = "/ran"; - public static final String ENDC_SETUP_METHOD = "/endcSetup"; - public static final String X2_SETUP_METHOD = "/x2Setup"; public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD; + // Keep these consistent with the E2M implementation + public static final String NODEB_PREFIX = "/nodeb"; + public static final String NODEB_SHUTDOWN_METHOD = NODEB_PREFIX + "/shutdown"; + public static final String NODEB_LIST_METHOD = NODEB_PREFIX + "/ids"; + public static final String RESET_METHOD = "/reset"; + public static final String ENDC_SETUP_METHOD = NODEB_PREFIX + "/endc-setup"; + public static final String X2_SETUP_METHOD = NODEB_PREFIX + "/x2-setup"; // Path parameters private static final String PP_RANNAME = "ranName"; @@ -86,34 +88,24 @@ public class E2ManagerController { private final HealthCheckApi e2HealthCheckApi; private final NodebApi e2NodebApi; - // TODO: remove this when E2 delivers the feature - private final List mockNodebIdList; - @Autowired - public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi, - @Value("${e2mgr.mock.rannames:#{null}}") final String mockRanNames) { + 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; - 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) @GetMapping(VERSION_METHOD) + // No role required public SuccessTransport getClientVersion() { return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthCheckApi.class)); } @ApiOperation(value = "Gets the health from the E2 manager, expressed as the response code.") @GetMapping(HEALTH_METHOD) + // No role required public void healthGet(HttpServletResponse response) { logger.debug("healthGet"); e2HealthCheckApi.healthGet(); @@ -123,10 +115,10 @@ public class E2ManagerController { // 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(RAN_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public List getRanDetails() { logger.debug("getRanDetails"); - // TODO: remove mock when e2mgr delivers the getNodebIdList() method - List nodebIdList = mockNodebIdList.isEmpty() ? e2NodebApi.getNodebIdList() : mockNodebIdList; + List nodebIdList = e2NodebApi.getNodebIdList(); List details = new ArrayList<>(); for (NodebIdentity nbid : nodebIdList) { GetNodebResponse nbResp = null; @@ -145,28 +137,23 @@ public class E2ManagerController { @ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List") @GetMapping(NODEB_LIST_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public List getNodebIdList() { logger.debug("getNodebIdList"); return e2NodebApi.getNodebIdList(); } @ApiOperation(value = "Get RAN by name.", response = GetNodebResponse.class) - @GetMapping(NODEB_METHOD + "/{" + PP_RANNAME + "}") + @GetMapping(NODEB_SHUTDOWN_METHOD + "/{" + PP_RANNAME + "}") + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public GetNodebResponse getNb(@PathVariable(PP_RANNAME) String ranName) { logger.debug("getNb {}", ranName); return e2NodebApi.getNb(ranName); } - @ApiOperation(value = "Close all connections to the RANs and delete the data from the nodeb-rnib DB.") - @DeleteMapping(NODEB_METHOD) - public void nodebDelete(HttpServletResponse response) { - logger.debug("nodebDelete"); - e2NodebApi.nodebDelete(); - response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); - } - @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.") @PostMapping(ENDC_SETUP_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public void endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { logger.debug("endcSetup {}", setupRequest); e2NodebApi.endcSetup(setupRequest); @@ -175,10 +162,30 @@ public class E2ManagerController { @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.") @PostMapping(X2_SETUP_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public void x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) { logger.debug("x2Setup {}", setupRequest); e2NodebApi.x2Setup(setupRequest); response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); } + @ApiOperation(value = "Close all connections to the RANs and delete the data from the nodeb-rnib DB.") + @PutMapping(NODEB_SHUTDOWN_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void nodebShutdownPut(HttpServletResponse response) { + logger.debug("nodebShutdownPut"); + e2NodebApi.nodebShutdownPut(); + response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); + } + + @ApiOperation(value = "Abort any other ongoing procedures over X2 between the RIC and the RAN.") + @PutMapping(NODEB_PREFIX + "/{" + PP_RANNAME + "}"+ RESET_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void reset(@PathVariable(PP_RANNAME) String ranName, @RequestBody ResetRequest resetRequest, + HttpServletResponse response) { + logger.debug("reset"); + e2NodebApi.reset(ranName, resetRequest); + response.setStatus(e2NodebApi.getApiClient().getStatusCode().value()); + } + }