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

Class PublishingManagerImpl

java.lang.Object

org.craftercms.studio.impl.v1.service.deployment.PublishingManagerImpl

All Implemented Interfaces:

PublishingManager

public class PublishingManagerImpl
extends Object
implements PublishingManager

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentRepository	contentRepository
protected ContentService	contentService
protected DependencyService	dependencyService
protected DeploymentService	deploymentService
protected ItemServiceInternal	itemServiceInternal
static String	LIVE_ENVIRONMENT
protected PublishRequestMapper	publishRequestMapper
protected RetryingDatabaseOperationFacade	retryingDatabaseOperationFacade
protected ServicesConfig	servicesConfig
protected StudioConfiguration	studioConfiguration
protected WorkflowServiceInternal	workflowServiceInternal

Constructor Summary

Constructors

Constructor	Description
PublishingManagerImpl()

Method Summary

Modifier and Type	Method	Description
@Valid List<PublishRequest>	getItemsReadyForDeployment(String site, String environment)
@Valid String	getPublishingStatus(String site)
@javax.validation.Valid boolean	hasPublishingQueuePackagesReady(String site)
boolean	isEnablePublishingWithoutDependencies()
@javax.validation.Valid boolean	isPublishingBlocked(String site)
@javax.validation.Valid 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 environment, 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	setContentRepository(ContentRepository contentRepository)
void	setContentService(ContentService contentService)
void	setDependencyService(DependencyService dependencyService)
void	setDeploymentService(DeploymentService deploymentService)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setPublishedState(String site, String environment, List<PublishRequest> items)	Updates item states to publish state according to the publishing environment (stage vs live)
void	setPublishRequestMapper(PublishRequestMapper publishRequestMapper)
void	setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)

Methods inherited from class java.lang.Object

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

Field Detail

LIVE_ENVIRONMENT

public static final String LIVE_ENVIRONMENT

See Also:

Constant Field Values

contentService

protected ContentService contentService

deploymentService

protected DeploymentService deploymentService

contentRepository

protected ContentRepository contentRepository

servicesConfig

protected ServicesConfig servicesConfig

studioConfiguration

protected StudioConfiguration studioConfiguration

dependencyService

protected DependencyService dependencyService

publishRequestMapper

protected PublishRequestMapper publishRequestMapper

itemServiceInternal

protected ItemServiceInternal itemServiceInternal

workflowServiceInternal

protected WorkflowServiceInternal workflowServiceInternal

retryingDatabaseOperationFacade

protected RetryingDatabaseOperationFacade retryingDatabaseOperationFacade

Constructor Detail

PublishingManagerImpl

public PublishingManagerImpl()

Method Detail

getItemsReadyForDeployment

@Valid
public @Valid List<PublishRequest> getItemsReadyForDeployment(String site,
                                                              String environment)

Specified by:

getItemsReadyForDeployment in interface PublishingManager

processItem

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

Specified by:

processItem in interface PublishingManager

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

setPublishedState

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

Description copied from interface: PublishingManager

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

Specified by:

setPublishedState in interface PublishingManager

Parameters:

site - the site id

environment - the environment where the items were published

items - the published items

markItemsCompleted

@Valid
public void markItemsCompleted(String site,
                               String environment,
                               List<PublishRequest> processedItems)

Specified by:

markItemsCompleted in interface PublishingManager

markItemsProcessing

@Valid
public void markItemsProcessing(String site,
                                String environment,
                                List<PublishRequest> itemsToDeploy)

Specified by:

markItemsProcessing in interface PublishingManager

markItemsReady

@Valid
public void markItemsReady(String site,
                           String environment,
                           List<PublishRequest> copyToEnvironmentItems)

Specified by:

markItemsReady in interface PublishingManager

markItemsBlocked

@Valid
public void markItemsBlocked(String site,
                             String environment,
                             List<PublishRequest> copyToEnvironmentItems)

Specified by:

markItemsBlocked in interface PublishingManager

processMandatoryDependencies

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

Specified by:

processMandatoryDependencies in interface PublishingManager

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

isPublishingBlocked

@Valid
public @javax.validation.Valid boolean isPublishingBlocked(String site)

Specified by:

isPublishingBlocked in interface PublishingManager

hasPublishingQueuePackagesReady

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

Specified by:

hasPublishingQueuePackagesReady in interface PublishingManager

getPublishingStatus

@Valid
public @Valid String getPublishingStatus(String site)

Specified by:

getPublishingStatus in interface PublishingManager

isPublishingQueueEmpty

@Valid
public @javax.validation.Valid boolean isPublishingQueueEmpty(String site)

Specified by:

isPublishingQueueEmpty in interface PublishingManager

resetProcessingQueue

@Valid
public void resetProcessingQueue(String site,
                                 String environment)

Description copied from interface: PublishingManager

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

Specified by:

resetProcessingQueue in interface PublishingManager

Parameters:

site - site to use

environment - environment to use

isEnablePublishingWithoutDependencies

public boolean isEnablePublishingWithoutDependencies()

setContentService

public void setContentService(ContentService contentService)

setDeploymentService

public void setDeploymentService(DeploymentService deploymentService)

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setDependencyService

public void setDependencyService(DependencyService dependencyService)

setPublishRequestMapper

public void setPublishRequestMapper(PublishRequestMapper publishRequestMapper)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setWorkflowServiceInternal

public void setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)