org.exoplatform.commons.upgrade

Class UpgradeProductPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.upgrade.UpgradeProductPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public abstract class UpgradeProductPlugin
extends org.exoplatform.container.component.BaseComponentPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected String	oldProductGroupId
protected String	productGroupId The plugin's product maven group identifier, by example: org.exoplatform.portal for gatein.
static String	UPGRADE_COMPLETED_STATUS

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
UpgradeProductPlugin(org.exoplatform.container.xml.InitParams initParams)
UpgradeProductPlugin(org.exoplatform.commons.api.settings.SettingService settingService, org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method and Description
void	addNodeVersion(javax.jcr.Node nodeToAddVersion, String versionLabel) Add node's version with a label.
boolean	equals(Object obj)
String	getOldProductGroupId() Gets old version what needs to upgrade
int	getPluginExecutionOrder()
String	getProductGroupId()
String	getValue(String paramName)
int	hashCode()
boolean	isEnabled() Determines if the plugin is enabled, this method will be called when adding the plugin to the upgradePlugins list.
abstract void	processUpgrade(String oldVersion, String newVersion) Proceed to the transparent upgrade, this method will be called if the Product version has changed, which means, it will be called once the Product Version stored in the JCR and the one declared in ProductInfo are different
abstract boolean	shouldProceedToUpgrade(String newVersion, String previousVersion) This method is called when a new version has been detected to decide whether proceed to upgrade or not.
void	storeValueForPlugin(String paramName, String paramValue)

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

UPGRADE_COMPLETED_STATUS

public static final String UPGRADE_COMPLETED_STATUS

See Also:

Constant Field Values

productGroupId

protected String productGroupId

The plugin's product maven group identifier, by example: org.exoplatform.portal for gatein.

oldProductGroupId

protected String oldProductGroupId

Constructor Detail

UpgradeProductPlugin

public UpgradeProductPlugin(org.exoplatform.commons.api.settings.SettingService settingService,
                            org.exoplatform.container.xml.InitParams initParams)

UpgradeProductPlugin

public UpgradeProductPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Detail

getProductGroupId

public String getProductGroupId()

getOldProductGroupId

public String getOldProductGroupId()

Gets old version what needs to upgrade

Returns:

isEnabled

public boolean isEnabled()

Determines if the plugin is enabled, this method will be called when adding the plugin to the upgradePlugins list. See UpgradeProductService.addUpgradePlugin(UpgradeProductPlugin)

Returns:

true: if the plugin is enabled: should be added to the upgradePlugins list false: if the plugin is disabled: should not be added to the upgradePlugins list

addNodeVersion

public void addNodeVersion(javax.jcr.Node nodeToAddVersion,
                           String versionLabel)
                    throws javax.jcr.nodetype.NoSuchNodeTypeException,
                           javax.jcr.version.VersionException,
                           javax.jcr.nodetype.ConstraintViolationException,
                           javax.jcr.lock.LockException,
                           javax.jcr.AccessDeniedException,
                           javax.jcr.ItemExistsException,
                           javax.jcr.InvalidItemStateException,
                           javax.jcr.ReferentialIntegrityException,
                           javax.jcr.RepositoryException

Add node's version with a label. The node's session have to still open, and this method don't handle the node's session closure.

Parameters:

nodeToAddVersion - the node that will be versioned

versionLabel - the label to apply to the new created version

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.version.VersionException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.lock.LockException

javax.jcr.AccessDeniedException

javax.jcr.ItemExistsException

javax.jcr.InvalidItemStateException

javax.jcr.ReferentialIntegrityException

javax.jcr.RepositoryException

processUpgrade

public abstract void processUpgrade(String oldVersion,
                                    String newVersion)

Proceed to the transparent upgrade, this method will be called if the Product version has changed, which means, it will be called once the Product Version stored in the JCR and the one declared in ProductInfo are different

Parameters:

oldVersion - the old version that is stored in the JCR

newVersion - the new version read from ProductInfo Service

shouldProceedToUpgrade

public abstract boolean shouldProceedToUpgrade(String newVersion,
                                               String previousVersion)

This method is called when a new version has been detected to decide whether proceed to upgrade or not. It should take care that some versions could be skipped while upgrading, i.e: the upgrade could happen when the product is switched from version 1.0 to 1.3.

Parameters:

previousVersion - The previous version of plugin's product

newVersion - The previous version of plugin's product

Returns:

true: if the plugin should be executed when switching product from previousVersion to newVersion true: if the upgrade isn't necessary

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getPluginExecutionOrder

public int getPluginExecutionOrder()

getValue

public String getValue(String paramName)

storeValueForPlugin

public void storeValueForPlugin(String paramName,
                                String paramValue)