Package org.ametys.core.migration

Class MigrationEngine

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.MigrationEngine

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class MigrationEngine
extends AbstractLogEnabled
implements Contextualizable, Serviceable, Component

Main entry point for all automatic migration related tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MigrationEngine.ActionData	All data needed to actually execute an upgrade action: the current version and the action configuration.
static final record	MigrationEngine.MigrationComponent	A migration component represents a versioned feature set
static final record	MigrationEngine.VersionList	The leaf of the MigrationEngine.Versions tree.
static interface	MigrationEngine.Versions	A version tree, grouped recursively by sub-components.
static final class	MigrationEngine.VersionsContainer	Contains a list of versions for a sub-component

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
MigrationEngine()

Method Summary

Modifier and Type	Method	Description
protected void	_checkFromUpgrades(List<ActionConfiguration> actions, List<Pair<String,String>> fromTo)	Tests that in the list of fromTo, that each "fromTo" is linked to an action with the same id and without "from"
void	contextualize(Context context)
boolean	doAction(MigrationEngine.ActionData actionData, ActionExtensionPoint extensionPoint)	Executes a migration action.
MigrationEngine.ActionData	getFailedAction()	If the upgrade process has failed, returns the corresponding ActionConfiguration. Returns null if the process went well.
MigrationException	getFailedException()	If the upgrade process has failed, returns the corresponding MigrationException. Returns null if the process went well.
String	getHighestUpgradeVersionNumber(MigrationEngine.MigrationComponent component)	Returns the highest version number among all components' upgrades
Version	getLatestVersion(List<Version> versions)	Returns the latest version (according to version numbers) among the given list of versions
List<ActionConfiguration>	getUpgrades(Version currentVersion, List<ActionConfiguration> availableUpgrades)	Return all upgrades to execute for the current version
MigrationEngine.VersionList	getVersionList(MigrationEngine.Versions versions, String id)	Search a given version list among all thos returned by a VersionHandler
MigrationEngine.Versions	getVersions(MigrationEngine.MigrationComponent component)	Retrives all stored versions for the given component
boolean	initializeVersion(MigrationEngine.ActionData action)	Execute all needed initializations
boolean	migrate()	All migrations are parsed and executed one per one in the right order
void	service(ServiceManager smanager)
boolean	upgradeVersion(MigrationEngine.ActionData action)	Execute an upgrade

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

Constructor Details

MigrationEngine

public MigrationEngine()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

migrate

public boolean migrate()

All migrations are parsed and executed one per one in the right order

Returns:

true if the migration requires a server restart ; false otherwise

getUpgrades

public List<ActionConfiguration> getUpgrades(Version currentVersion,
 List<ActionConfiguration> availableUpgrades)
                                      throws MigrationException

Return all upgrades to execute for the current version

Parameters:

currentVersion - the current version

availableUpgrades - all available upgrades

Returns:

all upgrade to execute

Throws:

MigrationException - if the upgrades are not compatible

getVersions

public MigrationEngine.Versions getVersions(MigrationEngine.MigrationComponent component)
                                     throws MigrationException

Retrives all stored versions for the given component

Parameters:

component - the component to check

Returns:

all stored versions.

Throws:

MigrationException - if something wrong occured

getVersionList

public MigrationEngine.VersionList getVersionList(MigrationEngine.Versions versions,
 String id)

Search a given version list among all thos returned by a VersionHandler

Parameters:

versions - the version tree

id - the wanted id

Returns:

the corresponding MigrationEngine.VersionList

getLatestVersion

public Version getLatestVersion(List<Version> versions)

Returns the latest version (according to version numbers) among the given list of versions

Parameters:

versions - a list of Version

Returns:

the latest version, or null if the list is empty

initializeVersion

public boolean initializeVersion(MigrationEngine.ActionData action)
                          throws MigrationException

Execute all needed initializations

Parameters:

action - the version and action configuration to initialize

Returns:

true if an action requires a restart

Throws:

MigrationException - Something went wrong

upgradeVersion

public boolean upgradeVersion(MigrationEngine.ActionData action)
                       throws MigrationException

Execute an upgrade

Parameters:

action - the version and action configuration to upgrade

Returns:

true if an action requires a restart

Throws:

MigrationException - Something went wrong

doAction

public boolean doAction(MigrationEngine.ActionData actionData,
 ActionExtensionPoint extensionPoint)
                 throws MigrationException

Executes a migration action.

Parameters:

actionData - the version and action configuration to execute

extensionPoint - the related ActionExtensionPoint

Returns:

true if the action needs a restart after its execution

Throws:

MigrationException - Something went wrong

getHighestUpgradeVersionNumber

public String getHighestUpgradeVersionNumber(MigrationEngine.MigrationComponent component)

Returns the highest version number among all components' upgrades

Parameters:

component - the MigrationEngine.MigrationComponent to consider

Returns:

the highest upgrade version number

_checkFromUpgrades

protected void _checkFromUpgrades(List<ActionConfiguration> actions,
 List<Pair<String,String>> fromTo)
                           throws MigrationException

Tests that in the list of fromTo, that each "fromTo" is linked to an action with the same id and without "from"

Parameters:

actions - list of actions

fromTo - list of actions overriding multiple actions

Throws:

MigrationException - there is an overriding version without a "simple" version with the same id

getFailedAction

public MigrationEngine.ActionData getFailedAction()

If the upgrade process has failed, returns the corresponding ActionConfiguration.
Returns null if the process went well.

Returns:

the failed action data

getFailedException

public MigrationException getFailedException()

If the upgrade process has failed, returns the corresponding MigrationException.
Returns null if the process went well.

Returns:

the exception causing the upgrade failure