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=6b79976523018d41b3643b15deeb6706ad4daa6e;hp=a23dc9ddacf7316180db1fb0de5f89d037d47f60;hpb=b8f4e986970eab6cfa5729c24680f2816f056edb;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 a23dc9dd..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,10 +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.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; @@ -43,10 +45,12 @@ import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; /** - * * Proxies calls from the front end to the AC xApp via the A1 Mediator API. - * All methods answer 502 on failure:
HTTP server received an - * invalid response from a server it consulted when acting as a proxy or - * gateway.
+ * 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 = AcXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE) @@ -55,10 +59,10 @@ public class AcXappController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); // Publish paths in constants so tests are easy to write - public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac"; + public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/admctl"; // Endpoints - public static final String ADMCTRL_METHOD = "/admctrl"; 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"; @@ -75,16 +79,19 @@ public class AcXappController { } @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) - @RequestMapping(value = VERSION_METHOD, method = RequestMethod.GET) + @GetMapping(VERSION_METHOD) + // No role required public SuccessTransport getA1MediatorClientVersion() { return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class)); } /* - * GET policy is not supported at present by A1 Mediator! Always returns 501. + * 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") - @RequestMapping(value = ADMCTRL_METHOD, method = RequestMethod.GET) + @GetMapping(POLICY_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public Object getAdmissionControlPolicy(HttpServletResponse response) { logger.debug("getAdmissionControlPolicy"); response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED); @@ -96,10 +103,11 @@ public class AcXappController { * fields are defined in the ACAdmissionIntervalControl Typescript interface. */ @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator") - @RequestMapping(value = ADMCTRL_METHOD, method = RequestMethod.PUT) - public void setAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, // + @PutMapping(POLICY_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) + public void putAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, // HttpServletResponse response) { - logger.debug("setAdmissionControlPolicy {}", acPolicy); + logger.debug("putAdmissionControlPolicy {}", acPolicy); a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy); response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value()); }