Package org.craftercms.studio.api.v2.upgrade

Interface StudioUpgradeManager

All Superinterfaces:

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

All Known Implementing Classes:

StudioUpgradeManagerImpl

public interface StudioUpgradeManager
extends org.craftercms.commons.upgrade.UpgradeManager<String>

Extension of UpgradeManager that adds Studio specific operations.

Since:

3.1.0

Author:

joseross

Method Summary

Modifier and Type	Method	Description
List<String>	getExistingEnvironments(String site)	Returns all existing environments for the given site
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	upgradeSiteConfiguration(StudioUpgradeContext context)	Executes the upgrades for all managed configurations in the given site.

Methods inherited from interface org.craftercms.commons.upgrade.UpgradeManager

getTargets, upgrade, upgrade

Method Detail

upgradeDatabaseAndConfiguration

void upgradeDatabaseAndConfiguration()
                              throws org.craftercms.commons.upgrade.exception.UpgradeException,
                                     org.craftercms.commons.config.ConfigurationException

Executes all required upgrades for the system.

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException - if any of the upgrades fails

org.craftercms.commons.config.ConfigurationException

upgradeSiteConfiguration

void upgradeSiteConfiguration(StudioUpgradeContext context)
                       throws org.craftercms.commons.upgrade.exception.UpgradeException

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

Parameters:

context - the context for the upgrades

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException - if any of the upgrades fails

upgradeExistingSites

void upgradeExistingSites()
                   throws org.craftercms.commons.upgrade.exception.UpgradeException

Executes the upgrades for all existing sites.

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException - if any of the upgrades fails

upgradeBlueprints

void upgradeBlueprints()
                throws org.craftercms.commons.upgrade.exception.UpgradeException,
                       org.craftercms.commons.config.ConfigurationException

Executes all required upgrades for the blueprints.

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException - if any of the upgrades fails

org.craftercms.commons.config.ConfigurationException

getExistingEnvironments

List<String> getExistingEnvironments(String site)

Returns all existing environments for the given site

Parameters:

site - the id of the site

Returns:

the list of environments