Non-functional changes to silence Sonar

[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 a4533b6..ad75c88 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
@@ -42,10 +42,12 @@ import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.MediaType;
 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;
 
@@ -62,13 +64,21 @@ import io.swagger.annotations.ApiOperation;
  */
 @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<NodebIdentity> 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";
 
@@ -76,6 +86,9 @@ public class E2ManagerController {
        private final HealthCheckApi e2HealthCheckApi;
        private final NodebApi e2NodebApi;
 
+       // TODO: remove this when E2 delivers the feature
+       private final List<NodebIdentity> mockNodebIdList;
+
        @Autowired
        public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi,
                        @Value("${e2mgr.mock.rannames:#{null}}") final String mockRanNames) {
@@ -94,13 +107,13 @@ public class E2ManagerController {
        }
 
        @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)
+       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)
+       @GetMapping(HEALTH_METHOD)
        public void healthGet(HttpServletResponse response) {
                logger.debug("healthGet");
                e2HealthCheckApi.healthGet();
@@ -109,7 +122,7 @@ 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")
-       @RequestMapping(value = "/ran", method = RequestMethod.GET)
+       @GetMapping(RAN_METHOD)
        public List<RanDetailsTransport> getRanDetails() {
                logger.debug("getRanDetails");
                // TODO: remove mock when e2mgr delivers the getNodebIdList() method
@@ -131,21 +144,21 @@ public class E2ManagerController {
        }
 
        @ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List")
-       @RequestMapping(value = "/nodeb-ids", method = RequestMethod.GET)
+       @GetMapping(NODEB_LIST_METHOD)
        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)
+       @GetMapping(NODEB_METHOD + "/{" + PP_RANNAME + "}")
        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.")
-       @RequestMapping(value = "/nodeb", method = RequestMethod.DELETE)
+       @DeleteMapping(NODEB_METHOD)
        public void nodebDelete(HttpServletResponse response) {
                logger.debug("nodebDelete");
                e2NodebApi.nodebDelete();
@@ -153,7 +166,7 @@ public class E2ManagerController {
        }
 
        @ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.")
-       @RequestMapping(value = "/endcSetup", method = RequestMethod.POST)
+       @PostMapping(ENDC_SETUP_METHOD)
        public void endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
                logger.debug("endcSetup {}", setupRequest);
                e2NodebApi.endcSetup(setupRequest);
@@ -161,7 +174,7 @@ public class E2ManagerController {
        }
 
        @ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.")
-       @RequestMapping(value = "/x2Setup", method = RequestMethod.POST)
+       @PostMapping(X2_SETUP_METHOD)
        public void x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
                logger.debug("x2Setup {}", setupRequest);
                e2NodebApi.x2Setup(setupRequest);