Upgrade E2Mgr spec to version 2.0.5 of 2019-09-11

[portal/ric-dashboard.git] / webapp-backend / src / main / java / org / oransc / ric / portal / dashboard / controller / E2ManagerController.java

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 b200c9a..104cb1d 100644 (file)
--- 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,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;
@@ -41,10 +42,10 @@ 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;
@@ -53,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: <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.
+ * 
+ * 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
@@ -67,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";
 
@@ -138,22 +144,13 @@ public class E2ManagerController {
        }
 
        @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)
-       @Secured({ DashboardConstants.ROLE_ADMIN })
-       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 })
@@ -172,4 +169,23 @@ public class E2ManagerController {
                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());
+       }
+
 }