org.craftercms.studio.impl.v2.upgrade

Class DefaultUpgradeManagerImpl

java.lang.Object

org.craftercms.studio.impl.v2.upgrade.DefaultUpgradeManagerImpl

All Implemented Interfaces:

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

public class DefaultUpgradeManagerImpl
extends Object
implements UpgradeManager, org.springframework.context.ApplicationContextAware

Default implementation for UpgradeManager.

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	appContext
protected UpgradePipelineFactory	bpPipelineFactory
static String	CONFIG_PIPELINE_SUFFIX
protected org.springframework.core.io.Resource	configurationFile
protected ContentRepository	contentRepository
protected DataSource	dataSource
protected UpgradePipelineFactory	dbPipelineFactory
protected VersionProvider	dbVersionProvider
protected org.craftercms.commons.entitlements.validator.DbIntegrityValidator	integrityValidator
protected String	siteVersionFilePath The git path of the version file.
static String	SQL_QUERY_SITES
static String	SQL_QUERY_SITES_3_0_0
protected StudioConfiguration	studioConfiguration

Constructor Summary

Constructors

Constructor and Description
DefaultUpgradeManagerImpl()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkIfSiteRepoExists(String site)
static String	getCurrentFile()
List<String>	getExistingEnvironments(String site) Returns all existing environments for the given site
protected UpgradePipeline	getPipeline(VersionProvider versionProvider, String factoryName, Object... args)
protected VersionProvider	getVersionProvider(String name, Object... args)
void	init() Obtains the current version and starts the upgrade process.
protected org.apache.commons.configuration2.HierarchicalConfiguration	loadUpgradeConfiguration()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBpPipelineFactory(UpgradePipelineFactory bpPipelineFactory)
void	setConfigurationFile(org.springframework.core.io.Resource configurationFile)
void	setContentRepository(ContentRepository contentRepository)
void	setDataSource(DataSource dataSource)
void	setDbPipelineFactory(UpgradePipelineFactory dbPipelineFactory)
void	setDbVersionProvider(VersionProvider dbVersionProvider)
void	setIntegrityValidator(org.craftercms.commons.entitlements.validator.DbIntegrityValidator integrityValidator)
void	setSiteVersionFilePath(String siteVersionFilePath)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	upgradeBlueprints() Executes all required upgrades for the blueprints.
void	upgradeDatabaseAndConfiguration() Executes all required upgrades for the system.
void	upgradeExistingSites() Executes the upgrades for all existing sites.
void	upgradeSite(String site) Executes all required upgrades for the given site.
void	upgradeSiteConfiguration(String site) Executes the upgrades for all managed configurations in the given site.

Methods inherited from class java.lang.Object

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

Field Detail

SQL_QUERY_SITES_3_0_0

public static final String SQL_QUERY_SITES_3_0_0

See Also:

Constant Field Values

SQL_QUERY_SITES

public static final String SQL_QUERY_SITES

See Also:

Constant Field Values

CONFIG_PIPELINE_SUFFIX

public static final String CONFIG_PIPELINE_SUFFIX

See Also:

Constant Field Values

siteVersionFilePath

protected String siteVersionFilePath

The git path of the version file.

dbVersionProvider

protected VersionProvider dbVersionProvider

dbPipelineFactory

protected UpgradePipelineFactory dbPipelineFactory

bpPipelineFactory

protected UpgradePipelineFactory bpPipelineFactory

configurationFile

protected org.springframework.core.io.Resource configurationFile

dataSource

protected DataSource dataSource

appContext

protected org.springframework.context.ApplicationContext appContext

integrityValidator

protected org.craftercms.commons.entitlements.validator.DbIntegrityValidator integrityValidator

contentRepository

protected ContentRepository contentRepository

studioConfiguration

protected StudioConfiguration studioConfiguration

Constructor Detail

DefaultUpgradeManagerImpl

public DefaultUpgradeManagerImpl()

Method Detail

getCurrentFile

public static String getCurrentFile()

upgradeDatabaseAndConfiguration

public void upgradeDatabaseAndConfiguration()
                                     throws UpgradeException

Executes all required upgrades for the system.

Specified by:

upgradeDatabaseAndConfiguration in interface UpgradeManager

Throws:

UpgradeException - if any of the upgrades fails

getVersionProvider

protected VersionProvider getVersionProvider(String name,
                                             Object... args)

getPipeline

protected UpgradePipeline getPipeline(VersionProvider versionProvider,
                                      String factoryName,
                                      Object... args)
                               throws UpgradeException

Throws:

UpgradeException

upgradeSite

public void upgradeSite(String site)

Executes all required upgrades for the given site.

Specified by:

upgradeSite in interface UpgradeManager

Parameters:

site - name of the site

upgradeSiteConfiguration

public void upgradeSiteConfiguration(String site)
                              throws UpgradeException

Executes the upgrades for all managed configurations in the given site.

Specified by:

upgradeSiteConfiguration in interface UpgradeManager

Parameters:

site - name of the site

Throws:

UpgradeException - if any of the upgrades fails

upgradeExistingSites

public void upgradeExistingSites()
                          throws UpgradeException

Executes the upgrades for all existing sites.

Specified by:

upgradeExistingSites in interface UpgradeManager

Throws:

UpgradeException - if any of the upgrades fails

checkIfSiteRepoExists

protected boolean checkIfSiteRepoExists(String site)

upgradeBlueprints

public void upgradeBlueprints()
                       throws UpgradeException

Executes all required upgrades for the blueprints.

Specified by:

upgradeBlueprints in interface UpgradeManager

Throws:

UpgradeException - if any of the upgrades fails

getExistingEnvironments

public List<String> getExistingEnvironments(String site)

Returns all existing environments for the given site

Specified by:

getExistingEnvironments in interface UpgradeManager

Parameters:

site - the id of the site

Returns:

the list of environments

init

public void init()
          throws UpgradeException,
                 org.craftercms.commons.entitlements.exception.EntitlementException

Obtains the current version and starts the upgrade process.

Throws:

UpgradeException - if there is any error in the upgrade process

org.craftercms.commons.entitlements.exception.EntitlementException - if there is any validation error after the upgrade process

loadUpgradeConfiguration

protected org.apache.commons.configuration2.HierarchicalConfiguration loadUpgradeConfiguration()
                                                                                        throws UpgradeException

Throws:

UpgradeException

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setDataSource

public void setDataSource(DataSource dataSource)

setIntegrityValidator

public void setIntegrityValidator(org.craftercms.commons.entitlements.validator.DbIntegrityValidator integrityValidator)

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setDbPipelineFactory

public void setDbPipelineFactory(UpgradePipelineFactory dbPipelineFactory)

setDbVersionProvider

public void setDbVersionProvider(VersionProvider dbVersionProvider)

setConfigurationFile

public void setConfigurationFile(org.springframework.core.io.Resource configurationFile)

setSiteVersionFilePath

public void setSiteVersionFilePath(String siteVersionFilePath)

setBpPipelineFactory

public void setBpPipelineFactory(UpgradePipelineFactory bpPipelineFactory)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)