com.atlassian.sal.api.upgrade
Interface PluginUpgradeTask

public interface PluginUpgradeTask

A task that needs to be executed to upgrade the existing data

Since:

2.0

Method Summary

java.util.Collection<Message>	doUpgrade() Perform the upgrade task.
int	getBuildNumber()
java.lang.String	getPluginKey()
java.lang.String	getShortDescription()

Method Detail

getBuildNumber

int getBuildNumber()

Returns:

The new build number that this upgrade will upgrade to Build number is specified in atlassian-plugin.xml inside element. eg: <param name="build">1</param>

getShortDescription

java.lang.String getShortDescription()

Returns:

A short (<50 chars) description of the upgrade action

doUpgrade

java.util.Collection<Message> doUpgrade()
                                        throws java.lang.Exception

Perform the upgrade task.

Returns:

any errors that occur.

Throws:

java.lang.Exception - if upgrade fails

getPluginKey

java.lang.String getPluginKey()

Returns:

key of the plugin that this upgrade task applies to. Find the key as an attribute of top level element in atlassian-plugin.xml