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%2FAcXappController.java;h=7b97ca0eef6d393eee6268a9e3087a1bc3adea5f;hb=bf91f764c67001c4cad28075a38fd9196744c041;hp=859efb8d039f9050f4d9209ad82dd7a51c1f2cae;hpb=2239b1d982aafe5e7dce4dbbec5100f3e3191249;p=portal%2Fric-dashboard.git

diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AcXappController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AcXappController.java
index 859efb8d..7b97ca0e 100644
--- a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AcXappController.java
+++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AcXappController.java
@@ -31,11 +31,12 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
+import org.springframework.security.access.annotation.Secured;
 import org.springframework.util.Assert;
-import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.GetMapping;
+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.RestController;
 
 import com.fasterxml.jackson.databind.JsonNode;
@@ -44,16 +45,27 @@ import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
 
 /**
- * Provides methods to manage policies of the Admission Control xApp. All
- * messages go via the A1 Mediatior.
+ * Proxies calls from the front end to the AC xApp via the A1 Mediator 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.
  */
 @RestController
-@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac", produces = MediaType.APPLICATION_JSON_VALUE)
+@RequestMapping(value = AcXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
 public class AcXappController {
 
 	private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
-	private static final String POLICY_NAME = "policyname";
+	// Publish paths in constants so tests are easy to write
+	public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/admctl";
+	// Endpoints
+	public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
+	public static final String POLICY_METHOD = "policy";
+
+	// A "control" is an element in the XApp descriptor
+	private static final String AC_CONTROL_NAME = "admission_control_policy";
 
 	// Populated by the autowired constructor
 	private final A1MediatorApi a1MediatorApi;
@@ -62,30 +74,41 @@ public class AcXappController {
 	public AcXappController(final A1MediatorApi a1MediatorApi) {
 		Assert.notNull(a1MediatorApi, "API must not be null");
 		this.a1MediatorApi = a1MediatorApi;
+		if (logger.isDebugEnabled())
+			logger.debug("ctor: configured with client type {}", a1MediatorApi.getClass().getName());
 	}
 
 	@ApiOperation(value = "Gets the A1 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 getA1MediatorClientVersion() {
 		return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
 	}
 
-	@ApiOperation(value = "Gets the named policy for AC xApp via the A1 Mediator")
-	@RequestMapping(value = "policy/{" + POLICY_NAME + "}", method = RequestMethod.GET)
-	public Object getPolicy(@PathVariable(POLICY_NAME) String policyName) {
-		logger.debug("getPolicy: policy {}", policyName);
-		a1MediatorApi.a1ControllerGetHandler(policyName);
+	/*
+	 * This controller is deliberately kept ignorant of the data expected by AC. The
+	 * fields are defined in the ACAdmissionIntervalControl Typescript interface.
+	 */
+	@ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator")
+	@GetMapping(POLICY_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+	public Object getAdmissionControlPolicy(HttpServletResponse response) {
+		logger.debug("getAdmissionControlPolicy");
+		response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
 		return null;
 	}
 
-	@ApiOperation(value = "Sets the named policy for AC xApp via the A1 Mediator")
-	@RequestMapping(value = "policy/{" + POLICY_NAME + "}", method = RequestMethod.PUT)
-	public void putPolicy(@PathVariable(POLICY_NAME) String policyName, //
-			@ApiParam(value = "JSON formatted policy") @RequestBody JsonNode policy, //
+	/*
+	 * This controller is deliberately kept ignorant of the data expected by AC. The
+	 * fields are defined in the ACAdmissionIntervalControl Typescript interface.
+	 */
+	@ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
+	@PutMapping(POLICY_METHOD)
+	@Secured({ DashboardConstants.ROLE_ADMIN })
+	public void putAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, //
 			HttpServletResponse response) {
-		logger.debug("putPolicy: policy {}", policyName);
-		a1MediatorApi.a1ControllerPutHandler(policyName, policy);
+		logger.debug("putAdmissionControlPolicy {}", acPolicy);
+		a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy);
 		response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());
 	}