X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=webapp-backend%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fric%2Fportal%2Fdashboard%2Fcontroller%2FE2ManagerController.java;h=b200c9a864e98a454cb1fec9b5b8aa1c7449a93c;hb=c0dbfbc9c6268d8a8bea989daffb3a5065e820aa;hp=6b621f4fd132141f245420cfb16f434db94a6416;hpb=5b686151904e2582ea9ce9d2f1c6abb7a400afa5;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 6b621f4f..b200c9a8 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,26 +29,24 @@ 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.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.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.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;
@@ -59,19 +57,24 @@ import io.swagger.annotations.ApiOperation;
* 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.
- *
- * In R1 the E2 interface does not yet implement the get-ID-list method, so this
- * class mocks up some functionality.
*/
@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());
- private final List mockNodebIdList;
-
+ // Publish paths in constants so tests are easy to write
+ public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr";
+ // Endpoints
+ 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;
// Path parameters
private static final String PP_RANNAME = "ranName";
@@ -80,65 +83,44 @@ public class E2ManagerController {
private final NodebApi e2NodebApi;
@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)
- @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
- public SuccessTransport getE2ManagerClientVersion() {
+ @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.")
- @RequestMapping(value = "/health", method = RequestMethod.GET)
- public Object healthGet(HttpServletResponse response) {
+ @GetMapping(HEALTH_METHOD)
+ // No role required
+ public void 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);
- }
+ e2HealthCheckApi.healthGet();
+ response.setStatus(e2HealthCheckApi.getApiClient().getStatusCode().value());
}
// 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() {
+ @GetMapping(RAN_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+ public List 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 nodebIdList = e2NodebApi.getNodebIdList();
List details = new ArrayList<>();
for (NodebIdentity nbid : nodebIdList) {
GetNodebResponse nbResp = null;
try {
- // Keep looping despite failures
+ // Catch exceptions to keep looping despite failures
nbResp = e2NodebApi.getNb(nbid.getInventoryName());
} catch (HttpStatusCodeException ex) {
- logger.warn("getRanDetails failed for name {}: {}", nbid.getInventoryName(), ex.toString());
+ logger.warn("E2 getNb failed for name {}: {}", nbid.getInventoryName(), ex.toString());
nbResp = new GetNodebResponse().connectionStatus("UNKNOWN").ip("UNKNOWN").port(-1)
.ranName(nbid.getInventoryName());
}
@@ -148,74 +130,46 @@ public class E2ManagerController {
}
@ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List")
- @RequestMapping(value = "/nodeb/id", method = RequestMethod.GET)
- public Object getNodebIdList() {
+ @GetMapping(NODEB_LIST_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+ public List 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);
- }
+ return e2NodebApi.getNodebIdList();
}
@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) {
+ @GetMapping(NODEB_METHOD + "/{" + PP_RANNAME + "}")
+ @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+ public GetNodebResponse 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);
- }
+ return e2NodebApi.getNb(ranName);
}
@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) {
+ @DeleteMapping(NODEB_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN })
+ public void 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);
- }
+ e2NodebApi.nodebDelete();
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
@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) {
+ @PostMapping(ENDC_SETUP_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN })
+ public void 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);
- }
+ e2NodebApi.endcSetup(setupRequest);
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
@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) {
+ @PostMapping(X2_SETUP_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN })
+ public void x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
logger.debug("x2Setup {}", setupRequest);
- try {
- 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);
- }
+ e2NodebApi.x2Setup(setupRequest);
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
}