Package org.craftercms.studio.controller.rest.v2

Class ConfigurationController

java.lang.Object

org.craftercms.studio.controller.rest.v2.ConfigurationController

@RestController
@RequestMapping("/api/2/configuration")
public class ConfigurationController
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ConfigurationController.DeleteContentTypeRequest

Constructor Summary

Constructors

Constructor	Description
ConfigurationController(ConfigurationService configurationService, StudioConfiguration studioConfiguration, ContentTypeService contentTypeService)

Method Summary

Modifier and Type	Method	Description
ResponseBody	clearCache(String siteId)
ResponseBody	deleteContentType(@Valid ConfigurationController.DeleteContentTypeRequest request)
ResponseBody	getConfiguration(String siteId)
ResponseBody	getConfiguration(String siteId, String module, String path, String environment)
ResponseBody	getConfigurationHistory(String siteId, String module, String path, String environment)
ResponseBody	getContentTypeUsage(String siteId, String contentType)
ResponseBody	writeConfiguration(WriteConfigurationRequest wcRequest)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationController

@ConstructorProperties({"configurationService","studioConfiguration","contentTypeService"})
public ConfigurationController(ConfigurationService configurationService,
                               StudioConfiguration studioConfiguration,
                               ContentTypeService contentTypeService)

Method Detail

clearCache

@GetMapping("clear_cache")
public ResponseBody clearCache(@RequestParam
                               String siteId)

getConfiguration

@GetMapping("/get_configuration")
public ResponseBody getConfiguration(@RequestParam(name="siteId",required=true)
                                     String siteId,
                                     @RequestParam(name="module",required=true)
                                     String module,
                                     @RequestParam(name="path",required=true)
                                     String path,
                                     @RequestParam(name="environment",required=false)
                                     String environment)

writeConfiguration

@PostMapping("/write_configuration")
public ResponseBody writeConfiguration(@RequestBody
                                       WriteConfigurationRequest wcRequest)
                                throws ServiceLayerException,
                                       UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getConfigurationHistory

@GetMapping("/get_configuration_history")
public ResponseBody getConfigurationHistory(@RequestParam(name="siteId",required=true)
                                            String siteId,
                                            @RequestParam(name="module",required=true)
                                            String module,
                                            @RequestParam(name="path",required=true)
                                            String path,
                                            @RequestParam(name="environment",required=false)
                                            String environment)
                                     throws SiteNotFoundException,
                                            ContentNotFoundException

Throws:

SiteNotFoundException

ContentNotFoundException

getConfiguration

@GetMapping("translation")
public ResponseBody getConfiguration(@RequestParam
                                     String siteId)
                              throws ServiceLayerException

Throws:

ServiceLayerException

getContentTypeUsage

@GetMapping("content-type/usage")
public ResponseBody getContentTypeUsage(@RequestParam
                                        String siteId,
                                        @RequestParam
                                        String contentType)
                                 throws Exception

Throws:

Exception

deleteContentType

@PostMapping("content-type/delete")
public ResponseBody deleteContentType(@RequestBody @Valid
                                      @Valid ConfigurationController.DeleteContentTypeRequest request)
                               throws ServiceLayerException,
                                      AuthenticationException,
                                      DeploymentException

Throws:

ServiceLayerException

AuthenticationException

DeploymentException