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

Class DeploymentServiceImpl

java.lang.Object

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

All Implemented Interfaces:

DeploymentService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class DeploymentServiceImpl
extends Object
implements DeploymentService, org.springframework.context.ApplicationContextAware

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected AuditServiceInternal	auditServiceInternal
protected ContentRepository	contentRepository
protected ContentRepository	contentRepositoryV2
protected ContentService	contentService
protected DependencyService	dependencyService
protected DmFilterWrapper	dmFilterWrapper
protected DmPublishService	dmPublishService
protected ItemServiceInternal	itemServiceInternal
protected NotificationService	notificationService
protected PublishingManager	publishingManager
protected PublishRequestDAO	publishRequestDAO
protected PublishRequestMapper	publishRequestMapper
protected RetryingDatabaseOperationFacade	retryingDatabaseOperationFacade
protected SecurityService	securityService
protected ServicesConfig	servicesConfig
protected SiteService	siteService
protected StudioConfiguration	studioConfiguration
protected UserServiceInternal	userServiceInternal
protected WorkflowServiceInternal	workflowServiceInternal

Constructor Summary

Constructors

Constructor	Description
DeploymentServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addScheduledItem(String site, String environment, ZonedDateTime launchDate, String path, String packageId, List<ContentItemTO> scheduledItems, DmContentItemComparator comparator, DmContentItemComparator subComparator, List<String> displayPatterns)	add a scheduled item created from the given node to the scheduled items list if the item is not a component or a static asset
protected void	addToScheduledDateList(String site, String environment, ZonedDateTime launchDate, String path, String packageId, List<ContentItemTO> scheduledItems, DmContentItemComparator comparator, DmContentItemComparator subComparator, List<String> displayPatterns)	add the given node to the scheduled items list
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)
protected ContentItemTO	createDateItem(String name, ContentItemTO itemToAdd, DmContentItemComparator comparator, String timeZone)
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)
@javax.validation.Valid boolean	enablePublishing(String site, boolean enabled)	Enable/Disable publishing for given site
protected Set<String>	getAllPublishedEnvironments(String site)
@Valid List<ContentItemTO>	getScheduledItems(String site, String sort, boolean ascending, String subSort, boolean subAscending, String filterType)
@Valid List<PublishRequest>	getScheduledItems(String site, String filterType)
protected List<ContentItemTO>	getScheduledItems(String site, DmContentItemComparator comparator, DmContentItemComparator subComparator, String filterType)
SecurityService	getSecurityService()
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
protected void	sendContentApprovalEmail(List<PublishRequest> itemList, boolean scheduleDateNow)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setContentRepository(ContentRepository contentRepository)
void	setContentRepositoryV2(ContentRepository contentRepositoryV2)
void	setContentService(ContentService contentService)
void	setDependencyService(DependencyService dependencyService)
void	setDmFilterWrapper(DmFilterWrapper dmFilterWrapper)
void	setDmPublishService(DmPublishService dmPublishService)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setNotificationService(NotificationService notificationService)
void	setPublishingManager(PublishingManager publishingManager)
void	setPublishRequestDAO(PublishRequestDAO publishRequestDAO)
void	setPublishRequestMapper(PublishRequestMapper publishRequestMapper)
void	setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
void	setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)

Methods inherited from class java.lang.Object

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

Field Detail

servicesConfig

protected ServicesConfig servicesConfig

contentService

protected ContentService contentService

dependencyService

protected DependencyService dependencyService

dmFilterWrapper

protected DmFilterWrapper dmFilterWrapper

siteService

protected SiteService siteService

contentRepository

protected ContentRepository contentRepository

dmPublishService

protected DmPublishService dmPublishService

securityService

protected SecurityService securityService

notificationService

protected NotificationService notificationService

studioConfiguration

protected StudioConfiguration studioConfiguration

publishRequestMapper

protected PublishRequestMapper publishRequestMapper

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

contentRepositoryV2

protected ContentRepository contentRepositoryV2

itemServiceInternal

protected ItemServiceInternal itemServiceInternal

workflowServiceInternal

protected WorkflowServiceInternal workflowServiceInternal

userServiceInternal

protected UserServiceInternal userServiceInternal

publishingManager

protected PublishingManager publishingManager

publishRequestDAO

protected PublishRequestDAO publishRequestDAO

retryingDatabaseOperationFacade

protected RetryingDatabaseOperationFacade retryingDatabaseOperationFacade

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Detail

DeploymentServiceImpl

public DeploymentServiceImpl()

Method Detail

deploy

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

Specified by:

deploy in interface DeploymentService

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException

sendContentApprovalEmail

protected void sendContentApprovalEmail(List<PublishRequest> itemList,
                                        boolean scheduleDateNow)
                                 throws ServiceLayerException,
                                        UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

delete

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

Description copied from interface: DeploymentService

Delete content

Specified by:

delete in interface DeploymentService

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

deleteDeploymentDataForSite

@Valid
public void deleteDeploymentDataForSite(String site)

Specified by:

deleteDeploymentDataForSite in interface DeploymentService

getScheduledItems

@Valid
public @Valid List<PublishRequest> getScheduledItems(String site,
                                                     String filterType)

Specified by:

getScheduledItems in interface DeploymentService

cancelWorkflow

@Valid
public void cancelWorkflow(String site,
                           String path)
                    throws DeploymentException

Specified by:

cancelWorkflow in interface DeploymentService

Throws:

DeploymentException

cancelWorkflowBulk

@Valid
public void cancelWorkflowBulk(String site,
                               Set<String> paths)

Specified by:

cancelWorkflowBulk in interface DeploymentService

getScheduledItems

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

Specified by:

getScheduledItems in interface DeploymentService

Throws:

ServiceLayerException

getScheduledItems

protected List<ContentItemTO> getScheduledItems(String site,
                                                DmContentItemComparator comparator,
                                                DmContentItemComparator subComparator,
                                                String filterType)

addScheduledItem

protected void addScheduledItem(String site,
                                String environment,
                                ZonedDateTime launchDate,
                                String path,
                                String packageId,
                                List<ContentItemTO> scheduledItems,
                                DmContentItemComparator comparator,
                                DmContentItemComparator subComparator,
                                List<String> displayPatterns)

add a scheduled item created from the given node to the scheduled items list if the item is not a component or a static asset

Parameters:

site -

launchDate -

scheduledItems -

comparator -

displayPatterns -

addToScheduledDateList

protected void addToScheduledDateList(String site,
                                      String environment,
                                      ZonedDateTime launchDate,
                                      String path,
                                      String packageId,
                                      List<ContentItemTO> scheduledItems,
                                      DmContentItemComparator comparator,
                                      DmContentItemComparator subComparator,
                                      List<String> displayPatterns)
                               throws ServiceLayerException

add the given node to the scheduled items list

Parameters:

site -

launchDate -

scheduledItems -

comparator -

subComparator -

displayPatterns -

Throws:

ServiceLayerException

createDateItem

protected ContentItemTO createDateItem(String name,
                                       ContentItemTO itemToAdd,
                                       DmContentItemComparator comparator,
                                       String timeZone)

getAllPublishedEnvironments

protected Set<String> getAllPublishedEnvironments(String site)

bulkGoLive

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

Description copied from interface: DeploymentService

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

Specified by:

bulkGoLive in interface DeploymentService

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

@Valid
public @javax.validation.Valid boolean enablePublishing(String site,
                                                        boolean enabled)
                                                 throws SiteNotFoundException,
                                                        AuthenticationException

Description copied from interface: DeploymentService

Enable/Disable publishing for given site

Specified by:

enablePublishing in interface DeploymentService

Parameters:

site - site id

enabled - true to enable publishing, false to disable publishing

Throws:

SiteNotFoundException

AuthenticationException

publishCommits

@Valid
public void publishCommits(String site,
                           String environment,
                           List<String> commitIds,
                           String comment)
                    throws SiteNotFoundException,
                           EnvironmentNotFoundException,
                           CommitNotFoundException

Description copied from interface: DeploymentService

Publish given commit IDs on given environment for given site

Specified by:

publishCommits in interface DeploymentService

Parameters:

site - site id to use for publishing

environment - environment to use for publishing

commitIds - commit IDs to publish

Throws:

SiteNotFoundException

EnvironmentNotFoundException

CommitNotFoundException

publishItems

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

Description copied from interface: DeploymentService

Publish items in given environment for given site

Specified by:

publishItems in interface DeploymentService

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

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

Description copied from interface: DeploymentService

Reset staging environment to live for given site

Specified by:

resetStagingEnvironment in interface DeploymentService

Parameters:

siteId - site id to use for resetting

Throws:

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

setApplicationContext

public void setApplicationContext(@NonNull
                                  org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setContentService

public void setContentService(ContentService contentService)

setDependencyService

public void setDependencyService(DependencyService dependencyService)

setDmFilterWrapper

public void setDmFilterWrapper(DmFilterWrapper dmFilterWrapper)

setSiteService

public void setSiteService(SiteService siteService)

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setDmPublishService

public void setDmPublishService(DmPublishService dmPublishService)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

setNotificationService

public void setNotificationService(NotificationService notificationService)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setPublishRequestMapper

public void setPublishRequestMapper(PublishRequestMapper publishRequestMapper)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

setContentRepositoryV2

public void setContentRepositoryV2(ContentRepository contentRepositoryV2)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setWorkflowServiceInternal

public void setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setPublishingManager

public void setPublishingManager(PublishingManager publishingManager)

setPublishRequestDAO

public void setPublishRequestDAO(PublishRequestDAO publishRequestDAO)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)