Package org.ametys.core.migration.version.storage

Class SqlVersionStorage

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.version.storage.SqlVersionStorage

All Implemented Interfaces:

VersionStorage, LogEnabled, PluginAware, Initializable, Serviceable

public class SqlVersionStorage
extends AbstractLogEnabled
implements VersionStorage, Serviceable, PluginAware, Initializable

SQL implementation of VersionStorage, to manage the list of versions in a database

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SqlVersionStorage.SqlVersionConfiguration	A VersionConfiguration with a SQL datasource id

Constructor Summary

Constructors

Constructor	Description
SqlVersionStorage()

Method Summary

Modifier and Type	Method	Description
Version	createVersion(String componentId, MigrationEngine.MigrationComponent component, VersionConfiguration storageConfiguration, Map<String,Object> additionalValues)	Creates a new version object, used to initialize the migration process.
VersionConfiguration	createVersionConfiguration(Configuration versionConfiguration)	Create a specific object containing useful data for the handler/storage
String	getId()	Get the unique identifier
List<Version>	getVersions(String componentId, VersionConfiguration configuration, MigrationEngine.MigrationComponent component)	Get the history of all versions for a component identifier
void	initialize()
void	removeAllVersions(String componentIdentifier, VersionConfiguration versionConfiguration)	Remove all versions for a component identifier
void	removeVersion(String componentId, String versionNumber, VersionConfiguration configuration)	Removes a stored version
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
void	storeVersion(Version version)	Add a version

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

Constructor Details

SqlVersionStorage

public SqlVersionStorage()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getId

public String getId()

Description copied from interface: VersionStorage

Get the unique identifier

Specified by:

getId in interface VersionStorage

Returns:

The identifier

getVersions

public List<Version> getVersions(String componentId,
 VersionConfiguration configuration,
 MigrationEngine.MigrationComponent component)
                          throws MigrationException

Description copied from interface: VersionStorage

Get the history of all versions for a component identifier

Specified by:

getVersions in interface VersionStorage

Parameters:

componentId - the component id

configuration - configuration for this storage

component - the context component

Returns:

list of all versions for this component

Throws:

MigrationException - Something went wrong

createVersion

public Version createVersion(String componentId,
 MigrationEngine.MigrationComponent component,
 VersionConfiguration storageConfiguration,
 Map<String,Object> additionalValues)
                      throws MigrationException

Description copied from interface: VersionStorage

Creates a new version object, used to initialize the migration process. This version is actually NOT stored.
Depending of the context, the created Version could have the "0" number (ie. all actions should be executed), or

null

number (ie. only initialization action should be executed and the actual version number set to the highest available).

Specified by:

createVersion in interface VersionStorage

Parameters:

componentId - the component id

component - the context component

storageConfiguration - configuration for this storage

additionalValues - all specific values used by upgrade actions

Returns:

the newly created Version

Throws:

MigrationException - Impossible to create the version

storeVersion

public void storeVersion(Version version)
                  throws MigrationException

Description copied from interface: VersionStorage

Add a version

Specified by:

storeVersion in interface VersionStorage

Parameters:

version - Version to store (contains the component identifier)

Throws:

MigrationException - Something went wrong

removeVersion

public void removeVersion(String componentId,
 String versionNumber,
 VersionConfiguration configuration)
                   throws MigrationException

Description copied from interface: VersionStorage

Removes a stored version

Specified by:

removeVersion in interface VersionStorage

Parameters:

componentId - the component

versionNumber - the version to remove

configuration - the associated configuration

Throws:

MigrationException - Something went wrong

removeAllVersions

public void removeAllVersions(String componentIdentifier,
 VersionConfiguration versionConfiguration)
                       throws MigrationException

Description copied from interface: VersionStorage

Remove all versions for a component identifier

Specified by:

removeAllVersions in interface VersionStorage

Parameters:

componentIdentifier - component to clear

versionConfiguration - configuration to use

Throws:

MigrationException - Something went wrong

createVersionConfiguration

public VersionConfiguration createVersionConfiguration(Configuration versionConfiguration)
                                                throws ConfigurationException,
NotMigrableInSafeModeException

Description copied from interface: VersionStorage

Create a specific object containing useful data for the handler/storage

Specified by:

createVersionConfiguration in interface VersionStorage

Parameters:

versionConfiguration - configuration from the plugin.xml

Returns:

the confuguration object

Throws:

ConfigurationException - something wrong in the configuration

NotMigrableInSafeModeException - it it's impossible to configure the versions in safe mode