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%2FAppManagerController.java;h=041574629bce77475f0ae298ba6207edc7eaffef;hb=44203c43bb16a87eb54cc97431a026e111842c97;hp=9c356ca0983e08f18f23bcc7cbe06e192400accc;hpb=226fd436a085f717d4cbf81bf1719bdaf1468414;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AppManagerController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AppManagerController.java index 9c356ca0..04157462 100644 --- a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AppManagerController.java +++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AppManagerController.java @@ -2,7 +2,7 @@ * ========================LICENSE_START================================= * O-RAN-SC * %% - * Copyright (C) 2019 AT&T Intellectual Property and Nokia + * Copyright (C) 2019 AT&T Intellectual Property * %% * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,27 +42,46 @@ 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.PostMapping; +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 io.swagger.annotations.ApiOperation; /** - * Proxies calls from the front end to the App Manager 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 App Manager 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. */ @Configuration @RestController -@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/appmgr", produces = MediaType.APPLICATION_JSON_VALUE) +@RequestMapping(value = AppManagerController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE) public class AppManagerController { 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 + "/appmgr"; + // Endpoints + public static final String HEALTH_ALIVE_METHOD = "/health/alive"; + public static final String HEALTH_READY_METHOD = "/health/ready"; + public static final String CONFIG_METHOD = "/config"; + public static final String XAPPS_METHOD = "/xapps"; + public static final String XAPPS_LIST_METHOD = XAPPS_METHOD + "/list"; + public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD; + // Path parameters + public static final String PP_XAPP_NAME = "xAppName"; + // Populated by the autowired constructor private final HealthApi healthApi; private final XappApi xappApi; @@ -79,13 +98,15 @@ public class AppManagerController { } @ApiOperation(value = "Gets the XApp manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) - @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET) - public SuccessTransport getXappManagerClientVersion() { + @GetMapping(VERSION_METHOD) + // No role required + public SuccessTransport getClientVersion() { return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class)); } @ApiOperation(value = "Health check of xApp Manager - Liveness probe.") - @RequestMapping(value = "/health/alive", method = RequestMethod.GET) + @GetMapping(HEALTH_ALIVE_METHOD) + // No role required public void getHealth(HttpServletResponse response) { logger.debug("getHealthAlive"); healthApi.getHealthAlive(); @@ -93,7 +114,8 @@ public class AppManagerController { } @ApiOperation(value = "Readiness check of xApp Manager - Readiness probe.") - @RequestMapping(value = "/health/ready", method = RequestMethod.GET) + @GetMapping(HEALTH_READY_METHOD) + // No role required public void getHealthReady(HttpServletResponse response) { logger.debug("getHealthReady"); healthApi.getHealthReady(); @@ -101,28 +123,32 @@ public class AppManagerController { } @ApiOperation(value = "Returns the configuration of all xapps.", response = AllXappConfig.class) - @RequestMapping(value = "/config", method = RequestMethod.GET) + @GetMapping(CONFIG_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public AllXappConfig getAllXappConfig() { logger.debug("getAllXappConfig"); return xappApi.getAllXappConfig(); } @ApiOperation(value = "Create xApp config.", response = XAppConfig.class) - @RequestMapping(value = "/config", method = RequestMethod.POST) + @PostMapping(CONFIG_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public XAppConfig createXappConfig(@RequestBody XAppConfig xAppConfig) { logger.debug("createXappConfig {}", xAppConfig); return xappApi.createXappConfig(xAppConfig); } @ApiOperation(value = "Modify xApp config.", response = XAppConfig.class) - @RequestMapping(value = "/config", method = RequestMethod.PUT) + @PutMapping(CONFIG_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public XAppConfig modifyXappConfig(@RequestBody XAppConfig xAppConfig) { logger.debug("modifyXappConfig {}", xAppConfig); return xappApi.modifyXappConfig(xAppConfig); } @ApiOperation(value = "Delete xApp configuration.") - @RequestMapping(value = "/config/{xAppName}", method = RequestMethod.DELETE) + @DeleteMapping(CONFIG_METHOD + "/{" + PP_XAPP_NAME + "}") + @Secured({ DashboardConstants.ROLE_ADMIN }) public void deleteXappConfig(@RequestBody ConfigMetadata configMetadata, HttpServletResponse response) { logger.debug("deleteXappConfig {}", configMetadata); xappApi.deleteXappConfig(configMetadata); @@ -130,10 +156,11 @@ public class AppManagerController { } @ApiOperation(value = "Returns a list of deployable xapps.", response = DashboardDeployableXapps.class) - @RequestMapping(value = "/xapps/list", method = RequestMethod.GET) - public DashboardDeployableXapps getAvailableXapps() { + @GetMapping(XAPPS_LIST_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) + public Object getAvailableXapps() { logger.debug("getAvailableXapps"); - AllDeployableXapps appNames = xappApi.listAllXapps(); + AllDeployableXapps appNames = xappApi.listAllDeployableXapps(); // Answer a collection of structure instead of string // because I expect the AppMgr to be extended with // additional properties for each one. @@ -144,32 +171,36 @@ public class AppManagerController { } @ApiOperation(value = "Returns the status of all deployed xapps.", response = AllDeployedXapps.class) - @RequestMapping(value = "/xapps", method = RequestMethod.GET) + @GetMapping(XAPPS_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public AllDeployedXapps getDeployedXapps() { logger.debug("getDeployedXapps"); return xappApi.getAllXapps(); } @ApiOperation(value = "Returns the status of a given xapp.", response = Xapp.class) - @RequestMapping(value = "/xapps/{xAppName}", method = RequestMethod.GET) + @GetMapping(XAPPS_METHOD + "/{" + PP_XAPP_NAME + "}") + @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD }) public Xapp getXapp(@PathVariable("xAppName") String xAppName) { logger.debug("getXapp {}", xAppName); return xappApi.getXappByName(xAppName); } @ApiOperation(value = "Deploy a xapp.", response = Xapp.class) - @RequestMapping(value = "/xapps", method = RequestMethod.POST) + @PostMapping(XAPPS_METHOD) + @Secured({ DashboardConstants.ROLE_ADMIN }) public Xapp deployXapp(@RequestBody XAppInfo xAppInfo) { logger.debug("deployXapp {}", xAppInfo); return xappApi.deployXapp(xAppInfo); } @ApiOperation(value = "Undeploy an existing xapp.") - @RequestMapping(value = "/xapps/{xAppName}", method = RequestMethod.DELETE) + @DeleteMapping(XAPPS_METHOD + "/{" + PP_XAPP_NAME + "}") + @Secured({ DashboardConstants.ROLE_ADMIN }) public void undeployXapp(@PathVariable("xAppName") String xAppName, HttpServletResponse response) { logger.debug("undeployXapp {}", xAppName); xappApi.undeployXapp(xAppName); - response.setStatus(healthApi.getApiClient().getStatusCode().value()); + response.setStatus(xappApi.getApiClient().getStatusCode().value()); } }