Package org.craftercms.studio.api.v1.service.deployment

Interface DeploymentService

All Known Implementing Classes:

DeploymentServiceImpl

public interface DeploymentService

// document

Method Summary

Modifier and Type	Method	Description
void	bulkGoLive(String site, String environment, String path, String comment)	Start executing bulk publish for given site, path on given environment
void	cancelWorkflow(String site, String path)
void	cancelWorkflowBulk(String site, Set<String> paths)
void	delete(String site, List<String> paths, String approver, ZonedDateTime scheduledDate, String submissionComment)	Delete content
void	deleteDeploymentDataForSite(String site)
void	deploy(String site, String environment, List<String> paths, ZonedDateTime scheduledDate, String approver, String submissionComment, boolean scheduleDateNow)
boolean	enablePublishing(String site, boolean enabled)	Enable/Disable publishing for given site
List<PublishRequest>	getScheduledItems(String site, String filterType)
List<ContentItemTO>	getScheduledItems(String site, String sort, boolean ascending, String subSort, boolean subAscending, String filterType)
void	publishCommits(String site, String environment, List<String> commitIds, String comment)	Publish given commit IDs on given environment for given site
void	publishItems(String site, String environment, ZonedDateTime schedule, List<String> paths, String submissionComment)	Publish items in given environment for given site
void	resetStagingEnvironment(String siteId)	Reset staging environment to live for given site

Method Details

deploy

void deploy(String site,
 String environment,
 List<String> paths,
 ZonedDateTime scheduledDate,
 String approver,
 String submissionComment,
 boolean scheduleDateNow)
     throws DeploymentException,
ServiceLayerException,
UserNotFoundException

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

delete

void delete(String site,
 List<String> paths,
 String approver,
 ZonedDateTime scheduledDate,
 String submissionComment)
     throws DeploymentException,
ServiceLayerException,
UserNotFoundException

Delete content

Parameters:

site - site identifier

paths - list of paths to delete

approver - user that approved deletion

scheduledDate - scheduled date to execute deletion

submissionComment - submission comment

Throws:

DeploymentException - general deployment error

SiteNotFoundException - if site does not exist

ServiceLayerException

UserNotFoundException

getScheduledItems

List<PublishRequest> getScheduledItems(String site,
 String filterType)

cancelWorkflow

void cancelWorkflow(String site,
 String path)
             throws DeploymentException

Throws:

DeploymentException

cancelWorkflowBulk

void cancelWorkflowBulk(String site,
 Set<String> paths)
                 throws DeploymentException

Throws:

DeploymentException

deleteDeploymentDataForSite

void deleteDeploymentDataForSite(String site)

getScheduledItems

List<ContentItemTO> getScheduledItems(String site,
 String sort,
 boolean ascending,
 String subSort,
 boolean subAscending,
 String filterType)
                               throws ServiceLayerException

Throws:

ServiceLayerException

bulkGoLive

void bulkGoLive(String site,
 String environment,
 String path,
 String comment)
         throws ServiceLayerException

Start executing bulk publish for given site, path on given environment

Parameters:

site - site identifier

environment - environment to publish to

path - base path for bulk publish

comment - submission comment

Throws:

ServiceLayerException - exception is case of en error

enablePublishing

boolean enablePublishing(String site,
 boolean enabled)
                  throws SiteNotFoundException,
AuthenticationException

Enable/Disable publishing for given site

Parameters:

site - site id

enabled - true to enable publishing, false to disable publishing

Throws:

SiteNotFoundException

AuthenticationException

publishCommits

void publishCommits(String site,
 String environment,
 List<String> commitIds,
 String comment)
             throws ServiceLayerException,
UserNotFoundException

Publish given commit IDs on given environment for given site

Parameters:

site - site id to use for publishing

environment - environment to use for publishing

commitIds - commit IDs to publish

Throws:

ServiceLayerException

UserNotFoundException

publishItems

void publishItems(String site,
 String environment,
 ZonedDateTime schedule,
 List<String> paths,
 String submissionComment)
           throws ServiceLayerException,
DeploymentException,
UserNotFoundException

Publish items in given environment for given site

Parameters:

site - site id to use for publishing

environment - environment to use for publishing

paths - item paths to publish

Throws:

SiteNotFoundException

EnvironmentNotFoundException

ServiceLayerException

DeploymentException

UserNotFoundException

resetStagingEnvironment

void resetStagingEnvironment(String siteId)
                      throws ServiceLayerException,
org.craftercms.commons.crypto.CryptoException

Reset staging environment to live for given site

Parameters:

siteId - site id to use for resetting

Throws:

ServiceLayerException

org.craftercms.commons.crypto.CryptoException