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=17e68fdc7b818c3037fc5fc6a16ab7e166939e08;hb=a16f2d04fa1af4fe1ea993133a1d106e7fa1da3d;hp=e2523982e694679aea92c96a637324d14050d85c;hpb=4d3a7c62ddcab6abc5ca45e6cabc90258025a768;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 e2523982..17e68fdc 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. @@ -29,6 +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.ResetRequest; import org.oransc.ric.e2mgr.client.model.SetupRequest; import org.oransc.ric.portal.dashboard.DashboardApplication; import org.oransc.ric.portal.dashboard.DashboardConstants; @@ -39,11 +40,12 @@ 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.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; @@ -52,10 +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. + * + * 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 @@ -66,14 +70,18 @@ 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 + /* 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"; @@ -91,12 +99,14 @@ public class E2ManagerController { @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(); @@ -106,9 +116,11 @@ 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