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=655b47aae52b1ead4d1d02ef29849dc6056d33e9;hb=3f812ea25d352ec33d07f5ffa4c2aa2a77e8e793;hp=c1aac8f3073f1e2f181f328340cccb1285274904;hpb=39d82c359a22483a74532f76c8d1696aa909478c;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 c1aac8f3..655b47aa 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,15 +45,23 @@ import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; /** - * Provides methods to manage policies of the Admission Control xApp, which - * initially defines just one. All requests go via the A1 Mediatior. + * * 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.
*/ @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()); + // Publish paths in constants so tests are easy to write + public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac"; + // Endpoints + public static final String ADMCTRL_METHOD = "/admctrl"; + public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD; + // A "control" is an element in the XApp descriptor private static final String AC_CONTROL_NAME = "admission_control_policy"; @@ -62,12 +72,14 @@ 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)); } @@ -75,19 +87,21 @@ public class AcXappController { * GET policy is not supported at present by A1 Mediator! Always returns 501. */ @ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator") - @RequestMapping(value = "admctrl", method = RequestMethod.GET) - public Object getAdmissionControlPolicy() { + @GetMapping(ADMCTRL_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) + public Object getAdmissionControlPolicy(HttpServletResponse response) { logger.debug("getAdmissionControlPolicy"); - a1MediatorApi.a1ControllerGetHandler(AC_CONTROL_NAME); + response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED); return null; } /* - * This controller is deliberately kept ignorant of the - * ACAdmissionIntervalControl Typescript interface. + * 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") - @RequestMapping(value = "admctrl", method = RequestMethod.PUT) + @PutMapping(ADMCTRL_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public void setAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, // HttpServletResponse response) { logger.debug("setAdmissionControlPolicy {}", acPolicy);