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: <blockquote>HTTP server received an invalid response from a
- * server it consulted when acting as a proxy or gateway.</blockquote>
+ * 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
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";
}
@ApiOperation(value = "Gets the XApp manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
- @RequestMapping(value = DashboardConstants.VERSION_METHOD, 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, method = RequestMethod.GET)
+ @GetMapping(HEALTH_ALIVE_METHOD)
+ // No role required
public void getHealth(HttpServletResponse response) {
logger.debug("getHealthAlive");
healthApi.getHealthAlive();
}
@ApiOperation(value = "Readiness check of xApp Manager - Readiness probe.")
- @RequestMapping(value = HEALTH_READY_METHOD, method = RequestMethod.GET)
+ @GetMapping(HEALTH_READY_METHOD)
+ // No role required
public void getHealthReady(HttpServletResponse response) {
logger.debug("getHealthReady");
healthApi.getHealthReady();
}
@ApiOperation(value = "Returns the configuration of all xapps.", response = AllXappConfig.class)
- @RequestMapping(value = CONFIG_METHOD, 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, 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, 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_METHOD + "/{" + PP_XAPP_NAME + "}", 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);
}
@ApiOperation(value = "Returns a list of deployable xapps.", response = DashboardDeployableXapps.class)
- @RequestMapping(value = XAPPS_LIST_METHOD, method = RequestMethod.GET)
+ @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.
}
@ApiOperation(value = "Returns the status of all deployed xapps.", response = AllDeployedXapps.class)
- @RequestMapping(value = XAPPS_METHOD, 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_METHOD + "/{" + PP_XAPP_NAME + "}", 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, 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_METHOD + "/{" + PP_XAPP_NAME + "}", 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());
}
}