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

Interface VersionStorage

All Known Implementing Classes:

JcrVersionStorage, SqlVersionStorage

public interface VersionStorage

Store the versions of a migration component and acts as a factory to create specific configuration objects.

Method Summary

Modifier and Type	Method	Description
default 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 storageConfiguration, MigrationEngine.MigrationComponent component)	Get the history of all versions for a component identifier
void	removeAllVersions(String componentIdentifier, VersionConfiguration configuration)	Remove all versions for a component identifier
void	removeVersion(String componentId, String versionNumber, VersionConfiguration configuration)	Removes a stored version
void	storeVersion(Version version)	Add a version

Method Details

getId

String getId()

Get the unique identifier

Returns:

The identifier

getVersions

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

Get the history of all versions for a component identifier

Parameters:

componentId - the component id

component - the context component

storageConfiguration - configuration for this storage

Returns:

list of all versions for this component

Throws:

MigrationException - Something went wrong

storeVersion

void storeVersion(Version version)
           throws MigrationException

Add a version

Parameters:

version - Version to store (contains the component identifier)

Throws:

MigrationException - Something went wrong

removeVersion

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

Removes a stored version

Parameters:

componentId - the component

versionNumber - the version to remove

configuration - the associated configuration

Throws:

MigrationException - Something went wrong

removeAllVersions

void removeAllVersions(String componentIdentifier,
 VersionConfiguration configuration)
                throws MigrationException

Remove all versions for a component identifier

Parameters:

componentIdentifier - component to clear

configuration - configuration to use

Throws:

MigrationException - Something went wrong

createVersionConfiguration

VersionConfiguration createVersionConfiguration(Configuration versionConfiguration)
                                         throws ConfigurationException,
NotMigrableInSafeModeException

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

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

createVersion

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

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).

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