org.craftercms.studio.impl.v2.upgrade.pipeline

Class SiteRepositoryUpgradePipelineImpl

java.lang.Object

org.craftercms.studio.impl.v2.upgrade.pipeline.DefaultUpgradePipelineImpl

org.craftercms.studio.impl.v2.upgrade.pipeline.SiteRepositoryUpgradePipelineImpl

All Implemented Interfaces:

UpgradePipeline

public class SiteRepositoryUpgradePipelineImpl
extends DefaultUpgradePipelineImpl

Implementation of UpgradePipeline that handles a git repository to work on a temporary branch for upgrades.

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commitMessage Message for the merge commit after upgrading.
protected org.craftercms.commons.crypto.TextEncryptor	encryptor
protected SecurityService	securityService
protected ServicesConfig	servicesConfig
protected String	siteSandboxBranch The name of the sandbox branch.
protected SiteService	siteService
protected String	siteUpgradeBranch The name of the temporary branch used for upgrades.
protected StudioConfiguration	studioConfiguration
protected UserServiceInternal	userServiceInternal

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.pipeline.DefaultUpgradePipelineImpl

continueOnError, name, operations

Constructor Summary

Constructors

Constructor and Description
SiteRepositoryUpgradePipelineImpl()

Method Summary

Modifier and Type	Method and Description
protected void	checkoutBranch(String branch, org.eclipse.jgit.api.Git git)
protected void	createTemporaryBranch(String site, org.eclipse.jgit.api.Git git)
protected void	deleteTemporaryBranch(org.eclipse.jgit.api.Git git)
void	execute(String site) Executes each UpgradeOperation for the given site.
org.craftercms.commons.crypto.TextEncryptor	getEncryptor()
SecurityService	getSecurityService()
SiteService	getSiteService()
UserServiceInternal	getUserServiceInternal()
protected void	mergeTemporaryBranch(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git)
void	setCommitMessage(String commitMessage)
void	setEncryptor(org.craftercms.commons.crypto.TextEncryptor encryptor)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteSandboxBranch(String siteSandboxBranch)
void	setSiteService(SiteService siteService)
void	setSiteUpgradeBranch(String siteUpgradeBranch)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.pipeline.DefaultUpgradePipelineImpl

isEmpty, setContinueOnError, setName, setOperations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.studio.api.v2.upgrade.UpgradePipeline

execute

Field Detail

siteSandboxBranch

protected String siteSandboxBranch

The name of the sandbox branch.

siteUpgradeBranch

protected String siteUpgradeBranch

The name of the temporary branch used for upgrades.

commitMessage

protected String commitMessage

Message for the merge commit after upgrading.

studioConfiguration

protected StudioConfiguration studioConfiguration

servicesConfig

protected ServicesConfig servicesConfig

securityService

protected SecurityService securityService

userServiceInternal

protected UserServiceInternal userServiceInternal

siteService

protected SiteService siteService

encryptor

protected org.craftercms.commons.crypto.TextEncryptor encryptor

Constructor Detail

SiteRepositoryUpgradePipelineImpl

public SiteRepositoryUpgradePipelineImpl()

Method Detail

createTemporaryBranch

protected void createTemporaryBranch(String site,
                                     org.eclipse.jgit.api.Git git)
                              throws org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

checkoutBranch

protected void checkoutBranch(String branch,
                              org.eclipse.jgit.api.Git git)
                       throws org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

mergeTemporaryBranch

protected void mergeTemporaryBranch(org.eclipse.jgit.lib.Repository repository,
                                    org.eclipse.jgit.api.Git git)
                             throws IOException,
                                    org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

deleteTemporaryBranch

protected void deleteTemporaryBranch(org.eclipse.jgit.api.Git git)
                              throws org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

execute

public void execute(String site)
             throws UpgradeException

Executes each UpgradeOperation for the given site.

Specified by:

execute in interface UpgradePipeline

Overrides:

execute in class DefaultUpgradePipelineImpl

Parameters:

site - the name of the site

Throws:

UpgradeException - if any of the UpgradeOperations fails

setSiteSandboxBranch

public void setSiteSandboxBranch(String siteSandboxBranch)

setSiteUpgradeBranch

public void setSiteUpgradeBranch(String siteUpgradeBranch)

setCommitMessage

public void setCommitMessage(String commitMessage)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

getUserServiceInternal

public UserServiceInternal getUserServiceInternal()

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

getEncryptor

public org.craftercms.commons.crypto.TextEncryptor getEncryptor()

setEncryptor

public void setEncryptor(org.craftercms.commons.crypto.TextEncryptor encryptor)