com.atlassian.upgrade.spi

Interface UpgradeTaskFactory

All Known Subinterfaces:

LegacyUpgradeTaskFactory

@PublicSpi
public interface UpgradeTaskFactory

SPI for a plugin or the host application to implement in order to be able to participate in upgrades.

Since:

v1.0

Method Summary

Modifier and Type	Method and Description
Collection<UpgradeTask>	getAllUpgradeTasks() Get all of the upgrade tasks for this given plugin/host app.
int	getMinimumBuildNumber() Get the minimum build number for a plugins data that can be upgraded from.
String	getProductDisplayName() Returns the display name for this plugin / host app.
String	getProductMinimumVersion() Returns the minimum upgradeable version for this plugin / host app.

Method Detail

getProductDisplayName

String getProductDisplayName()

Returns the display name for this plugin / host app.

e.g "JIRA Portfolio"

This will be used to construct the user facing error message if the minimum build number check fails.

Returns:

The product's display name, i.e. the marketing name of the product to help user find a way to upgrade to the minimal product version

See Also:

getProductMinimumVersion()

getProductMinimumVersion

String getProductMinimumVersion()

Returns the minimum upgradeable version for this plugin / host app.

e.g "7.0.0"

This will be used to construct the user facing error message if the minimum build number check fails.

Returns:

The product's display name, i.e. the marketing name of the product to help user find a way to upgrade to the minimal product version

See Also:

getProductMinimumVersion()

getMinimumBuildNumber

int getMinimumBuildNumber()

Get the minimum build number for a plugins data that can be upgraded from. There should be no upgrade tasks with build numbers below this number.

For example, if the plugin data is at version 2 but the minimum build number is 4, it cannot be run. However, if the plugin data is at version 6 than the upgrade can be completed.

Returns:

the minimum build number for this UpgradeTaskFactory

getAllUpgradeTasks

@Nonnull
Collection<UpgradeTask> getAllUpgradeTasks()

Get all of the upgrade tasks for this given plugin/host app. Each upgrade task should have a unique build number and when executing the upgrade tasks they will be run in the numerical ordering. If the build numbers are not unique there is no guarantee of the ordering.

Returns:

upgrade tasks for this plugin/host app.