Package org.craftercms.commons.upgrade

Interface UpgradePipelineFactory<T>

Type Parameters:

T - The target type supported

All Known Implementing Classes:

DefaultUpgradePipelineFactoryImpl

public interface UpgradePipelineFactory<T>

Builds an UpgradePipeline with all the required operations

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_CURRENT_VERSION
static final String	CONFIG_KEY_NEXT_VERSION
static final String	CONFIG_KEY_OPERATIONS
static final String	CONFIG_KEY_REQUIRES
static final String	CONFIG_KEY_TYPE
static final String	CONFIG_KEY_VERSIONS

Method Summary

Modifier and Type	Method	Description
UpgradePipeline<T>	getPipeline(UpgradeContext<T> context)	Retrieves the needed upgrade operations for the given target

Field Details

CONFIG_KEY_CURRENT_VERSION

static final String CONFIG_KEY_CURRENT_VERSION

See Also:

• Constant Field Values

CONFIG_KEY_NEXT_VERSION

static final String CONFIG_KEY_NEXT_VERSION

See Also:

• Constant Field Values

CONFIG_KEY_OPERATIONS

static final String CONFIG_KEY_OPERATIONS

See Also:

• Constant Field Values

CONFIG_KEY_TYPE

static final String CONFIG_KEY_TYPE

See Also:

• Constant Field Values

CONFIG_KEY_REQUIRES

static final String CONFIG_KEY_REQUIRES

See Also:

• Constant Field Values

CONFIG_KEY_VERSIONS

static final String CONFIG_KEY_VERSIONS

See Also:

• Constant Field Values

Method Details

getPipeline

UpgradePipeline<T> getPipeline(UpgradeContext<T> context)
                        throws UpgradeException,
ConfigurationException

Retrieves the needed upgrade operations for the given target

Parameters:

context - the upgrade context

Returns:

the upgrade pipeline

Throws:

UpgradeException - if there is any error retrieving the operations

ConfigurationException