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.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.http.ResponseEntity;
+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;
/**
- * Proxies calls from the front end to the E2 Manager API. All methods answer
- * 502 on failure: <blockquote>HTTP server received an invalid response from a
- * server it consulted when acting as a proxy or gateway.</blockquote>
+ * Proxies calls from the front end to the E2 Manager API.
*
- * As of this writing the E2 interface does not support get-all, 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());
+ // Publish paths in constants so tests are easy to write
+ public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr";
+ // Dashboard only
+ public static final String HEALTH_METHOD = "health";
+ 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";
private final HealthCheckApi e2HealthCheckApi;
private final NodebApi e2NodebApi;
- // Stores the requests and results.
- // TODO remove when the E2 manager is extended.
- private Set<E2SetupResponse> responses = new HashSet<>();
-
@Autowired
public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi) {
Assert.notNull(e2HealthCheckApi, "API must not be null");
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");
- }
-
@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 ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString());
+ 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")
+ @GetMapping(RAN_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+ public List<RanDetailsTransport> getRanDetails() {
+ logger.debug("getRanDetails");
+ List<NodebIdentity> nodebIdList = e2NodebApi.getNodebIdList();
+ logger.debug("getRanDetails: nodebIdList {}", nodebIdList);
+ List<RanDetailsTransport> details = new ArrayList<>();
+ for (NodebIdentity nbid : nodebIdList) {
+ GetNodebResponse nbResp = null;
+ try {
+ // Catch exceptions to keep looping despite failures
+ nbResp = e2NodebApi.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;
}
- // TODO replace with actual functionality
- @ApiOperation(value = "Gets the unique requests submitted to the E2 manager.", response = E2SetupResponse.class, responseContainer = "List")
- @RequestMapping(value = "/setup", method = RequestMethod.GET)
- public Iterable<E2SetupResponse> getRequests() {
- logger.debug("getRequests");
- return responses;
+ @ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List")
+ @GetMapping(NODEB_LIST_METHOD)
+ @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+ public List<NodebIdentity> getNodebIdList() {
+ logger.debug("getNodebIdList");
+ 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_SHUTDOWN_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 ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString());
- }
- }
-
- // TODO replace with actual functionality
- @ApiOperation(value = "Disconnect all RAN Connections.")
- @RequestMapping(value = "/disconnectAllRAN", method = RequestMethod.DELETE)
- public void disconnectAllRANConnections() {
- logger.debug("disconnectAllRANConnections");
- responses.clear();
+ return e2NodebApi.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 Object endcSetup(@RequestBody SetupRequest setupRequest) {
+ @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);
- try {
- assertNotEmpty(setupRequest.getRanIp());
- assertNotEmpty(setupRequest.getRanName());
- assertNotNull(setupRequest.getRanPort());
- } catch (Exception ex) {
- return new E2SetupResponse(E2SetupRequestType.ENDC, setupRequest, HttpServletResponse.SC_BAD_REQUEST);
- }
- try {
- e2NodebApi.endcSetup(setupRequest);
- E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.ENDC, setupRequest,
- e2NodebApi.getApiClient().getStatusCode().value());
- responses.add(r);
- return r;
- } catch (HttpStatusCodeException ex) {
- logger.warn("endcSetup failed: {}", ex.toString());
- return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString());
- }
+ e2NodebApi.endcSetup(setupRequest);
+ response.setStatus(e2NodebApi.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 Object x2Setup(@RequestBody SetupRequest setupRequest) {
+ @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);
- try {
- assertNotEmpty(setupRequest.getRanIp());
- assertNotEmpty(setupRequest.getRanName());
- assertNotNull(setupRequest.getRanPort());
- } catch (Exception ex) {
- return new E2SetupResponse(E2SetupRequestType.ENDC, setupRequest, HttpServletResponse.SC_BAD_REQUEST);
- }
- try {
- e2NodebApi.x2Setup(setupRequest);
- E2SetupResponse r = new E2SetupResponse(E2SetupRequestType.X2, setupRequest,
- e2NodebApi.getApiClient().getStatusCode().value());
- responses.add(r);
- return r;
- } catch (HttpStatusCodeException ex) {
- logger.warn("x2Setup failed: {}", ex.toString());
- return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString());
- }
+ 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());
}
}
Code Review / portal / ric-dashboard.git / blobdiff