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 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)
UpgradeTask	createUpgradeTask(String className)
String	getBuildNumber() This gets the pre-build number
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)
protected void	setBuildNumber(String buildNumber)
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

Field Detail

buildNumberComparator

protected final Comparator<String> buildNumberComparator

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 build was successful or not

getBuildNumber

@NotNull
public String getBuildNumber()

Description copied from interface: UpgradeManager

This gets the pre-build number

Specified by:

getBuildNumber in interface UpgradeManager

Returns:

the current build number (in application config file)

setBuildNumber

protected void setBuildNumber(@NotNull
                              String buildNumber)
                       throws com.atlassian.config.ConfigurationException

Throws:

com.atlassian.config.ConfigurationException

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

Throws:

UpgradeException

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)

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.

setUpgradeUtilityBean

public void setUpgradeUtilityBean(UpgradeUtilityBean upgradeUtilityBean)

setTextProvider

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