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

Class SiteRepositoryUpgradePipelineImpl

java.lang.Object

org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl<String>

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

All Implemented Interfaces:

org.craftercms.commons.upgrade.UpgradePipeline<String>

public class SiteRepositoryUpgradePipelineImpl
extends org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl<String>

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	Description
protected StudioClusterPrimaryReplicaSandboxRepoSyncTask	clusterPrimaryReplicaSandboxRepoSyncTask
protected String	commitMessage	Message for the merge commit after upgrading.
protected GeneralLockService	generalLockService
protected GitRepositoryHelper	gitRepositoryHelper
protected RetryingRepositoryOperationFacade	retryingRepositoryOperationFacade
protected String	siteSandboxBranch	The name of the sandbox branch.
protected SiteService	siteService
protected String	siteUpgradeBranch	The name of the temporary branch used for upgrades.

Fields inherited from class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl

continueOnFailure, name, operations

Constructor Summary

Constructors

Constructor	Description
SiteRepositoryUpgradePipelineImpl(String name, List<org.craftercms.commons.upgrade.UpgradeOperation<String>> upgradeOperations)

Method Summary

Modifier and Type	Method	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(org.craftercms.commons.upgrade.impl.UpgradeContext<String> context)
StudioClusterPrimaryReplicaSandboxRepoSyncTask	getClusterPrimaryReplicaSandboxRepoSyncTask()
GeneralLockService	getGeneralLockService()
GitRepositoryHelper	getGitRepositoryHelper()
RetryingRepositoryOperationFacade	getRetryingRepositoryOperationFacade()
protected void	mergeTemporaryBranch(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git)
void	setClusterPrimaryReplicaSandboxRepoSyncTask(StudioClusterPrimaryReplicaSandboxRepoSyncTask clusterPrimaryReplicaSandboxRepoSyncTask)
void	setCommitMessage(String commitMessage)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setGitRepositoryHelper(GitRepositoryHelper gitRepositoryHelper)
void	setRetryingRepositoryOperationFacade(RetryingRepositoryOperationFacade retryingRepositoryOperationFacade)
void	setSiteSandboxBranch(String siteSandboxBranch)
void	setSiteService(SiteService siteService)
void	setSiteUpgradeBranch(String siteUpgradeBranch)

Methods inherited from class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl

isEmpty, setContinueOnFailure

Methods inherited from class java.lang.Object

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

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.

siteService

protected SiteService siteService

generalLockService

protected GeneralLockService generalLockService

clusterPrimaryReplicaSandboxRepoSyncTask

protected StudioClusterPrimaryReplicaSandboxRepoSyncTask clusterPrimaryReplicaSandboxRepoSyncTask

gitRepositoryHelper

protected GitRepositoryHelper gitRepositoryHelper

retryingRepositoryOperationFacade

protected RetryingRepositoryOperationFacade retryingRepositoryOperationFacade

Constructor Detail

SiteRepositoryUpgradePipelineImpl

public SiteRepositoryUpgradePipelineImpl(String name,
                                         List<org.craftercms.commons.upgrade.UpgradeOperation<String>> upgradeOperations)

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(org.craftercms.commons.upgrade.impl.UpgradeContext<String> context)
             throws org.craftercms.commons.upgrade.exception.UpgradeException

Specified by:

execute in interface org.craftercms.commons.upgrade.UpgradePipeline<String>

Overrides:

execute in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl<String>

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException

setSiteSandboxBranch

public void setSiteSandboxBranch(String siteSandboxBranch)

setSiteUpgradeBranch

public void setSiteUpgradeBranch(String siteUpgradeBranch)

setCommitMessage

public void setCommitMessage(String commitMessage)

setSiteService

public void setSiteService(SiteService siteService)

getGeneralLockService

public GeneralLockService getGeneralLockService()

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

getClusterPrimaryReplicaSandboxRepoSyncTask

public StudioClusterPrimaryReplicaSandboxRepoSyncTask getClusterPrimaryReplicaSandboxRepoSyncTask()

setClusterPrimaryReplicaSandboxRepoSyncTask

public void setClusterPrimaryReplicaSandboxRepoSyncTask(StudioClusterPrimaryReplicaSandboxRepoSyncTask clusterPrimaryReplicaSandboxRepoSyncTask)

getGitRepositoryHelper

public GitRepositoryHelper getGitRepositoryHelper()

setGitRepositoryHelper

public void setGitRepositoryHelper(GitRepositoryHelper gitRepositoryHelper)

getRetryingRepositoryOperationFacade

public RetryingRepositoryOperationFacade getRetryingRepositoryOperationFacade()

setRetryingRepositoryOperationFacade

public void setRetryingRepositoryOperationFacade(RetryingRepositoryOperationFacade retryingRepositoryOperationFacade)