Package org.craftercms.studio.impl.v2.deployment

Class PreviewDeployer

java.lang.Object

org.craftercms.studio.impl.v2.deployment.AbstractDeployer

org.craftercms.studio.impl.v2.deployment.PreviewDeployer

All Implemented Interfaces:

Deployer

public class PreviewDeployer
extends AbstractDeployer

Implementation of Deployer that interacts with the Preview Deployer in Authoring. This Deployer:

• Creates both and authoring and preview target on create
• Deletes the authoring and preview target on delete
• Issues deployments to the authoring and preview target on a preview sync event

Author:

avasquez

Field Summary

Fields inherited from class org.craftercms.studio.impl.v2.deployment.AbstractDeployer

DISABLE_DEPLOY_CRON_TEMPLATE_PARAM, ENV_TEMPLATE_PARAM, LOCAL_REPO_PATH_TEMPLATE_PARAM, REPLACE_TEMPLATE_PARAM, REPO_URL_TEMPLATE_PARAM, restTemplate, SITE_NAME_TEMPLATE_PARAM, SOURCE_TEMPLATE_PARAM, studioConfiguration, TEMPLATE_NAME_TEMPLATE_PARAM

Constructor Summary

Constructors

Constructor	Description
PreviewDeployer(StudioConfiguration studioConfiguration)

Method Summary

Modifier and Type	Method	Description
void	createTargets(String site)	Calls a Crafter Deployer to create any necessary targets for the site.
void	deleteTargets(String site)	Deletes the targets associated with the site.
protected void	doCreateAuthTarget(String site)
protected void	doCreatePreviewTarget(String site)
protected void	doDeployment(String site, String environment, boolean waitTillDone)
protected void	doPreviewSync(String siteId, boolean waitTillDone)
void	duplicateTargets(String sourceSiteId, String siteId)	Call Crafter Deployer API to duplicate the site targets
protected String	getCreateTargetUrl()
protected String	getDeleteTargetUrl(String site, String environment)
protected String	getDeployTargetUrl(String site, String environment)
void	onContentChange(ContentEvent event)
void	onRepositorySyncComplete(RepositoryEvent event)
void	onSiteCreateComplete(SiteReadyEvent event)

Methods inherited from class org.craftercms.studio.impl.v2.deployment.AbstractDeployer

addAdditionalParams, addChildParams, doCreateTarget, doDeleteTarget, doDuplicateTarget, getCreateTargetRequestBody, getDuplicateTargetRequestBody, getDuplicateTargetUrl, getRepoUrl, getSourceTemplateParams

Methods inherited from class java.lang.Object

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

Constructor Details

PreviewDeployer

public PreviewDeployer(StudioConfiguration studioConfiguration)

Method Details

onSiteCreateComplete

@EventListener
public void onSiteCreateComplete(SiteReadyEvent event)

onRepositorySyncComplete

@Order(20)
@EventListener
public void onRepositorySyncComplete(RepositoryEvent event)

onContentChange

@EventListener
public void onContentChange(ContentEvent event)

doPreviewSync

protected void doPreviewSync(String siteId,
 boolean waitTillDone)

createTargets

public void createTargets(String site)
                   throws org.springframework.web.client.RestClientException

Description copied from interface: Deployer

Calls a Crafter Deployer to create any necessary targets for the site.

Parameters:

site - the site

Throws:

org.springframework.web.client.RestClientException - if an error occurs

deleteTargets

public void deleteTargets(String site)
                   throws org.springframework.web.client.RestClientException

Description copied from interface: Deployer

Deletes the targets associated with the site.

Parameters:

site - the site

Throws:

org.springframework.web.client.RestClientException - if an error occurs

doDeployment

protected void doDeployment(String site,
 String environment,
 boolean waitTillDone)

doCreateAuthTarget

protected void doCreateAuthTarget(String site)
                           throws IllegalStateException,
org.springframework.web.client.RestClientException

Throws:

IllegalStateException

org.springframework.web.client.RestClientException

doCreatePreviewTarget

protected void doCreatePreviewTarget(String site)
                              throws IllegalStateException,
org.springframework.web.client.RestClientException

Throws:

IllegalStateException

org.springframework.web.client.RestClientException

getDeployTargetUrl

protected String getDeployTargetUrl(String site,
 String environment)

getCreateTargetUrl

protected String getCreateTargetUrl()

Specified by:

getCreateTargetUrl in class AbstractDeployer

getDeleteTargetUrl

protected String getDeleteTargetUrl(String site,
 String environment)

Specified by:

getDeleteTargetUrl in class AbstractDeployer

duplicateTargets

public void duplicateTargets(String sourceSiteId,
 String siteId)
                      throws org.springframework.web.client.RestClientException

Description copied from interface: Deployer

Call Crafter Deployer API to duplicate the site targets

Parameters:

sourceSiteId - the site to duplicate from

siteId - the new site id

Throws:

org.springframework.web.client.RestClientException - if an error occurs while calling Deployer API