Class PluginController
- java.lang.Object
-
- org.craftercms.studio.controller.rest.v2.ManagementTokenAware
-
- org.craftercms.studio.controller.rest.v2.PluginController
-
@Validated @RestController @RequestMapping("/api/2/plugin") public class PluginController extends ManagementTokenAware
Controller that executes Rest scripts from plugins- Since:
- 3.1.1
- Author:
- joseross
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PluginController.WriteConfigurationRequest
-
Field Summary
Fields Modifier and Type Field Description protected MarketplaceService
marketplaceService
protected ScriptingService
scriptingService
-
Fields inherited from class org.craftercms.studio.controller.rest.v2.ManagementTokenAware
securityService, studioConfiguration
-
-
Constructor Summary
Constructors Constructor Description PluginController(StudioConfiguration studioConfiguration, SecurityService securityService, ScriptingService scriptingService, MarketplaceService marketplaceService)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ResponseBody
getPluginConfiguration(String siteId, String pluginId)
ResponseBody
reloadClasses(String siteId, String token)
Reloads the groovy classes for the given siteResponseBody
runScript(String siteId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Executes a rest script for the given siteResponseBody
writeConfiguration(@Valid PluginController.WriteConfigurationRequest request)
-
Methods inherited from class org.craftercms.studio.controller.rest.v2.ManagementTokenAware
getConfiguredToken, validateToken
-
-
-
-
Field Detail
-
scriptingService
protected final ScriptingService scriptingService
-
marketplaceService
protected final MarketplaceService marketplaceService
-
-
Constructor Detail
-
PluginController
@ConstructorProperties({"studioConfiguration","securityService","scriptingService","marketplaceService"}) public PluginController(StudioConfiguration studioConfiguration, SecurityService securityService, ScriptingService scriptingService, MarketplaceService marketplaceService)
-
-
Method Detail
-
getPluginConfiguration
@GetMapping("/get_configuration") public ResponseBody getPluginConfiguration(String siteId, String pluginId) throws ContentNotFoundException
- Throws:
ContentNotFoundException
-
writeConfiguration
@PostMapping("/write_configuration") public ResponseBody writeConfiguration(@Valid @RequestBody @Valid PluginController.WriteConfigurationRequest request) throws UserNotFoundException, ServiceLayerException
-
reloadClasses
@GetMapping("/script/reload") public ResponseBody reloadClasses(@RequestParam String siteId, @RequestParam String token) throws InvalidParametersException, org.craftercms.commons.exceptions.InvalidManagementTokenException
Reloads the groovy classes for the given site- Throws:
InvalidParametersException
org.craftercms.commons.exceptions.InvalidManagementTokenException
-
runScript
@RequestMapping("/script/**") public ResponseBody runScript(@RequestParam String siteId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws groovy.util.ResourceException, groovy.util.ScriptException, ConfigurationException
Executes a rest script for the given site- Throws:
groovy.util.ResourceException
groovy.util.ScriptException
ConfigurationException
-
-