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

Interface PublishingManager

All Known Implementing Classes:

PublishingManagerImpl

public interface PublishingManager

document

Method Summary

Modifier and Type	Method	Description
List<PublishRequest>	getItemsReadyForDeployment(String site, String environment)
String	getPublishingStatus(String site)
@javax.validation.Valid boolean	hasPublishingQueuePackagesReady(String site)
boolean	isPublishingBlocked(String site)
boolean	isPublishingQueueEmpty(String site)
void	markItemsBlocked(String site, String environment, List<PublishRequest> copyToEnvironmentItems)
void	markItemsCompleted(String site, String environment, List<PublishRequest> processedItems)
void	markItemsProcessing(String site, String environment, List<PublishRequest> itemsToDeploy)
void	markItemsReady(String site, String liveEnvironment, List<PublishRequest> copyToEnvironmentItems)
DeploymentItemTO	processItem(PublishRequest item)
List<DeploymentItemTO>	processMandatoryDependencies(PublishRequest item, Set<String> pathsToDeploy, Set<String> missingDependenciesPaths)
void	resetProcessingQueue(String site, String environment)	Reset items being in processing state (skip publishing cycle or recover from error)
void	setPublishedState(String siteId, String environment, List<PublishRequest> items)	Updates item states to publish state according to the publishing environment (stage vs live)

Method Details

getItemsReadyForDeployment

List<PublishRequest> getItemsReadyForDeployment(String site,
 String environment)

processItem

DeploymentItemTO processItem(PublishRequest item)
                      throws DeploymentException,
ServiceLayerException,
UserNotFoundException

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

markItemsCompleted

void markItemsCompleted(String site,
 String environment,
 List<PublishRequest> processedItems)
                 throws DeploymentException

Throws:

DeploymentException

markItemsProcessing

void markItemsProcessing(String site,
 String environment,
 List<PublishRequest> itemsToDeploy)
                  throws DeploymentException

Throws:

DeploymentException

markItemsReady

void markItemsReady(String site,
 String liveEnvironment,
 List<PublishRequest> copyToEnvironmentItems)
             throws DeploymentException

Throws:

DeploymentException

markItemsBlocked

void markItemsBlocked(String site,
 String environment,
 List<PublishRequest> copyToEnvironmentItems)
               throws DeploymentException

Throws:

DeploymentException

processMandatoryDependencies

List<DeploymentItemTO> processMandatoryDependencies(PublishRequest item,
 Set<String> pathsToDeploy,
 Set<String> missingDependenciesPaths)
                                             throws DeploymentException,
ServiceLayerException,
UserNotFoundException

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

isPublishingBlocked

boolean isPublishingBlocked(String site)

hasPublishingQueuePackagesReady

@Valid
@javax.validation.Valid boolean hasPublishingQueuePackagesReady(String site)

getPublishingStatus

String getPublishingStatus(String site)

isPublishingQueueEmpty

boolean isPublishingQueueEmpty(String site)

resetProcessingQueue

void resetProcessingQueue(String site,
 String environment)

Reset items being in processing state (skip publishing cycle or recover from error)

Parameters:

site - site to use

environment - environment to use

setPublishedState

void setPublishedState(String siteId,
 String environment,
 List<PublishRequest> items)

Updates item states to publish state according to the publishing environment (stage vs live)

Parameters:

siteId - the site id

environment - the environment where the items were published

items - the published items