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=749749f288de7ef42e3d1507c7f07a4453a774b4;hp=b3cdcbbf8c51dbdcc9b8007e5c25e60d2d82acbd;hpb=c95e48b5c8cdf93a351859889bb785b317253dde;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 b3cdcbbf..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
@@ -23,7 +23,6 @@ import java.lang.invoke.MethodHandles;
 
 import javax.servlet.http.HttpServletResponse;
 
-import org.oransc.ric.anrxapp.client.api.GnodebsApi;
 import org.oransc.ric.anrxapp.client.api.HealthApi;
 import org.oransc.ric.anrxapp.client.api.NcrtApi;
 import org.oransc.ric.anrxapp.client.model.GgNodeBTable;
@@ -37,59 +36,73 @@ 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
-@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xapp/anr", produces = MediaType.APPLICATION_JSON_VALUE)
+@RequestMapping(value = AnrXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
 public class AnrXappController {
 
 	private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
-	// Query parameters
-	private static final String QP_NODEB = "ggnodeb";
-	private static final String QP_SERVING = "servingCellNrcgi";
-	private static final String QP_NEIGHBOR = "neighborCellNrpci";
+	// Publish paths in constants so tests are easy to write
+	public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/anr";
+	// Endpoints
+	public static final String HEALTH_ALIVE_METHOD = "/health/alive";
+	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
-	private static final String PP_SERVING = "servingcells";
-	private static final String PP_NEIGHBOR = "neighborcells";
+	public static final String PP_SERVING = "servingcells";
+	public static final String PP_NEIGHBOR = "neighborcells";
 
 	// Populated by the autowired constructor
 	private final HealthApi healthApi;
-	private final GnodebsApi gnodebsApi;
 	private final NcrtApi ncrtApi;
 
 	@Autowired
-	public AnrXappController(final HealthApi healthApi, final GnodebsApi gnodebsApi, final NcrtApi ncrtApi) {
-		Assert.notNull(healthApi, "API must not be null");
-		Assert.notNull(gnodebsApi, "API must not be null");
-		Assert.notNull(ncrtApi, "API must not be null");
-		this.healthApi = healthApi;
-		this.gnodebsApi = gnodebsApi;
-		this.ncrtApi = ncrtApi;
+	public AnrXappController(final HealthApi anrHealthApi, final NcrtApi anrNcrtApi) {
+		Assert.notNull(anrHealthApi, "API must not be null");
+		Assert.notNull(anrNcrtApi, "API must not be null");
+		this.healthApi = anrHealthApi;
+		this.ncrtApi = anrNcrtApi;
+		if (logger.isDebugEnabled())
+			logger.debug("ctor: configured with client types {} and {}", anrHealthApi.getClass().getName(),
+					anrNcrtApi.getClass().getName());
 	}
 
 	@ApiOperation(value = "Gets the ANR client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
-	@RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
-	public SuccessTransport getVersion() {
-		logger.debug("getVersion enter");
+	@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 = RequestMethod.GET)
+	@GetMapping(HEALTH_ALIVE_METHOD)
+	// No role required
 	public void getHealthAlive(HttpServletResponse response) {
 		logger.debug("getHealthAlive");
 		healthApi.getHealthAlive();
@@ -97,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 = RequestMethod.GET)
+	@GetMapping(HEALTH_READY_METHOD)
+	// No role required
 	public void getHealthReady(HttpServletResponse response) {
 		logger.debug("getHealthReady");
 		healthApi.getHealthReady();
@@ -105,26 +119,29 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Returns list of gNodeB IDs based on NCRT in ANR", response = GgNodeBTable.class)
-	@RequestMapping(value = "/gnodebs", method = RequestMethod.GET)
+	@GetMapping(GNODEBS_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 	public GgNodeBTable getGnodebs() {
-		return gnodebsApi.getgNodeB();
+		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 = RequestMethod.GET)
-	public NeighborCellRelationTable getNcrtInfo( //
-			@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("getNcrtInfo: ggnbid {}, servingCellNrpci {} neighborCellNrcgi {}", ggnbId, servingCellNrcgi,
+	@GetMapping(NCRT_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+	public NeighborCellRelationTable getNcrt( //
+			@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.getNcrtInfo(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/" + 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) {
@@ -135,8 +152,8 @@ public class AnrXappController {
 	}
 
 	@ApiOperation(value = "Delete neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
-	@RequestMapping(value = "/ncrt/" + 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) {