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

Class DeploymentServiceImpl

java.lang.Object

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

All Implemented Interfaces:

DeploymentService

public class DeploymentServiceImpl
extends Object
implements DeploymentService

Field Summary

Fields

Modifier and Type	Field and Description
protected AuditServiceInternal	auditServiceInternal
protected ContentRepository	contentRepository
protected ContentRepository	contentRepositoryV2
protected ContentService	contentService
protected DependencyService	dependencyService
protected DeploymentHistoryProvider	deploymentHistoryProvider
protected DmFilterWrapper	dmFilterWrapper
protected DmPublishService	dmPublishService
protected EventService	eventService
protected NotificationService	notificationService
protected ObjectMetadataManager	objectMetadataManager
protected ObjectStateService	objectStateService
protected PublishingManager	publishingManager
protected PublishRequestDAO	publishRequestDAO
protected PublishRequestMapper	publishRequestMapper
protected RetryingOperationFacade	retryingOperationFacade
protected SecurityService	securityService
protected ServicesConfig	servicesConfig
protected SiteService	siteService
protected StudioConfiguration	studioConfiguration

Constructor Summary

Constructors

Constructor and Description
DeploymentServiceImpl()

Method Summary

Modifier and Type	Method and 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)
protected DmDeploymentTaskTO	createDeploymentTask(String deployedLabel, ContentItemTO item) create WcmDeploymentTask
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
protected Set<String>	getAllPublishedEnvironments(String site)
AuditServiceInternal	getAuditServiceInternal()
Map<String,List<PublishingChannelTO>>	getAvailablePublishingChannelGroups(String site, String path)
ContentRepository	getContentRepository()
ContentRepository	getContentRepositoryV2()
protected ContentItemTO	getDeployedItem(String site, String path) get a deployed item by the given path.
List<DmDeploymentTaskTO>	getDeploymentHistory(String site, int daysFromToday, int numberOfItems, String sort, boolean ascending, String filterType) get deployment history given a specified date range
DeploymentHistoryProvider	getDeploymentHistoryProvider()
DmPublishService	getDmPublishService()
EventService	getEventService()
ObjectMetadataManager	getObjectMetadataManager()
ObjectStateService	getObjectStateService()
protected List<PublishingChannelTO>	getPublishedEnvironments(String site)
PublishingManager	getPublishingManager()
PublishRequestDAO	getPublishRequestDAO()
PublishRequestMapper	getPublishRequestMapper()
RetryingOperationFacade	getRetryingOperationFacade()
protected List<ContentItemTO>	getScheduledItems(String site, DmContentItemComparator comparator, DmContentItemComparator subComparator, String filterType)
List<PublishRequest>	getScheduledItems(String site, String filterType)
List<ContentItemTO>	getScheduledItems(String site, String sort, boolean ascending, String subSort, boolean subAscending, String filterType)
SecurityService	getSecurityService()
SiteService	getSiteService()
StudioConfiguration	getStudioConfiguration()
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	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setContentRepository(ContentRepository contentRepository)
void	setContentRepositoryV2(ContentRepository contentRepositoryV2)
void	setContentService(ContentService contentService)
void	setDependencyService(DependencyService dependencyService)
void	setDeploymentHistoryProvider(DeploymentHistoryProvider deploymentHistoryProvider)
void	setDmFilterWrapper(DmFilterWrapper dmFilterWrapper)
void	setDmPublishService(DmPublishService dmPublishService)
void	setEventService(EventService eventService)
void	setNotificationService(NotificationService notificationService)
void	setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)
void	setObjectStateService(ObjectStateService objectStateService)
void	setPublishingManager(PublishingManager publishingManager)
void	setPublishRequestDAO(PublishRequestDAO publishRequestDAO)
void	setPublishRequestMapper(PublishRequestMapper publishRequestMapper)
void	setRetryingOperationFacade(RetryingOperationFacade retryingOperationFacade)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	syncAllContentToPreview(String site, boolean waitTillDone)

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

objectStateService

protected ObjectStateService objectStateService

objectMetadataManager

protected ObjectMetadataManager objectMetadataManager

contentRepository

protected ContentRepository contentRepository

dmPublishService

protected DmPublishService dmPublishService

securityService

protected SecurityService securityService

eventService

protected EventService eventService

notificationService

protected NotificationService notificationService

deploymentHistoryProvider

protected DeploymentHistoryProvider deploymentHistoryProvider

studioConfiguration

protected StudioConfiguration studioConfiguration

publishRequestMapper

protected PublishRequestMapper publishRequestMapper

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

contentRepositoryV2

protected ContentRepository contentRepositoryV2

publishingManager

protected PublishingManager publishingManager

publishRequestDAO

protected PublishRequestDAO publishRequestDAO

retryingOperationFacade

protected RetryingOperationFacade retryingOperationFacade

Constructor Detail

DeploymentServiceImpl

public DeploymentServiceImpl()

Method Detail

deploy

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

Specified by:

deploy in interface DeploymentService

Throws:

DeploymentException

sendContentApprovalEmail

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

delete

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

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

deleteDeploymentDataForSite

public void deleteDeploymentDataForSite(String site)

Specified by:

deleteDeploymentDataForSite in interface DeploymentService

getScheduledItems

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

Specified by:

getScheduledItems in interface DeploymentService

cancelWorkflow

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

Specified by:

cancelWorkflow in interface DeploymentService

Throws:

DeploymentException

cancelWorkflowBulk

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

Specified by:

cancelWorkflowBulk in interface DeploymentService

getDeploymentHistory

public List<DmDeploymentTaskTO> getDeploymentHistory(String site,
                                                     int daysFromToday,
                                                     int numberOfItems,
                                                     String sort,
                                                     boolean ascending,
                                                     String filterType)
                                              throws SiteNotFoundException

Description copied from interface: DeploymentService

get deployment history given a specified date range

Specified by:

getDeploymentHistory in interface DeploymentService

sort - the sort key to sort items within each deployed date

Returns:

list of deployment items

Throws:

SiteNotFoundException

createDeploymentTask

protected DmDeploymentTaskTO createDeploymentTask(String deployedLabel,
                                                  ContentItemTO item)

create WcmDeploymentTask

Parameters:

deployedLabel -

item -

Returns:

deployment task

getDeployedItem

protected ContentItemTO getDeployedItem(String site,
                                        String path)

get a deployed item by the given path. If the item is new, it will be added to the itemsMap

Parameters:

site -

path -

Returns:

deployed item

getScheduledItems

public 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 -

format -

scheduledItems -

comparator -

subComparator -

displayPatterns -

Throws:

ServiceLayerException

createDateItem

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

getAvailablePublishingChannelGroups

public Map<String,List<PublishingChannelTO>> getAvailablePublishingChannelGroups(String site,
                                                                                 String path)

Specified by:

getAvailablePublishingChannelGroups in interface DeploymentService

getPublishedEnvironments

protected List<PublishingChannelTO> getPublishedEnvironments(String site)

getAllPublishedEnvironments

protected Set<String> getAllPublishedEnvironments(String site)

syncAllContentToPreview

public void syncAllContentToPreview(String site,
                                    boolean waitTillDone)
                             throws ServiceLayerException

Specified by:

syncAllContentToPreview in interface DeploymentService

Throws:

ServiceLayerException

bulkGoLive

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

public 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

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

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

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

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setContentService

public void setContentService(ContentService contentService)

setDependencyService

public void setDependencyService(DependencyService dependencyService)

setDmFilterWrapper

public void setDmFilterWrapper(DmFilterWrapper dmFilterWrapper)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

getObjectStateService

public ObjectStateService getObjectStateService()

setObjectStateService

public void setObjectStateService(ObjectStateService objectStateService)

getObjectMetadataManager

public ObjectMetadataManager getObjectMetadataManager()

setObjectMetadataManager

public void setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)

getContentRepository

public ContentRepository getContentRepository()

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

getDmPublishService

public DmPublishService getDmPublishService()

setDmPublishService

public void setDmPublishService(DmPublishService dmPublishService)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

setNotificationService

public void setNotificationService(NotificationService notificationService)

getEventService

public EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getDeploymentHistoryProvider

public DeploymentHistoryProvider getDeploymentHistoryProvider()

setDeploymentHistoryProvider

public void setDeploymentHistoryProvider(DeploymentHistoryProvider deploymentHistoryProvider)

getStudioConfiguration

public StudioConfiguration getStudioConfiguration()

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

getPublishRequestMapper

public PublishRequestMapper getPublishRequestMapper()

setPublishRequestMapper

public void setPublishRequestMapper(PublishRequestMapper publishRequestMapper)

getAuditServiceInternal

public AuditServiceInternal getAuditServiceInternal()

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

getContentRepositoryV2

public ContentRepository getContentRepositoryV2()

setContentRepositoryV2

public void setContentRepositoryV2(ContentRepository contentRepositoryV2)

getPublishingManager

public PublishingManager getPublishingManager()

setPublishingManager

public void setPublishingManager(PublishingManager publishingManager)

getPublishRequestDAO

public PublishRequestDAO getPublishRequestDAO()

setPublishRequestDAO

public void setPublishRequestDAO(PublishRequestDAO publishRequestDAO)

getRetryingOperationFacade

public RetryingOperationFacade getRetryingOperationFacade()

setRetryingOperationFacade

public void setRetryingOperationFacade(RetryingOperationFacade retryingOperationFacade)