org.craftercms.studio.api.v2.upgrade

Interface UpgradeOperation

All Known Implementing Classes:

AbstractContentTypeUpgradeOperation, AbstractContentUpgradeOperation, AbstractPluginDescriptorUpgradeOperation, AbstractUpgradeOperation, AbstractXsltFileUpgradeOperation, AddFileUpgradeOperation, AddSiteUuidOperation, BatchXsltFileUpgradeOperation, BlueprintsUpgradeOperation, BoxRemoteAssetUpgradeOperation, ConfigEncryptionUpgradeOperation, DbEncryptionUpgradeOperation, DbScriptUpgradeOperation, DbVersionUpgradeOperation, DeleteUpgradeOperation, DescriptorV2UpgradeOperation, FindAndReplaceUpgradeOperation, GlobalRepoUpgradeOperation, RenameUpgradeOperation, SiteVersionUpgradeOperation, TemplateRenameUpgradeOperation, XsltFileUpgradeOperation

public interface UpgradeOperation

Defines the basic operations for a single upgrade.

Author:

joseross

Method Summary

Modifier and Type	Method and Description
void	execute(String site) Performs a single upgrade operation.
void	init(String sourceVersion, String targetVersion, org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config) Initializes the instance with the given configuration.

Method Detail

init

void init(String sourceVersion,
          String targetVersion,
          org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
   throws UpgradeException

Initializes the instance with the given configuration.

Parameters:

sourceVersion - the starting version

targetVersion - the target version

config - operation configuration

Throws:

UpgradeException

execute

void execute(String site)
      throws UpgradeException

Performs a single upgrade operation.

Parameters:

site - the name of the site

Throws:

UpgradeException - if there is any error performing the upgrade