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=55b42124dc9fc35f344816ab44bfbe41fea369a5;hb=refs%2Fchanges%2F37%2F537%2F12;hp=dae8ae25ef3a252c6bcfe941fae09e8c1612a62a;hpb=52d66fff0881226fe6ae0b1a2cd6c2c2e2837af4;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 dae8ae25..55b42124 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,11 +36,14 @@ 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;
 
@@ -52,59 +55,79 @@ import io.swagger.annotations.ApiOperation;
  */
 @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";
+	// 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;
 	private final NcrtApi ncrtApi;
 
 	@Autowired
-	public AnrXappController(final HealthApi healthApi, final NcrtApi ncrtApi) {
-		Assert.notNull(healthApi, "API must not be null");
-		Assert.notNull(ncrtApi, "API must not be null");
-		this.healthApi = healthApi;
-		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 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 = RequestMethod.GET)
-	public void getAnrXappHealthAlive(HttpServletResponse response) {
+	@GetMapping(HEALTH_ALIVE_METHOD)
+	// No role required
+	public void getHealthAlive(HttpServletResponse response) {
+		logger.debug("getHealthAlive");
 		healthApi.getHealthAlive();
 		response.setStatus(healthApi.getApiClient().getStatusCode().value());
 	}
 
 	@ApiOperation(value = "Performs a readiness probe on the ANR xApp, result expressed as the response code.")
-	@RequestMapping(value = "/health/ready", method = RequestMethod.GET)
-	public void getAnrXappHealthReady(HttpServletResponse response) {
+	@GetMapping(HEALTH_READY_METHOD)
+	// No role required
+	public void getHealthReady(HttpServletResponse response) {
+		logger.debug("getHealthReady");
 		healthApi.getHealthReady();
 		response.setStatus(healthApi.getApiClient().getStatusCode().value());
 	}
 
 	@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() {
+		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)
+	@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, //
@@ -116,8 +139,8 @@ public class AnrXappController {
 
 	// /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) {
@@ -128,8 +151,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) {