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

Class PublishController

java.lang.Object

org.craftercms.studio.controller.rest.v2.PublishController

@RestController
@RequestMapping("/api/2/publish")
public class PublishController
extends Object

Constructor Summary

Constructors

Constructor	Description
PublishController()

Method Summary

Modifier and Type	Method	Description
ResponseBody	cancelPublishingPackages(CancelPublishingPackagesRequest cancelPublishingPackagesRequest)
ResponseBody	clearPublishingLock(ClearPublishingLockRequest clearPublishingLockRequest)
ResponseBody	getAvailablePublishingTargets(String siteId)
ResponseBody	getPublishingHistory(String siteId, int daysFromToday, int numberOfItems, String filterType)
ResponseBody	getPublishingPackageDetails(String siteId, String packageId)
ResponseBody	getPublishingPackages(String siteId, String environment, String path, List<String> states, int offset, int limit)
ResponseBody	getPublishingStatus(String siteId)
PublishService	getPublishService()
SiteService	getSiteService()
SitesService	getSitesService()
void	setPublishService(PublishService publishService)
void	setSiteService(SiteService siteService)
void	setSitesService(SitesService sitesService)

Methods inherited from class java.lang.Object

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

Constructor Detail

PublishController

public PublishController()

Method Detail

getPublishingPackages

@GetMapping("/packages")
public ResponseBody getPublishingPackages(@RequestParam(name="siteId",required=true)
                                          String siteId,
                                          @RequestParam(name="environment",required=false)
                                          String environment,
                                          @RequestParam(name="path",required=false)
                                          String path,
                                          @RequestParam(name="states",required=false)
                                          List<String> states,
                                          @RequestParam(name="offset",required=false,defaultValue="0")
                                          int offset,
                                          @RequestParam(name="limit",required=false,defaultValue="10")
                                          int limit)
                                   throws SiteNotFoundException

Throws:

SiteNotFoundException

getPublishingPackageDetails

@GetMapping("/package")
public ResponseBody getPublishingPackageDetails(@RequestParam(name="siteId")
                                                String siteId,
                                                @RequestParam(name="packageId")
                                                String packageId)
                                         throws SiteNotFoundException

Throws:

SiteNotFoundException

cancelPublishingPackages

@PostMapping("/cancel")
public ResponseBody cancelPublishingPackages(@RequestBody
                                             CancelPublishingPackagesRequest cancelPublishingPackagesRequest)
                                      throws SiteNotFoundException

Throws:

SiteNotFoundException

getPublishingStatus

@GetMapping("/status")
public ResponseBody getPublishingStatus(@RequestParam(name="siteId")
                                        String siteId)
                                 throws SiteNotFoundException

Throws:

SiteNotFoundException

clearPublishingLock

@PostMapping(value="/clear_lock",
             consumes="application/json")
public ResponseBody clearPublishingLock(@RequestBody
                                        ClearPublishingLockRequest clearPublishingLockRequest)
                                 throws SiteNotFoundException

Throws:

SiteNotFoundException

getPublishingHistory

@GetMapping(value="/history",
            produces="application/json")
public ResponseBody getPublishingHistory(@RequestParam(name="siteId")
                                         String siteId,
                                         @RequestParam(name="days")
                                         int daysFromToday,
                                         @RequestParam(name="num")
                                         int numberOfItems,
                                         @RequestParam(name="filterType",required=false,defaultValue="page")
                                         String filterType)
                                  throws SiteNotFoundException

Throws:

SiteNotFoundException

getAvailablePublishingTargets

@GetMapping(value="/available_targets",
            produces="application/json")
public ResponseBody getAvailablePublishingTargets(@RequestParam(name="siteId")
                                                  String siteId)
                                           throws SiteNotFoundException

Throws:

SiteNotFoundException

getPublishService

public PublishService getPublishService()

setPublishService

public void setPublishService(PublishService publishService)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

getSitesService

public SitesService getSitesService()

setSitesService

public void setSitesService(SitesService sitesService)