com.atlassian.sal.core.upgrade

Class DefaultPluginUpgradeManager

java.lang.Object

com.atlassian.sal.core.upgrade.DefaultPluginUpgradeManager

All Implemented Interfaces:

LifecycleAware, PluginUpgradeManager, org.springframework.beans.factory.InitializingBean

public class DefaultPluginUpgradeManager
extends Object
implements PluginUpgradeManager, LifecycleAware, org.springframework.beans.factory.InitializingBean

Processes plugin upgrade operations.

Upgrades are triggered by the start lifecycle event, and plugin enabled.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LOCK_TIMEOUT_PROPERTY
protected static int	LOCK_TIMEOUT_SECONDS

Constructor Summary

Constructors

Constructor and Description
DefaultPluginUpgradeManager(List<PluginUpgradeTask> upgradeTasks, TransactionTemplate transactionTemplate, com.atlassian.plugin.PluginAccessor pluginAccessor, PluginSettingsFactory pluginSettingsFactory, com.atlassian.plugin.event.PluginEventManager pluginEventManager, com.atlassian.beehive.ClusterLockService clusterLockService)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected Map<String,List<PluginUpgradeTask>>	getUpgradeTasks()
void	onBind(PluginUpgradeTask task, Map props) Deprecated. as of 2.0.16 no longer used we now use the eventing framework to run upgrade tasks for plugins that are 'enabled', see onPluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent)
void	onPluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent event)
void	onStart() Notification that the plugin is enabled and the application is started, including after being restored from backup.
void	onStop() Notification that the plugin is going to be stopped.
List<Message>	upgrade() Finds and upgrades all plugins, that implement PluginUpgradeTask
List<Message>	upgradeInternal()
List<Message>	upgradeInternal(com.atlassian.plugin.Plugin plugin)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCK_TIMEOUT_PROPERTY

protected static final String LOCK_TIMEOUT_PROPERTY

See Also:

Constant Field Values

LOCK_TIMEOUT_SECONDS

protected static final int LOCK_TIMEOUT_SECONDS

Constructor Detail

DefaultPluginUpgradeManager

public DefaultPluginUpgradeManager(List<PluginUpgradeTask> upgradeTasks,
                           TransactionTemplate transactionTemplate,
                           com.atlassian.plugin.PluginAccessor pluginAccessor,
                           PluginSettingsFactory pluginSettingsFactory,
                           com.atlassian.plugin.event.PluginEventManager pluginEventManager,
                           com.atlassian.beehive.ClusterLockService clusterLockService)

Method Detail

onBind

@Deprecated
public void onBind(PluginUpgradeTask task,
                     Map props)

Deprecated. as of 2.0.16 no longer used we now use the eventing framework to run upgrade tasks for plugins that are 'enabled', see onPluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent)

Notifies the plugin upgrade manager that a plugin update tasks has been registered.

This method does nothing but logging at the moment. Is is now deprecated since it could result in circular dependency when trying to bind already exposed update tasks to plugin manager that is being created.

Parameters:

task - the upgrade task that is being bound

props - the set of properties that the upgrade task was registered with

onStart

public void onStart()

Description copied from interface: LifecycleAware

Notification that the plugin is enabled and the application is started, including after being restored from backup.

Specified by:

onStart in interface LifecycleAware

onStop

public void onStop()

Description copied from interface: LifecycleAware

Notification that the plugin is going to be stopped.

Will be invoked if previously notified with LifecycleAware.onStart(), before the plugin is disabled or framework is shut down.

Specified by:

onStop in interface LifecycleAware

onPluginEnabled

public void onPluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent event)

getUpgradeTasks

protected Map<String,List<PluginUpgradeTask>> getUpgradeTasks()

Returns:

map of all upgrade tasks (stored by pluginKey)

upgrade

public List<Message> upgrade()

Description copied from interface: PluginUpgradeManager

Finds and upgrades all plugins, that implement PluginUpgradeTask

Specified by:

upgrade in interface PluginUpgradeManager

Returns:

A list of errors

upgradeInternal

public List<Message> upgradeInternal()

upgradeInternal

public List<Message> upgradeInternal(com.atlassian.plugin.Plugin plugin)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception