Package org.craftercms.commons.upgrade.impl

Class AbstractUpgradeManager<T>

java.lang.Object

org.craftercms.commons.upgrade.impl.AbstractUpgradeManager<T>

Type Parameters:

T - The target type supported

All Implemented Interfaces:

UpgradeManager<T>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public abstract class AbstractUpgradeManager<T>
extends Object
implements UpgradeManager<T>, org.springframework.context.ApplicationContextAware

Base class for all UpgradeManager implementations

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected boolean	continueOnFailure	Indicates if errors during a target upgrade should stop the process
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
AbstractUpgradeManager()

Method Summary

Modifier and Type	Method	Description
protected abstract UpgradeContext<T>	createUpgradeContext(T target)
protected abstract List<T>	doGetTargets()
protected abstract void	doUpgrade(UpgradeContext<T> context)
protected void	executePipeline(UpgradeContext<T> context, UpgradePipelineFactory<T> pipelineFactory)
List<T>	getTargets()	Returns all targets to be upgraded
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContinueOnFailure(boolean continueOnFailure)
void	upgrade()	Executes all required upgrades for the system
void	upgrade(T target)	Executes all required upgrades for the given target

Methods inherited from class java.lang.Object

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

Field Details

logger

protected org.slf4j.Logger logger

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

continueOnFailure

protected boolean continueOnFailure

Indicates if errors during a target upgrade should stop the process

Constructor Details

AbstractUpgradeManager

public AbstractUpgradeManager()

Method Details

setContinueOnFailure

public void setContinueOnFailure(boolean continueOnFailure)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

upgrade

public void upgrade(T target)
             throws UpgradeException

Description copied from interface: UpgradeManager

Executes all required upgrades for the given target

Specified by:

upgrade in interface UpgradeManager<T>

Parameters:

target - the target

Throws:

UpgradeException - if any of the upgrades fails

upgrade

public void upgrade()
             throws UpgradeException

Description copied from interface: UpgradeManager

Executes all required upgrades for the system

Specified by:

upgrade in interface UpgradeManager<T>

Throws:

UpgradeException - if any of the upgrades fails

getTargets

public List<T> getTargets()
                   throws UpgradeException

Description copied from interface: UpgradeManager

Returns all targets to be upgraded

Specified by:

getTargets in interface UpgradeManager<T>

Returns:

the list of targets

Throws:

UpgradeException - if there is any error finding the targets

doGetTargets

protected abstract List<T> doGetTargets()
                                 throws Exception

Throws:

Exception

createUpgradeContext

protected abstract UpgradeContext<T> createUpgradeContext(T target)

doUpgrade

protected abstract void doUpgrade(UpgradeContext<T> context)
                           throws Exception

Throws:

Exception

executePipeline

protected void executePipeline(UpgradeContext<T> context,
 UpgradePipelineFactory<T> pipelineFactory)
                        throws ConfigurationException,
UpgradeException

Throws:

ConfigurationException

UpgradeException