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

Class SitesController

java.lang.Object

org.craftercms.studio.controller.rest.v2.SitesController

@Validated
@RestController
@RequestMapping("/api/2/sites")
public class SitesController
extends Object

Constructor Summary

Constructors

Constructor	Description
SitesController(SitesService sitesService, MarketplaceService marketplaceService, PolicyService policyService)

Method Summary

Modifier and Type	Method	Description
Result	createSite(@Valid CreateSiteRequest request)
Result	deleteSite(String siteId)
Result	duplicateSite(String sourceSiteId, @Valid DuplicateSiteRequest request)
ResultList<org.craftercms.commons.plugin.model.PluginDescriptor>	getAvailableBlueprints()
Result	unlockSite(String siteId)
Result	updateSite(String siteId, @Valid UpdateSiteRequest request)
ResultList<ValidationResult>	validatePolicy(String siteId, @Valid ValidatePolicyRequest request)

Methods inherited from class java.lang.Object

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

Constructor Details

SitesController

@ConstructorProperties({"sitesService","marketplaceService","policyService"})
public SitesController(SitesService sitesService,
 MarketplaceService marketplaceService,
 PolicyService policyService)

Method Details

getAvailableBlueprints

@GetMapping("/available_blueprints")
public ResultList<org.craftercms.commons.plugin.model.PluginDescriptor> getAvailableBlueprints()
                                                                                        throws ServiceLayerException

Throws:

ServiceLayerException

createSite

@PostMapping("/create_site_from_marketplace")
@ResponseStatus(code=CREATED)
public Result createSite(@Valid @RequestBody
 @Valid CreateSiteRequest request)
                  throws RemoteRepositoryNotFoundException,
InvalidRemoteRepositoryException,
ServiceLayerException,
InvalidRemoteRepositoryCredentialsException,
InvalidRemoteUrlException

Throws:

RemoteRepositoryNotFoundException

InvalidRemoteRepositoryException

ServiceLayerException

InvalidRemoteRepositoryCredentialsException

InvalidRemoteUrlException

updateSite

@PostMapping("/{siteId}")
public Result updateSite(@PathVariable
 String siteId,
 @Valid @RequestBody
 @Valid UpdateSiteRequest request)
                  throws SiteNotFoundException,
SiteAlreadyExistsException,
InvalidParametersException

Throws:

SiteNotFoundException

SiteAlreadyExistsException

InvalidParametersException

unlockSite

@PostMapping("/{siteId}/unlock")
public Result unlockSite(@PathVariable
 String siteId)
                  throws SiteNotFoundException,
InvalidSiteStateException

Throws:

SiteNotFoundException

InvalidSiteStateException

deleteSite

@DeleteMapping("/{siteId}")
public Result deleteSite(@PathVariable
 String siteId)
                  throws ServiceLayerException

Throws:

ServiceLayerException

validatePolicy

@PostMapping("/{siteId}/policy/validate")
public ResultList<ValidationResult> validatePolicy(@PathVariable
 String siteId,
 @Valid @RequestBody
 @Valid ValidatePolicyRequest request)
                                            throws ConfigurationException,
IOException,
ContentNotFoundException

Throws:

ConfigurationException

IOException

ContentNotFoundException

duplicateSite

@PostMapping("/{siteId}/duplicate")
@ResponseStatus(code=CREATED)
public Result duplicateSite(@PathVariable("siteId")
 String sourceSiteId,
 @Valid @RequestBody
 @Valid DuplicateSiteRequest request)
                     throws ServiceLayerException

Throws:

ServiceLayerException