com.atlassian.bamboo.upgrade

Class AbstractUpgradeManager

java.lang.Object

com.atlassian.bamboo.upgrade.AbstractUpgradeManager

All Implemented Interfaces:

UpgradeManager

Direct Known Subclasses:

BootstrapUpgradeManagerImpl, UpgradeManagerImpl

public abstract class AbstractUpgradeManager
extends Object
implements UpgradeManager

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.config.ApplicationConfiguration	applicationConfig
protected Comparator<String>	buildNumberComparator
protected String	fileName
protected String	newBuildNumber
protected String	oldBuildNumber
protected com.opensymphony.xwork2.TextProvider	textProvider
protected SortedMap<String,UpgradeTask>	upgradeTasks
protected UpgradeUtilityBean	upgradeUtilityBean
protected String	xPathExpression

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUpgradeManager(com.atlassian.config.ApplicationConfiguration applicationConfig, String newBuildNumber, String fileName, String xPathExpression)

Method Summary

Modifier and Type	Method and Description
protected void	classifyUpgradeTask(String bambooBuildNumber, UpgradeTask task)
protected SortedMap<String,UpgradeTask>	createTasks(String xPathExpression, String installationBuildNumber, String upgradeBuildNumber) Creates a mapping of build numbers to upgrade tasks.
UpgradeTask	createUpgradeTask(String className)
protected <E extends Exception> void	forEachTask(String xPathExpression, String installationBuildNumber, String upgradeBuildNumber, BambooClosures.Throwing1<UpgradeTask,E> action) Iterates over upgrade tasks, lazily instantiating them on the fly.
protected String	getDescription(UpgradeTask task, String thisTaskBuildNumber)
String	getOldBuildNumber()
protected org.dom4j.Document	getUpgradeDocument()
SortedMap<String,UpgradeTask>	getUpgradeTasks() Gets a map of upgrade tasks which need to run.
boolean	needUpgrade() Determines whether we need to run the upgrade or not.
protected void	populateRelevantUpgrades(String buildNumberLo, String buildNumberHi)
protected String	runUpgradeTask(UpgradeTask task, List<String> errors)
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
void	setUpgradeUtilityBean(UpgradeUtilityBean upgradeUtilityBean)
protected boolean	shouldRunTask(org.dom4j.Element element, String installationBuildNumber, String upgradeBuildNumber)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.upgrade.UpgradeManager

doUpgrade, getBuildNumber

Field Detail

buildNumberComparator

protected final Comparator<String> buildNumberComparator

oldBuildNumber

protected String oldBuildNumber

newBuildNumber

protected final String newBuildNumber

fileName

protected final String fileName

xPathExpression

protected final String xPathExpression

upgradeTasks

protected final SortedMap<String,UpgradeTask> upgradeTasks

applicationConfig

protected final com.atlassian.config.ApplicationConfiguration applicationConfig

upgradeUtilityBean

protected UpgradeUtilityBean upgradeUtilityBean

textProvider

protected com.opensymphony.xwork2.TextProvider textProvider

Constructor Detail

AbstractUpgradeManager

protected AbstractUpgradeManager(@NotNull
                                 com.atlassian.config.ApplicationConfiguration applicationConfig,
                                 @NotNull
                                 String newBuildNumber,
                                 @NotNull
                                 String fileName,
                                 @NotNull
                                 String xPathExpression)

Method Detail

needUpgrade

public boolean needUpgrade()

Description copied from interface: UpgradeManager

Determines whether we need to run the upgrade or not.

Specified by:

needUpgrade in interface UpgradeManager

Returns:

boolean whether the upgrade is needed

populateRelevantUpgrades

protected void populateRelevantUpgrades(@NotNull
                                        String buildNumberLo,
                                        @NotNull
                                        String buildNumberHi)
                                 throws UpgradeException

Throws:

UpgradeException

classifyUpgradeTask

protected void classifyUpgradeTask(@NotNull
                                   String bambooBuildNumber,
                                   @NotNull
                                   UpgradeTask task)
                            throws UpgradeException

Throws:

UpgradeException

createTasks

protected SortedMap<String,UpgradeTask> createTasks(@NotNull
                                                    String xPathExpression,
                                                    @NotNull
                                                    String installationBuildNumber,
                                                    @NotNull
                                                    String upgradeBuildNumber)
                                             throws UpgradeException

Creates a mapping of build numbers to upgrade tasks.

All matching upgrade tasks are instantiated by this method. This means that if there's a problem with instantiating at least one upgrade task (for example due to broken Spring dependencies), this method will throw.

To lazily iterate over upgrade tasks, use forEachTask(String, String, String, BambooClosures.Throwing1).

Throws:

UpgradeException

forEachTask

protected <E extends Exception> void forEachTask(@NotNull
                                                 String xPathExpression,
                                                 @NotNull
                                                 String installationBuildNumber,
                                                 @NotNull
                                                 String upgradeBuildNumber,
                                                 @NotNull
                                                 BambooClosures.Throwing1<UpgradeTask,E> action)
                                          throws UpgradeException,
                                                 E extends Exception

Iterates over upgrade tasks, lazily instantiating them on the fly.

Provided action will be performed on all previous upgrade tasks before a new task is instantiated. This may be beneficial for validation tasks, to detect problems and report them nicely instead of relying on infrastructure exceptions. (For example, first upgrade task may detect broken DB configuration and fail, and subsequent one, requiring DB connection from Spring beans, won't even be created.)

To eagerly instantiate all upgrade tasks, use createTasks(String, String, String).

Throws:

UpgradeException

E extends Exception

createUpgradeTask

public UpgradeTask createUpgradeTask(String className)
                              throws UpgradeException

Throws:

UpgradeException

getUpgradeDocument

protected org.dom4j.Document getUpgradeDocument()
                                         throws org.dom4j.DocumentException

Throws:

org.dom4j.DocumentException

runUpgradeTask

protected String runUpgradeTask(@NotNull
                                UpgradeTask task,
                                @NotNull
                                List<String> errors)

getDescription

@NotNull
protected String getDescription(@NotNull
                                         UpgradeTask task,
                                         String thisTaskBuildNumber)

shouldRunTask

protected boolean shouldRunTask(@NotNull
                                org.dom4j.Element element,
                                @NotNull
                                String installationBuildNumber,
                                @NotNull
                                String upgradeBuildNumber)

getUpgradeTasks

public SortedMap<String,UpgradeTask> getUpgradeTasks()

Gets a map of upgrade tasks which need to run.

Returns:

SortedMap map of upgrade tasks, keys are the string representations of the build number.

getOldBuildNumber

public String getOldBuildNumber()

Specified by:

getOldBuildNumber in interface UpgradeManager

Returns:

build number before upgrade

setUpgradeUtilityBean

public void setUpgradeUtilityBean(UpgradeUtilityBean upgradeUtilityBean)

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)