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%2FAnrXappController.java;h=ae6845bb71d075be08703dafcc2d8d5458bd8ca0;hb=c7a3ec6561b3b2ce1facbec092305977c3eba665;hp=e33b355cc123e0cdefb80beec1d7e3188cbe4d91;hpb=3340ea073fd56431b2d1231bda17cd98765fd8eb;p=portal%2Fric-dashboard.git

diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java
index e33b355c..ae6845bb 100644
--- a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java
+++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java
@@ -36,19 +36,27 @@ 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.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.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import io.swagger.annotations.ApiOperation;
 
 /**
- * Provides methods to contact the ANR xApp which manages a Neighbor Cell
- * Relation Table (NCRT).
+ * Proxies calls from the front end to the ANR xApp, which manages a Neighbor
+ * Cell Relation Table (NCRT).
+ * 
+ * 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
@@ -64,13 +72,11 @@ public class AnrXappController {
 	public static final String HEALTH_READY_METHOD = "/health/ready";
 	public static final String GNODEBS_METHOD = "/gnodebs";
 	public static final String NCRT_METHOD = "/ncrt";
+	public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
+
 	// Path parameters
 	public static final String PP_SERVING = "servingcells";
 	public static final String PP_NEIGHBOR = "neighborcells";
-	// Query parameters
-	public static final String QP_NODEB = "ggnodeb";
-	public static final String QP_SERVING = "servingCellNrcgi";
-	public static final String QP_NEIGHBOR = "neighborCellNrpci";
 
 	// Populated by the autowired constructor
 	private final HealthApi healthApi;
@@ -88,13 +94,15 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Gets the ANR client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
-	@RequestMapping(value = DashboardConstants.VERSION_METHOD, method = RequestMethod.GET)
-	public SuccessTransport getAnrXappClientVersion() {
+	@GetMapping(VERSION_METHOD)
+	// No role required
+	public SuccessTransport getClientVersion() {
 		return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class));
 	}
 
 	@ApiOperation(value = "Performs a liveness probe on the ANR xApp, result expressed as the response code.")
-	@RequestMapping(value = HEALTH_ALIVE_METHOD, method = RequestMethod.GET)
+	@GetMapping(HEALTH_ALIVE_METHOD)
+	// No role required
 	public void getHealthAlive(HttpServletResponse response) {
 		logger.debug("getHealthAlive");
 		healthApi.getHealthAlive();
@@ -102,7 +110,8 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Performs a readiness probe on the ANR xApp, result expressed as the response code.")
-	@RequestMapping(value = HEALTH_READY_METHOD, method = RequestMethod.GET)
+	@GetMapping(HEALTH_READY_METHOD)
+	// No role required
 	public void getHealthReady(HttpServletResponse response) {
 		logger.debug("getHealthReady");
 		healthApi.getHealthReady();
@@ -110,27 +119,29 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Returns list of gNodeB IDs based on NCRT in ANR", response = GgNodeBTable.class)
-	@RequestMapping(value = GNODEBS_METHOD, method = RequestMethod.GET)
+	@GetMapping(GNODEBS_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 	public GgNodeBTable getGnodebs() {
 		logger.debug("getGnodebs");
 		return ncrtApi.getgNodeB();
 	}
 
 	@ApiOperation(value = "Returns neighbor cell relation table for all gNodeBs or based on query parameters", response = NeighborCellRelationTable.class)
-	@RequestMapping(value = NCRT_METHOD, method = RequestMethod.GET)
+	@GetMapping(NCRT_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 	public NeighborCellRelationTable getNcrt( //
-			@RequestParam(name = QP_NODEB, required = false) String ggnbId, //
-			@RequestParam(name = QP_SERVING, required = false) String servingCellNrcgi, //
-			@RequestParam(name = QP_NEIGHBOR, required = false) String neighborCellNrpci) {
-		logger.debug("getNcrt: ggnbid {}, servingCellNrpci {}, neighborCellNrcgi {}", ggnbId, servingCellNrcgi,
+			@RequestParam(required = false) String ggnodeb, //
+			@RequestParam(required = false) String servingCellNrcgi, //
+			@RequestParam(required = false) String neighborCellNrpci) {
+		logger.debug("getNcrt: ggnbid {}, servingCellNrpci {}, neighborCellNrcgi {}", ggnodeb, servingCellNrcgi,
 				neighborCellNrpci);
-		return ncrtApi.getNcrt(ggnbId, servingCellNrcgi, neighborCellNrpci);
+		return ncrtApi.getNcrt(ggnodeb, servingCellNrcgi, neighborCellNrpci);
 	}
 
 	// /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} :
 	@ApiOperation(value = "Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
-	@RequestMapping(value = NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR
-			+ "}", method = RequestMethod.PUT)
+	@PutMapping(NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + "}")
+	@Secured({ DashboardConstants.ROLE_ADMIN })
 	public void modifyNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
 			@PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
 			@RequestBody NeighborCellRelationMod ncrMod, HttpServletResponse response) {
@@ -141,8 +152,8 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Delete neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
-	@RequestMapping(value = NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR
-			+ "}", method = RequestMethod.DELETE)
+	@DeleteMapping(NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + "}")
+	@Secured({ DashboardConstants.ROLE_ADMIN })
 	public void deleteNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
 			@PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
 			HttpServletResponse response) {